http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

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.2  2002/02/20 18:17:01  tng
00060   * [Bug 5977] Warnings on generating apiDocs.
00061   *
00062   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00063   * sane_include
00064   *
00065   * Revision 1.8  2000/03/02 19:54:24  roddey
00066   * This checkin includes many changes done while waiting for the
00067   * 1.1.0 code to be finished. I can't list them all here, but a list is
00068   * available elsewhere.
00069   *
00070   * Revision 1.7  2000/02/24 20:00:23  abagchi
00071   * Swat for removing Log from API docs
00072   *
00073   * Revision 1.6  2000/02/16 20:29:20  aruna1
00074   * API Doc++ summary changes in
00075   *
00076   * Revision 1.5  2000/02/16 19:48:56  roddey
00077   * More documentation updates
00078   *
00079   * Revision 1.4  2000/02/15 01:21:30  roddey
00080   * Some initial documentation improvements. More to come...
00081   *
00082   * Revision 1.3  2000/02/09 19:47:27  abagchi
00083   * Added docs for startElement
00084   *
00085   * Revision 1.2  2000/02/06 07:47:48  rahulj
00086   * Year 2K copyright swat.
00087   *
00088   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
00089   * Initial checkin
00090   *
00091   * Revision 1.3  1999/11/08 20:44:37  rahul
00092   * Swat for adding in Product name and CVS comment log variable.
00093   *
00094   */
00095 
00096 
00097 #if !defined(XMLDOCUMENTHANDLER_HPP)
00098 #define XMLDOCUMENTHANDLER_HPP
00099 
00100 #include <xercesc/util/XercesDefs.hpp>
00101 #include <xercesc/util/RefVectorOf.hpp>
00102 #include <xercesc/framework/XMLAttr.hpp>
00103 
00104 class XMLElementDecl;
00105 class XMLEntityDecl;
00106 
00115 class  XMLDocumentHandler
00116 {
00117 public:
00118     // -----------------------------------------------------------------------
00119     //  Constructors are hidden, just the virtual destructor is exposed
00120     // -----------------------------------------------------------------------
00123     virtual ~XMLDocumentHandler()
00124     {
00125     }
00127 
00130 
00150     virtual void docCharacters
00151     (
00152         const   XMLCh* const    chars
00153         , const unsigned int    length
00154         , const bool            cdataSection
00155     ) = 0;
00156 
00164     virtual void docComment
00165     (
00166         const   XMLCh* const    comment
00167     ) = 0;
00168 
00178     virtual void docPI
00179     (
00180         const   XMLCh* const    target
00181         , const XMLCh* const    data
00182     ) = 0;
00183 
00191     virtual void endDocument() = 0;
00192 
00206     virtual void endElement
00207     (
00208         const   XMLElementDecl& elemDecl
00209         , const unsigned int    uriId
00210         , const bool            isRoot
00211     ) = 0;
00212 
00220     virtual void endEntityReference
00221     (
00222         const   XMLEntityDecl&  entDecl
00223     ) = 0;
00224 
00247     virtual void ignorableWhitespace
00248     (
00249         const   XMLCh* const    chars
00250         , const unsigned int    length
00251         , const bool            cdataSection
00252     ) = 0;
00253 
00260     virtual void resetDocument() = 0;
00261 
00267     virtual void startDocument() = 0;
00268 
00286     virtual void startElement
00287     (
00288         const   XMLElementDecl&         elemDecl
00289         , const unsigned int            uriId
00290         , const XMLCh* const            prefixName
00291         , const RefVectorOf<XMLAttr>&   attrList
00292         , const unsigned int            attrCount
00293         , const bool                    isEmpty
00294         , const bool                    isRoot
00295     ) = 0;
00296 
00304     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
00305 
00323     virtual void XMLDecl
00324     (
00325         const   XMLCh* const    versionStr
00326         , const XMLCh* const    encodingStr
00327         , const XMLCh* const    standaloneStr
00328         , const XMLCh* const    autoEncodingStr
00329     ) = 0;
00331 
00332 
00333 
00334 protected :
00335     // -----------------------------------------------------------------------
00336     //  Hidden Constructors
00337     // -----------------------------------------------------------------------
00338     XMLDocumentHandler()
00339     {
00340     }
00341 
00342 
00343 private:
00344     // -----------------------------------------------------------------------
00345     //  Unimplemented constructors and operators
00346     // -----------------------------------------------------------------------
00347     XMLDocumentHandler(const XMLDocumentHandler&);
00348     void operator=(const XMLDocumentHandler&);
00349 };
00350 
00351 #endif


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