| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XMLDocumentHandler.hpp

Go to the documentation of this 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.7  2004/01/29 11:46:29  cargilld
    00060   * Code cleanup changes to get rid of various compiler diagnostic messages.
    00061   *
    00062   * Revision 1.6  2003/11/28 05:14:34  neilg
    00063   * update XMLDocumentHandler to enable stateless passing of type information for elements.  Note that this is as yet unimplemented.
    00064   *
    00065   * Revision 1.5  2003/03/07 18:08:10  tng
    00066   * Return a reference instead of void for operator=
    00067   *
    00068   * Revision 1.4  2002/11/04 15:00:21  tng
    00069   * C++ Namespace Support.
    00070   *
    00071   * Revision 1.3  2002/05/28 20:41:11  tng
    00072   * [Bug 9104] prefixes dissapearing when schema validation turned on.
    00073   *
    00074   * Revision 1.2  2002/02/20 18:17:01  tng
    00075   * [Bug 5977] Warnings on generating apiDocs.
    00076   *
    00077   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
    00078   * sane_include
    00079   *
    00080   * Revision 1.8  2000/03/02 19:54:24  roddey
    00081   * This checkin includes many changes done while waiting for the
    00082   * 1.1.0 code to be finished. I can't list them all here, but a list is
    00083   * available elsewhere.
    00084   *
    00085   * Revision 1.7  2000/02/24 20:00:23  abagchi
    00086   * Swat for removing Log from API docs
    00087   *
    00088   * Revision 1.6  2000/02/16 20:29:20  aruna1
    00089   * API Doc++ summary changes in
    00090   *
    00091   * Revision 1.5  2000/02/16 19:48:56  roddey
    00092   * More documentation updates
    00093   *
    00094   * Revision 1.4  2000/02/15 01:21:30  roddey
    00095   * Some initial documentation improvements. More to come...
    00096   *
    00097   * Revision 1.3  2000/02/09 19:47:27  abagchi
    00098   * Added docs for startElement
    00099   *
    00100   * Revision 1.2  2000/02/06 07:47:48  rahulj
    00101   * Year 2K copyright swat.
    00102   *
    00103   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
    00104   * Initial checkin
    00105   *
    00106   * Revision 1.3  1999/11/08 20:44:37  rahul
    00107   * Swat for adding in Product name and CVS comment log variable.
    00108   *
    00109   */
    00110
    00111
    00112 #if !defined(XMLDOCUMENTHANDLER_HPP)
    00113 #define XMLDOCUMENTHANDLER_HPP
    00114
    00115 #include <xercesc/util/XercesDefs.hpp>
    00116 #include <xercesc/util/RefVectorOf.hpp>
    00117 #include <xercesc/framework/XMLAttr.hpp>
    00118
    00119 XERCES_CPP_NAMESPACE_BEGIN
    00120
    00121 class XMLElementDecl;
    00122 class XMLEntityDecl;
    00123
    00132 class  XMLDocumentHandler
    00133 {
    00134 public:
    00135     // -----------------------------------------------------------------------
    00136     //  Constructors are hidden, just the virtual destructor is exposed
    00137     // -----------------------------------------------------------------------
    00140     virtual ~XMLDocumentHandler()
    00141     {
    00142     }
    00144
    00167     virtual void docCharacters
    00168     (
    00169         const   XMLCh* const    chars
    00170         , const unsigned int    length
    00171         , const bool            cdataSection
    00172     ) = 0;
    00173
    00181     virtual void docComment
    00182     (
    00183         const   XMLCh* const    comment
    00184     ) = 0;
    00185
    00195     virtual void docPI
    00196     (
    00197         const   XMLCh* const    target
    00198         , const XMLCh* const    data
    00199     ) = 0;
    00200
    00208     virtual void endDocument() = 0;
    00209
    00224     virtual void endElement
    00225     (
    00226         const   XMLElementDecl& elemDecl
    00227         , const unsigned int    uriId
    00228         , const bool            isRoot
    00229         , const XMLCh* const    prefixName = 0
    00230     ) = 0;
    00231
    00239     virtual void endEntityReference
    00240     (
    00241         const   XMLEntityDecl&  entDecl
    00242     ) = 0;
    00243
    00266     virtual void ignorableWhitespace
    00267     (
    00268         const   XMLCh* const    chars
    00269         , const unsigned int    length
    00270         , const bool            cdataSection
    00271     ) = 0;
    00272
    00279     virtual void resetDocument() = 0;
    00280
    00286     virtual void startDocument() = 0;
    00287
    00305     virtual void startElement
    00306     (
    00307         const   XMLElementDecl&         elemDecl
    00308         , const unsigned int            uriId
    00309         , const XMLCh* const            prefixName
    00310         , const RefVectorOf<XMLAttr>&   attrList
    00311         , const unsigned int            attrCount
    00312         , const bool                    isEmpty
    00313         , const bool                    isRoot
    00314     ) = 0;
    00315
    00323     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
    00324
    00342     virtual void XMLDecl
    00343     (
    00344         const   XMLCh* const    versionStr
    00345         , const XMLCh* const    encodingStr
    00346         , const XMLCh* const    standaloneStr
    00347         , const XMLCh* const    autoEncodingStr
    00348     ) = 0;
    00349
    00369     virtual void elementTypeInfo
    00370     (
    00371         const   XMLCh* const
    00372         , const XMLCh* const
    00373     ) { /* non pure virtual to permit backward compatibility of implementations.  */  };
    00375
    00376
    00377
    00378 protected :
    00379     // -----------------------------------------------------------------------
    00380     //  Hidden Constructors
    00381     // -----------------------------------------------------------------------
    00382     XMLDocumentHandler()
    00383     {
    00384     }
    00385
    00386
    00387 private:
    00388     // -----------------------------------------------------------------------
    00389     //  Unimplemented constructors and operators
    00390     // -----------------------------------------------------------------------
    00391     XMLDocumentHandler(const XMLDocumentHandler&);
    00392     XMLDocumentHandler& operator=(const XMLDocumentHandler&);
    00393 };
    00394
    00395 XERCES_CPP_NAMESPACE_END
    00396
    00397 #endif

Copyright © 2004 The Apache Software Foundation. All Rights Reserved.