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

Home

Readme
Release Info

Installation
Download
Build

FAQs
Samples
API Docs

DOM C++ Binding
Programming
Migration Guide

Feedback
Bug-Reporting
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.5  2003/03/07 18:08:10  tng
00060   * Return a reference instead of void for operator=
00061   *
00062   * Revision 1.4  2002/11/04 15:00:21  tng
00063   * C++ Namespace Support.
00064   *
00065   * Revision 1.3  2002/05/28 20:41:11  tng
00066   * [Bug 9104] prefixes dissapearing when schema validation turned on.
00067   *
00068   * Revision 1.2  2002/02/20 18:17:01  tng
00069   * [Bug 5977] Warnings on generating apiDocs.
00070   *
00071   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00072   * sane_include
00073   *
00074   * Revision 1.8  2000/03/02 19:54:24  roddey
00075   * This checkin includes many changes done while waiting for the
00076   * 1.1.0 code to be finished. I can't list them all here, but a list is
00077   * available elsewhere.
00078   *
00079   * Revision 1.7  2000/02/24 20:00:23  abagchi
00080   * Swat for removing Log from API docs
00081   *
00082   * Revision 1.6  2000/02/16 20:29:20  aruna1
00083   * API Doc++ summary changes in
00084   *
00085   * Revision 1.5  2000/02/16 19:48:56  roddey
00086   * More documentation updates
00087   *
00088   * Revision 1.4  2000/02/15 01:21:30  roddey
00089   * Some initial documentation improvements. More to come...
00090   *
00091   * Revision 1.3  2000/02/09 19:47:27  abagchi
00092   * Added docs for startElement
00093   *
00094   * Revision 1.2  2000/02/06 07:47:48  rahulj
00095   * Year 2K copyright swat.
00096   *
00097   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
00098   * Initial checkin
00099   *
00100   * Revision 1.3  1999/11/08 20:44:37  rahul
00101   * Swat for adding in Product name and CVS comment log variable.
00102   *
00103   */
00104 
00105 
00106 #if !defined(XMLDOCUMENTHANDLER_HPP)
00107 #define XMLDOCUMENTHANDLER_HPP
00108 
00109 #include <xercesc/util/XercesDefs.hpp>
00110 #include <xercesc/util/RefVectorOf.hpp>
00111 #include <xercesc/framework/XMLAttr.hpp>
00112 
00113 XERCES_CPP_NAMESPACE_BEGIN
00114 
00115 class XMLElementDecl;
00116 class XMLEntityDecl;
00117 
00126 class  XMLDocumentHandler
00127 {
00128 public:
00129     // -----------------------------------------------------------------------
00130     //  Constructors are hidden, just the virtual destructor is exposed
00131     // -----------------------------------------------------------------------
00134     virtual ~XMLDocumentHandler()
00135     {
00136     }
00138 
00161     virtual void docCharacters
00162     (
00163         const   XMLCh* const    chars
00164         , const unsigned int    length
00165         , const bool            cdataSection
00166     ) = 0;
00167 
00175     virtual void docComment
00176     (
00177         const   XMLCh* const    comment
00178     ) = 0;
00179 
00189     virtual void docPI
00190     (
00191         const   XMLCh* const    target
00192         , const XMLCh* const    data
00193     ) = 0;
00194 
00202     virtual void endDocument() = 0;
00203 
00218     virtual void endElement
00219     (
00220         const   XMLElementDecl& elemDecl
00221         , const unsigned int    uriId
00222         , const bool            isRoot
00223         , const XMLCh* const    prefixName = 0
00224     ) = 0;
00225 
00233     virtual void endEntityReference
00234     (
00235         const   XMLEntityDecl&  entDecl
00236     ) = 0;
00237 
00260     virtual void ignorableWhitespace
00261     (
00262         const   XMLCh* const    chars
00263         , const unsigned int    length
00264         , const bool            cdataSection
00265     ) = 0;
00266 
00273     virtual void resetDocument() = 0;
00274 
00280     virtual void startDocument() = 0;
00281 
00299     virtual void startElement
00300     (
00301         const   XMLElementDecl&         elemDecl
00302         , const unsigned int            uriId
00303         , const XMLCh* const            prefixName
00304         , const RefVectorOf<XMLAttr>&   attrList
00305         , const unsigned int            attrCount
00306         , const bool                    isEmpty
00307         , const bool                    isRoot
00308     ) = 0;
00309 
00317     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
00318 
00336     virtual void XMLDecl
00337     (
00338         const   XMLCh* const    versionStr
00339         , const XMLCh* const    encodingStr
00340         , const XMLCh* const    standaloneStr
00341         , const XMLCh* const    autoEncodingStr
00342     ) = 0;
00344 
00345 
00346 
00347 protected :
00348     // -----------------------------------------------------------------------
00349     //  Hidden Constructors
00350     // -----------------------------------------------------------------------
00351     XMLDocumentHandler()
00352     {
00353     }
00354 
00355 
00356 private:
00357     // -----------------------------------------------------------------------
00358     //  Unimplemented constructors and operators
00359     // -----------------------------------------------------------------------
00360     XMLDocumentHandler(const XMLDocumentHandler&);
00361     XMLDocumentHandler& operator=(const XMLDocumentHandler&);
00362 };
00363 
00364 XERCES_CPP_NAMESPACE_END
00365 
00366 #endif


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