ContentHandler.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: ContentHandler.hpp,v $
00059  * Revision 1.3  2003/03/07 18:10:30  tng
00060  * Return a reference instead of void for operator=
00061  *
00062  * Revision 1.2  2002/11/04 14:55:45  tng
00063  * C++ Namespace Support.
00064  *
00065  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
00066  * sane_include
00067  *
00068  * Revision 1.4  2000/12/14 18:50:05  tng
00069  * Fix API document generation warning: "Warning: end of member group without matching begin"
00070  *
00071  * Revision 1.3  2000/08/09 22:19:29  jpolast
00072  * many conformance & stability changes:
00073  *   - ContentHandler::resetDocument() removed
00074  *   - attrs param of ContentHandler::startDocument() made const
00075  *   - SAXExceptions thrown now have msgs
00076  *   - removed duplicate function signatures that had 'const'
00077  *       [ eg: getContentHander() ]
00078  *   - changed getFeature and getProperty to apply to const objs
00079  *   - setProperty now takes a void* instead of const void*
00080  *   - SAX2XMLReaderImpl does not inherit from SAXParser anymore
00081  *   - Reuse Validator (http://apache.org/xml/features/reuse-validator) implemented
00082  *   - Features & Properties now read-only during parse
00083  *
00084  * Revision 1.2  2000/08/07 18:21:27  jpolast
00085  * change  module to 
00086  *
00087  * Revision 1.1  2000/08/02 18:02:34  jpolast
00088  * initial checkin of sax2 implementation
00089  * submitted by Simon Fell (simon@fell.com)
00090  * and Joe Polastre (jpolast@apache.org)
00091  *
00092  *
00093  */
00094 
00095 
00096 #ifndef CONTENTHANDLER_HPP
00097 #define CONTENTHANDLER_HPP
00098 
00099 #include <xercesc/util/XercesDefs.hpp>
00100 
00101 XERCES_CPP_NAMESPACE_BEGIN
00102 
00103 class Attributes;
00104 class Locator;
00105 
00134 class  ContentHandler
00135 {
00136 public:
00140     ContentHandler()
00141     {
00142     }
00143 
00145     virtual ~ContentHandler()
00146     {
00147     }
00149 
00177     virtual void characters
00178     (
00179         const   XMLCh* const    chars
00180         , const unsigned int    length
00181     ) = 0;
00182 
00195     virtual void endDocument () = 0;
00196 
00211     virtual void endElement
00212     (
00213         const XMLCh* const uri,
00214         const XMLCh* const localname,
00215         const XMLCh* const qname
00216     ) = 0;
00217 
00241     virtual void ignorableWhitespace
00242     (
00243         const   XMLCh* const    chars
00244         , const unsigned int    length
00245     ) = 0;
00246 
00264     virtual void processingInstruction
00265     (
00266         const   XMLCh* const    target
00267         , const XMLCh* const    data
00268     ) = 0;
00269 
00298     virtual void setDocumentLocator(const Locator* const locator) = 0;
00299 
00310     virtual void startDocument() = 0;
00311 
00335     virtual void startElement
00336     (
00337         const   XMLCh* const    uri,
00338         const   XMLCh* const    localname,
00339         const   XMLCh* const    qname,
00340         const   Attributes&     attrs
00341     ) = 0;
00342 
00355     virtual void startPrefixMapping
00356     (
00357         const   XMLCh* const    prefix,
00358         const   XMLCh* const    uri
00359     ) = 0 ;
00360 
00372     virtual void endPrefixMapping
00373     (
00374         const   XMLCh* const    prefix
00375     ) = 0 ;
00376 
00398     virtual void skippedEntity
00399     (
00400         const   XMLCh* const    name
00401     ) = 0 ;
00402 
00404 private :
00405     /* Unimplemented Constructors and operators */
00406     /* Copy constructor */
00407     ContentHandler(const ContentHandler&);
00409     ContentHandler& operator=(const ContentHandler&);
00410 };
00411 
00412 XERCES_CPP_NAMESPACE_END
00413 
00414 #endif