www.alphaworks.ibm.comwww.ibm.com/developerwww.ibm.com

Home

Readme
Download

Build







Migration

Releases

Feedback

Y2K Compliance


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.8  2000/03/02 19:54:24  roddey
00060   * This checkin includes many changes done while waiting for the
00061   * 1.1.0 code to be finished. I can't list them all here, but a list is
00062   * available elsewhere.
00063   *
00064   * Revision 1.7  2000/02/24 20:00:23  abagchi
00065   * Swat for removing Log from API docs
00066   *
00067   * Revision 1.6  2000/02/16 20:29:20  aruna1
00068   * API Doc++ summary changes in
00069   *
00070   * Revision 1.5  2000/02/16 19:48:56  roddey
00071   * More documentation updates
00072   *
00073   * Revision 1.4  2000/02/15 01:21:30  roddey
00074   * Some initial documentation improvements. More to come...
00075   *
00076   * Revision 1.3  2000/02/09 19:47:27  abagchi
00077   * Added docs for startElement
00078   *
00079   * Revision 1.2  2000/02/06 07:47:48  rahulj
00080   * Year 2K copyright swat.
00081   *
00082   * Revision 1.1.1.1  1999/11/09 01:08:31  twl
00083   * Initial checkin
00084   *
00085   * Revision 1.3  1999/11/08 20:44:37  rahul
00086   * Swat for adding in Product name and CVS comment log variable.
00087   *
00088   */
00089 
00090 
00091 #if !defined(XMLDOCUMENTHANDLER_HPP)
00092 #define XMLDOCUMENTHANDLER_HPP
00093 
00094 #include <util/XercesDefs.hpp>
00095 #include <util/RefVectorOf.hpp>
00096 #include <framework/XMLAttr.hpp>
00097 
00098 class XMLElementDecl;
00099 class XMLEntityDecl;
00100 
00109 class  XMLDocumentHandler
00110 {
00111 public:
00112     // -----------------------------------------------------------------------
00113     //  Constructors are hidden, just the virtual destructor is exposed
00114     // -----------------------------------------------------------------------
00117     virtual ~XMLDocumentHandler()
00118     {
00119     }
00121 
00124 
00144     virtual void docCharacters
00145     (
00146         const   XMLCh* const    chars
00147         , const unsigned int    length
00148         , const bool            cdataSection
00149     ) = 0;
00150 
00158     virtual void docComment
00159     (
00160         const   XMLCh* const    comment
00161     ) = 0;
00162 
00172     virtual void docPI
00173     (
00174         const   XMLCh* const    target
00175         , const XMLCh* const    data
00176     ) = 0;
00177 
00185     virtual void endDocument() = 0;
00186 
00200     virtual void endElement
00201     (
00202         const   XMLElementDecl& elemDecl
00203         , const unsigned int    uriId
00204         , const bool            isRoot
00205     ) = 0;
00206 
00214     virtual void endEntityReference
00215     (
00216         const   XMLEntityDecl&  entDecl
00217     ) = 0;
00218 
00241     virtual void ignorableWhitespace
00242     (
00243         const   XMLCh* const    chars
00244         , const unsigned int    length
00245         , const bool            cdataSection
00246     ) = 0;
00247 
00254     virtual void resetDocument() = 0;
00255 
00261     virtual void startDocument() = 0;
00262 
00280     virtual void startElement
00281     (
00282         const   XMLElementDecl&         elemDecl
00283         , const unsigned int            uriId
00284         , const XMLCh* const            prefixName
00285         , const RefVectorOf<XMLAttr>&   attrList
00286         , const unsigned int            attrCount
00287         , const bool                    isEmpty
00288         , const bool                    isRoot
00289     ) = 0;
00290 
00298     virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
00299 
00317     virtual void XMLDecl
00318     (
00319         const   XMLCh* const    versionStr
00320         , const XMLCh* const    encodingStr
00321         , const XMLCh* const    standaloneStr
00322         , const XMLCh* const    autoEncodingStr
00323     ) = 0;
00325 
00326 
00327 
00328 protected :
00329     // -----------------------------------------------------------------------
00330     //  Hidden Constructors
00331     // -----------------------------------------------------------------------
00332     XMLDocumentHandler()
00333     {
00334     }
00335 
00336 
00337 private:
00338     // -----------------------------------------------------------------------
00339     //  Unimplemented constructors and operators
00340     // -----------------------------------------------------------------------
00341     XMLDocumentHandler(const XMLDocumentHandler&);
00342     void operator=(const XMLDocumentHandler&);
00343 };
00344 
00345 #endif


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