DocumentHandler.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: DocumentHandler.hpp,v $
00059  * Revision 1.3  2003/03/07 18:10:06  tng
00060  * Return a reference instead of void for operator=
00061  *
00062  * Revision 1.2  2002/11/04 14:56:25  tng
00063  * C++ Namespace Support.
00064  *
00065  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
00066  * sane_include
00067  *
00068  * Revision 1.6  2000/03/02 19:54:34  roddey
00069  * This checkin includes many changes done while waiting for the
00070  * 1.1.0 code to be finished. I can't list them all here, but a list is
00071  * available elsewhere.
00072  *
00073  * Revision 1.5  2000/02/24 20:12:55  abagchi
00074  * Swat for removing Log from API docs
00075  *
00076  * Revision 1.4  2000/02/12 03:31:55  rahulj
00077  * Removed duplicate CVS Log entries.
00078  *
00079  * Revision 1.3  2000/02/12 01:27:19  aruna1
00080  * Documentation updated
00081  *
00082  * Revision 1.2  2000/02/06 07:47:57  rahulj
00083  * Year 2K copyright swat.
00084  *
00085  * Revision 1.1.1.1  1999/11/09 01:07:43  twl
00086  * Initial checkin
00087  *
00088  * Revision 1.2  1999/11/08 20:44:54  rahul
00089  * Swat for adding in Product name and CVS comment log variable.
00090  *
00091  */
00092 
00093 
00094 #ifndef DOCUMENTHANDLER_HPP
00095 #define DOCUMENTHANDLER_HPP
00096 
00097 #include <xercesc/util/XercesDefs.hpp>
00098 
00099 XERCES_CPP_NAMESPACE_BEGIN
00100 
00101 class AttributeList;
00102 class Locator;
00103 
00132 class  DocumentHandler
00133 {
00134 public:
00138     DocumentHandler()
00139     {
00140     }
00141 
00143     virtual ~DocumentHandler()
00144     {
00145     }
00147 
00175     virtual void characters
00176     (
00177         const   XMLCh* const    chars
00178         , const unsigned int    length
00179     ) = 0;
00180 
00193     virtual void endDocument () = 0;
00194 
00210     virtual void endElement(const XMLCh* const name) = 0;
00211 
00235     virtual void ignorableWhitespace
00236     (
00237         const   XMLCh* const    chars
00238         , const unsigned int    length
00239     ) = 0;
00240 
00258     virtual void processingInstruction
00259     (
00260         const   XMLCh* const    target
00261         , const XMLCh* const    data
00262     ) = 0;
00263 
00271     virtual void resetDocument() = 0;
00272 
00301     virtual void setDocumentLocator(const Locator* const locator) = 0;
00302 
00313     virtual void startDocument() = 0;
00314 
00337     virtual void startElement
00338     (
00339         const   XMLCh* const    name
00340         ,       AttributeList&  attrs
00341     ) = 0;
00342 
00344 
00345 private :
00346     /* Unimplemented Constructors and operators */
00347     /* Copy constructor */
00348     DocumentHandler(const DocumentHandler&);
00350     DocumentHandler& operator=(const DocumentHandler&);
00351 };
00352 
00353 XERCES_CPP_NAMESPACE_END
00354 
00355 #endif