XMLDocumentHandler.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: XMLDocumentHandler.hpp,v $
00059   * Revision 1.6  2003/11/28 05:14:34  neilg
00060   * update XMLDocumentHandler to enable stateless passing of type information for elements.  Note that this is as yet unimplemented.
00061   *
00062   * Revision 1.5  2003/03/07 18:08:10  tng
00063   * Return a reference instead of void for operator=
00064   *
00065   * Revision 1.4  2002/11/04 15:00:21  tng
00066   * C++ Namespace Support.
00067   *
00068   * Revision 1.3  2002/05/28 20:41:11  tng
00069   * [Bug 9104] prefixes dissapearing when schema validation turned on.
00070   *
00071   * Revision 1.2  2002/02/20 18:17:01  tng
00072   * [Bug 5977] Warnings on generating apiDocs.
00073   *
00074   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00075   * sane_include
00076   *
00077   * Revision 1.8  2000/03/02 19:54:24  roddey
00078   * This checkin includes many changes done while waiting for the
00079   * 1.1.0 code to be finished. I can't list them all here, but a list is
00080   * available elsewhere.
00081   *
00082   * Revision 1.7  2000/02/24 20:00:23  abagchi
00083   * Swat for removing Log from API docs
00084   *
00085   * Revision 1.6  2000/02/16 20:29:20  aruna1
00086   * API Doc++ summary changes in
00087   *
00088   * Revision 1.5  2000/02/16 19:48:56  roddey
00089   * More documentation updates
00090   *
00091   * Revision 1.4  2000/02/15 01:21:30  roddey
00092   * Some initial documentation improvements. More to come...
00093   *
00094   * Revision 1.3  2000/02/09 19:47:27  abagchi
00095   * Added docs for startElement
00096   *
00097   * Revision 1.2  2000/02/06 07:47:48  rahulj
00098   * Year 2K copyright swat.
00099   *
00100   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
00101   * Initial checkin
00102   *
00103   * Revision 1.3  1999/11/08 20:44:37  rahul
00104   * Swat for adding in Product name and CVS comment log variable.
00105   *
00106   */
00107 
00108 
00109 #if !defined(XMLDOCUMENTHANDLER_HPP)
00110 #define XMLDOCUMENTHANDLER_HPP
00111 
00112 #include <xercesc/util/XercesDefs.hpp>
00113 #include <xercesc/util/RefVectorOf.hpp>
00114 #include <xercesc/framework/XMLAttr.hpp>
00115 
00116 XERCES_CPP_NAMESPACE_BEGIN
00117 
00118 class XMLElementDecl;
00119 class XMLEntityDecl;
00120 
00129 class  XMLDocumentHandler
00130 {
00131 public:
00132     // -----------------------------------------------------------------------
00133     //  Constructors are hidden, just the virtual destructor is exposed
00134     // -----------------------------------------------------------------------
00137     virtual ~XMLDocumentHandler()
00138     {
00139     }
00141 
00164     virtual void docCharacters
00165     (
00166         const   XMLCh* const    chars
00167         , const unsigned int    length
00168         , const bool            cdataSection
00169     ) = 0;
00170 
00178     virtual void docComment
00179     (
00180         const   XMLCh* const    comment
00181     ) = 0;
00182 
00192     virtual void docPI
00193     (
00194         const   XMLCh* const    target
00195         , const XMLCh* const    data
00196     ) = 0;
00197 
00205     virtual void endDocument() = 0;
00206 
00221     virtual void endElement
00222     (
00223         const   XMLElementDecl& elemDecl
00224         , const unsigned int    uriId
00225         , const bool            isRoot
00226         , const XMLCh* const    prefixName = 0
00227     ) = 0;
00228 
00236     virtual void endEntityReference
00237     (
00238         const   XMLEntityDecl&  entDecl
00239     ) = 0;
00240 
00263     virtual void ignorableWhitespace
00264     (
00265         const   XMLCh* const    chars
00266         , const unsigned int    length
00267         , const bool            cdataSection
00268     ) = 0;
00269 
00276     virtual void resetDocument() = 0;
00277 
00283     virtual void startDocument() = 0;
00284 
00302     virtual void startElement
00303     (
00304         const   XMLElementDecl&         elemDecl
00305         , const unsigned int            uriId
00306         , const XMLCh* const            prefixName
00307         , const RefVectorOf<XMLAttr>&   attrList
00308         , const unsigned int            attrCount
00309         , const bool                    isEmpty
00310         , const bool                    isRoot
00311     ) = 0;
00312 
00320     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
00321 
00339     virtual void XMLDecl
00340     (
00341         const   XMLCh* const    versionStr
00342         , const XMLCh* const    encodingStr
00343         , const XMLCh* const    standaloneStr
00344         , const XMLCh* const    autoEncodingStr
00345     ) = 0;
00346 
00366     virtual void elementTypeInfo
00367     (
00368         const   XMLCh* const    typeName
00369         , const XMLCh* const    typeURI
00370     ) { /* non pure virtual to permit backward compatibility of implementations.  */  };
00372 
00373 
00374 
00375 protected :
00376     // -----------------------------------------------------------------------
00377     //  Hidden Constructors
00378     // -----------------------------------------------------------------------
00379     XMLDocumentHandler()
00380     {
00381     }
00382 
00383 
00384 private:
00385     // -----------------------------------------------------------------------
00386     //  Unimplemented constructors and operators
00387     // -----------------------------------------------------------------------
00388     XMLDocumentHandler(const XMLDocumentHandler&);
00389     XMLDocumentHandler& operator=(const XMLDocumentHandler&);
00390 };
00391 
00392 XERCES_CPP_NAMESPACE_END
00393 
00394 #endif