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  

SAX2XMLReader.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2001 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: SAX2XMLReader.hpp,v $
00059  * Revision 1.12  2001/09/12 13:03:43  tng
00060  * [Bug 3155] SAX2 does not offer progressive parse.
00061  *
00062  * Revision 1.11  2001/08/01 19:11:02  tng
00063  * Add full schema constraint checking flag to the samples and the parser.
00064  *
00065  * Revision 1.10  2001/06/27 17:40:16  knoaman
00066  * Fix for bug #2353.
00067  *
00068  * Revision 1.9  2001/06/19 16:44:31  tng
00069  * Add installAdvDocHandler to SAX2XMLReader as the code is there already.
00070  *
00071  * Revision 1.8  2001/06/04 21:03:07  jberry
00072  * Add pure virtual getErrorCount to SAX2XMLReader interface.
00073  *
00074  * Revision 1.7  2001/05/11 13:26:25  tng
00075  * Copyright update.
00076  *
00077  * Revision 1.6  2001/02/15 15:56:31  tng
00078  * Schema: Add setSchemaValidation and getSchemaValidation for DOMParser and SAXParser.
00079  * Add feature "http://apache.org/xml/features/validation/schema" for SAX2XMLReader.
00080  * New data field  fSchemaValidation in XMLScanner as the flag.
00081  *
00082  * Revision 1.5  2001/01/12 21:22:00  tng
00083  * Documentation Enhancement: Add list of SAX2 feature strings that are supported.
00084  *
00085  * Revision 1.4  2000/12/22 15:17:04  tng
00086  * SAX2-ext's LexicalHandler support added by David Bertoni.
00087  *
00088  * Revision 1.3  2000/08/09 22:19:29  jpolast
00089  * many conformance & stability changes:
00090  *   - ContentHandler::resetDocument() removed
00091  *   - attrs param of ContentHandler::startDocument() made const
00092  *   - SAXExceptions thrown now have msgs
00093  *   - removed duplicate function signatures that had 'const'
00094  *       [ eg: getContentHander() ]
00095  *   - changed getFeature and getProperty to apply to const objs
00096  *   - setProperty now takes a void* instead of const void*
00097  *   - SAX2XMLReaderImpl does not inherit from SAXParser anymore
00098  *   - Reuse Validator (http://apache.org/xml/features/reuse-validator) implemented
00099  *   - Features & Properties now read-only during parse
00100  *
00101  * Revision 1.2  2000/08/07 18:21:27  jpolast
00102  * change  module to 
00103  *
00104  * Revision 1.1  2000/08/02 18:02:35  jpolast
00105  * initial checkin of sax2 implementation
00106  * submitted by Simon Fell (simon@fell.com)
00107  * and Joe Polastre (jpolast@apache.org)
00108  *
00109  *
00110  */
00111 
00112 #ifndef SAX2XMLReader_HPP
00113 #define SAX2XMLReader_HPP
00114 
00115 #include <util/XercesDefs.hpp>
00116 #include <util/XMLUniDefs.hpp>
00117 #include <framework/XMLValidator.hpp>
00118 #include <framework/XMLPScanToken.hpp>
00119 
00120 class ContentHandler ;
00121 class DTDHandler;
00122 class EntityResolver;
00123 class ErrorHandler;
00124 class InputSource;
00125 class LexicalHandler;
00126 class XMLDocumentHandler;
00127 
00128 class  SAX2XMLReader
00129 {
00130 public:
00131 
00132     enum ValSchemes
00133     {
00134         Val_Never
00135         , Val_Always
00136         , Val_Auto
00137     };
00138 
00140     // -----------------------------------------------------------------------
00141     //  Constructors and Destructor
00142     // -----------------------------------------------------------------------
00144     /** The default constructor */
00145     SAX2XMLReader()
00146     {
00147     }
00149     virtual ~SAX2XMLReader()
00150     {
00151     }
00153 
00154     //-----------------------------------------------------------------------
00155     // The XMLReader interface
00156     //-----------------------------------------------------------------------
00159 
00170     virtual int getErrorCount() const = 0 ;
00171 
00177     virtual ContentHandler* getContentHandler() const = 0 ;
00178 
00184     virtual DTDHandler* getDTDHandler() const = 0;
00185 
00191     virtual EntityResolver* getEntityResolver() const = 0 ;
00192 
00198     virtual ErrorHandler* getErrorHandler() const = 0 ;
00199 
00205     virtual LexicalHandler* getLexicalHandler() const = 0 ;
00206 
00214     virtual bool getFeature(const XMLCh* const name) const = 0;
00215 
00223     virtual void* getProperty(const XMLCh* const name) const = 0 ;
00224 
00234     virtual bool getExitOnFirstFatalError() const = 0;
00235 
00246     virtual bool getValidationConstraintFatal() const = 0;
00247 
00248 
00274     virtual void parse
00275     (
00276         const   InputSource&    source
00277     ) = 0;
00278 
00298     virtual void parse
00299     (
00300         const   XMLCh* const    systemId
00301     ) = 0;
00302 
00322     virtual void parse
00323     (
00324         const   char* const     systemId
00325     ) = 0;
00326     
00343     virtual void setContentHandler(ContentHandler* const handler) = 0;
00344 
00360     virtual void setDTDHandler(DTDHandler* const handler) = 0;
00361 
00378     virtual void setEntityResolver(EntityResolver* const resolver) = 0;
00379 
00397     virtual void setErrorHandler(ErrorHandler* const handler) = 0;
00398 
00415     virtual void setLexicalHandler(LexicalHandler* const handler) = 0;
00416 
00432     virtual void setExitOnFirstFatalError(const bool newState) = 0;
00433 
00449     virtual void setValidationConstraintFatal(const bool newState) = 0;
00450 
00469     virtual void setFeature(const XMLCh* const name, const bool value) = 0;
00470 
00482     virtual void setProperty(const XMLCh* const name, void* value) = 0 ;
00483 
00485 
00486     // -----------------------------------------------------------------------
00487     //  Progressive scan methods
00488     // -----------------------------------------------------------------------
00489 
00492 
00523     virtual bool parseFirst
00524     (
00525         const   XMLCh* const    systemId
00526         ,       XMLPScanToken&  toFill
00527         , const bool            reuseGrammar = false
00528     ) = 0;
00529 
00560     virtual bool parseFirst
00561     (
00562         const   char* const     systemId
00563         ,       XMLPScanToken&  toFill
00564         , const bool            reuseGrammar = false
00565     ) = 0;
00566 
00597     virtual bool parseFirst
00598     (
00599         const   InputSource&    source
00600         ,       XMLPScanToken&  toFill
00601         , const bool            reuseGrammar = false
00602     ) = 0;
00603 
00628     virtual bool parseNext(XMLPScanToken& token) = 0;
00629 
00651     virtual void parseReset(XMLPScanToken& token) = 0;
00652 
00654 
00655 
00656     // -----------------------------------------------------------------------
00657     //  Validator: setters and getters
00658     // -----------------------------------------------------------------------
00661 
00670     virtual void setValidator(XMLValidator* valueToAdopt) = 0;
00671 
00682     virtual XMLValidator* getValidator() const = 0;
00684 
00685     // -----------------------------------------------------------------------
00686     //  Advanced document handler list maintenance methods
00687     // -----------------------------------------------------------------------
00688 
00691 
00704     virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall) = 0;
00705 
00715     virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove) = 0;
00717 
00718 private :
00719     /* The copy constructor, you cannot call this directly */
00720     SAX2XMLReader(const SAX2XMLReader&);
00721 
00722     /* The assignment operator, you cannot call this directly */
00723     void operator=(const SAX2XMLReader&);
00724 
00725 };
00726 
00727 #endif


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