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.3  2002/05/28 20:41:11  tng
00060   * [Bug 9104] prefixes dissapearing when schema validation turned on.
00061   *
00062   * Revision 1.2  2002/02/20 18:17:01  tng
00063   * [Bug 5977] Warnings on generating apiDocs.
00064   *
00065   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
00066   * sane_include
00067   *
00068   * Revision 1.8  2000/03/02 19:54:24  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.7  2000/02/24 20:00:23  abagchi
00074   * Swat for removing Log from API docs
00075   *
00076   * Revision 1.6  2000/02/16 20:29:20  aruna1
00077   * API Doc++ summary changes in
00078   *
00079   * Revision 1.5  2000/02/16 19:48:56  roddey
00080   * More documentation updates
00081   *
00082   * Revision 1.4  2000/02/15 01:21:30  roddey
00083   * Some initial documentation improvements. More to come...
00084   *
00085   * Revision 1.3  2000/02/09 19:47:27  abagchi
00086   * Added docs for startElement
00087   *
00088   * Revision 1.2  2000/02/06 07:47:48  rahulj
00089   * Year 2K copyright swat.
00090   *
00091   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
00092   * Initial checkin
00093   *
00094   * Revision 1.3  1999/11/08 20:44:37  rahul
00095   * Swat for adding in Product name and CVS comment log variable.
00096   *
00097   */
00098 
00099 
00100 #if !defined(XMLDOCUMENTHANDLER_HPP)
00101 #define XMLDOCUMENTHANDLER_HPP
00102 
00103 #include <xercesc/util/XercesDefs.hpp>
00104 #include <xercesc/util/RefVectorOf.hpp>
00105 #include <xercesc/framework/XMLAttr.hpp>
00106 
00107 class XMLElementDecl;
00108 class XMLEntityDecl;
00109 
00118 class  XMLDocumentHandler
00119 {
00120 public:
00121     // -----------------------------------------------------------------------
00122     //  Constructors are hidden, just the virtual destructor is exposed
00123     // -----------------------------------------------------------------------
00126     virtual ~XMLDocumentHandler()
00127     {
00128     }
00130 
00133 
00153     virtual void docCharacters
00154     (
00155         const   XMLCh* const    chars
00156         , const unsigned int    length
00157         , const bool            cdataSection
00158     ) = 0;
00159 
00167     virtual void docComment
00168     (
00169         const   XMLCh* const    comment
00170     ) = 0;
00171 
00181     virtual void docPI
00182     (
00183         const   XMLCh* const    target
00184         , const XMLCh* const    data
00185     ) = 0;
00186 
00194     virtual void endDocument() = 0;
00195 
00210     virtual void endElement
00211     (
00212         const   XMLElementDecl& elemDecl
00213         , const unsigned int    uriId
00214         , const bool            isRoot
00215         , const XMLCh* const    prefixName = 0
00216     ) = 0;
00217 
00225     virtual void endEntityReference
00226     (
00227         const   XMLEntityDecl&  entDecl
00228     ) = 0;
00229 
00252     virtual void ignorableWhitespace
00253     (
00254         const   XMLCh* const    chars
00255         , const unsigned int    length
00256         , const bool            cdataSection
00257     ) = 0;
00258 
00265     virtual void resetDocument() = 0;
00266 
00272     virtual void startDocument() = 0;
00273 
00291     virtual void startElement
00292     (
00293         const   XMLElementDecl&         elemDecl
00294         , const unsigned int            uriId
00295         , const XMLCh* const            prefixName
00296         , const RefVectorOf<XMLAttr>&   attrList
00297         , const unsigned int            attrCount
00298         , const bool                    isEmpty
00299         , const bool                    isRoot
00300     ) = 0;
00301 
00309     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
00310 
00328     virtual void XMLDecl
00329     (
00330         const   XMLCh* const    versionStr
00331         , const XMLCh* const    encodingStr
00332         , const XMLCh* const    standaloneStr
00333         , const XMLCh* const    autoEncodingStr
00334     ) = 0;
00336 
00337 
00338 
00339 protected :
00340     // -----------------------------------------------------------------------
00341     //  Hidden Constructors
00342     // -----------------------------------------------------------------------
00343     XMLDocumentHandler()
00344     {
00345     }
00346 
00347 
00348 private:
00349     // -----------------------------------------------------------------------
00350     //  Unimplemented constructors and operators
00351     // -----------------------------------------------------------------------
00352     XMLDocumentHandler(const XMLDocumentHandler&);
00353     void operator=(const XMLDocumentHandler&);
00354 };
00355 
00356 #endif


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