SAX2XMLReader.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:30k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: SAX2XMLReader.hpp,v $
  58.  * Revision 1.14  2001/11/20 18:51:44  tng
  59.  * Schema: schemaLocation and noNamespaceSchemaLocation to be specified outside the instance document.  New methods setExternalSchemaLocation and setExternalNoNamespaceSchemaLocation are added (for SAX2, two new properties are added).
  60.  *
  61.  * Revision 1.13  2001/11/14 14:15:59  tng
  62.  * Update SAX2 feature documentation.
  63.  *
  64.  * Revision 1.12  2001/09/12 13:03:43  tng
  65.  * [Bug 3155] SAX2 does not offer progressive parse.
  66.  *
  67.  * Revision 1.11  2001/08/01 19:11:02  tng
  68.  * Add full schema constraint checking flag to the samples and the parser.
  69.  *
  70.  * Revision 1.10  2001/06/27 17:40:16  knoaman
  71.  * Fix for bug #2353.
  72.  *
  73.  * Revision 1.9  2001/06/19 16:44:31  tng
  74.  * Add installAdvDocHandler to SAX2XMLReader as the code is there already.
  75.  *
  76.  * Revision 1.8  2001/06/04 21:03:07  jberry
  77.  * Add pure virtual getErrorCount to SAX2XMLReader interface.
  78.  *
  79.  * Revision 1.7  2001/05/11 13:26:25  tng
  80.  * Copyright update.
  81.  *
  82.  * Revision 1.6  2001/02/15 15:56:31  tng
  83.  * Schema: Add setSchemaValidation and getSchemaValidation for DOMParser and SAXParser.
  84.  * Add feature "http://apache.org/xml/features/validation/schema" for SAX2XMLReader.
  85.  * New data field  fSchemaValidation in XMLScanner as the flag.
  86.  *
  87.  * Revision 1.5  2001/01/12 21:22:00  tng
  88.  * Documentation Enhancement: Add list of SAX2 feature strings that are supported.
  89.  *
  90.  * Revision 1.4  2000/12/22 15:17:04  tng
  91.  * SAX2-ext's LexicalHandler support added by David Bertoni.
  92.  *
  93.  * Revision 1.3  2000/08/09 22:19:29  jpolast
  94.  * many conformance & stability changes:
  95.  *   - ContentHandler::resetDocument() removed
  96.  *   - attrs param of ContentHandler::startDocument() made const
  97.  *   - SAXExceptions thrown now have msgs
  98.  *   - removed duplicate function signatures that had 'const'
  99.  *       [ eg: getContentHander() ]
  100.  *   - changed getFeature and getProperty to apply to const objs
  101.  *   - setProperty now takes a void* instead of const void*
  102.  *   - SAX2XMLReaderImpl does not inherit from SAXParser anymore
  103.  *   - Reuse Validator (http://apache.org/xml/features/reuse-validator) implemented
  104.  *   - Features & Properties now read-only during parse
  105.  *
  106.  * Revision 1.2  2000/08/07 18:21:27  jpolast
  107.  * change SAX_EXPORT module to SAX2_EXPORT
  108.  *
  109.  * Revision 1.1  2000/08/02 18:02:35  jpolast
  110.  * initial checkin of sax2 implementation
  111.  * submitted by Simon Fell (simon@fell.com)
  112.  * and Joe Polastre (jpolast@apache.org)
  113.  *
  114.  *
  115.  */
  116. #ifndef SAX2XMLReader_HPP
  117. #define SAX2XMLReader_HPP
  118. #include <util/XercesDefs.hpp>
  119. #include <util/XMLUniDefs.hpp>
  120. #include <framework/XMLValidator.hpp>
  121. #include <framework/XMLPScanToken.hpp>
  122. class ContentHandler ;
  123. class DTDHandler;
  124. class EntityResolver;
  125. class ErrorHandler;
  126. class InputSource;
  127. class LexicalHandler;
  128. class XMLDocumentHandler;
  129. class SAX2_EXPORT SAX2XMLReader
  130. {
  131. public:
  132.     enum ValSchemes
  133.     {
  134.         Val_Never
  135.         , Val_Always
  136.         , Val_Auto
  137.     };
  138.     /** @name Constructors and Destructor */
  139.     // -----------------------------------------------------------------------
  140.     //  Constructors and Destructor
  141.     // -----------------------------------------------------------------------
  142.     //@{
  143.     /** The default constructor */
  144.     SAX2XMLReader()
  145.     {
  146.     }
  147.     /** The destructor */
  148.     virtual ~SAX2XMLReader()
  149.     {
  150.     }
  151.     //@}
  152.     //-----------------------------------------------------------------------
  153.     // The XMLReader interface
  154.     //-----------------------------------------------------------------------
  155.     /** @name The XMLReader interfaces */
  156.     //@{
  157.     /** Get error count from the last parse operation.
  158.       *
  159.       * This method returns the error count from the last parse
  160.       * operation. Note that this count is actually stored in the
  161.       * scanner, so this method simply returns what the
  162.       * scanner reports.
  163.       *
  164.       * @return number of errors encountered during the latest
  165.       * parse operation.
  166.       */
  167.     virtual int getErrorCount() const = 0 ;
  168.     /**
  169.       * This method returns the installed content handler.
  170.       *
  171.       * @return A pointer to the installed content handler object.
  172.       */
  173.     virtual ContentHandler* getContentHandler() const = 0 ;
  174.     /**
  175.       * This method returns the installed DTD handler.
  176.       *
  177.       * @return A pointer to the installed DTD handler object.
  178.       */
  179.     virtual DTDHandler* getDTDHandler() const = 0;
  180.     /**
  181.       * This method returns the installed entity resolver.
  182.       *
  183.       * @return A pointer to the installed entity resolver object.
  184.       */
  185.     virtual EntityResolver* getEntityResolver() const = 0 ;
  186.     /**
  187.       * This method returns the installed error handler.
  188.       *
  189.       * @return A pointer to the installed error handler object.
  190.       */
  191.     virtual ErrorHandler* getErrorHandler() const = 0 ;
  192. /**
  193.       * This method returns the installed lexical handler.
  194.       *
  195.       * @return A pointer to the installed lexical handler object.
  196.       */
  197.     virtual LexicalHandler* getLexicalHandler() const = 0 ;
  198. /**
  199.      * Query the current state of any feature in a SAX2 XMLReader.
  200.   *
  201.   * @param name The unique identifier (URI) of the feature being set.
  202.   * @return The current state of the feature.
  203.      * @exception SAXNotRecognizedException If the requested feature is not known.
  204.   */
  205. virtual bool getFeature(const XMLCh* const name) const = 0;
  206. /**
  207.      * Query the current value of a property in a SAX2 XMLReader.
  208.      *
  209.      * The parser owns the returned pointer, and the memory allocated for
  210.      * the returned pointer will be destroyed when the parser is deleted.
  211.      *
  212.      * To ensure assessiblity of the returned information after the parser
  213.      * is deleted, callers need to copy and store the returned information
  214.      * somewhere else; other you may get unexpected result.  Since the returned
  215.      * pointer is a generic void pointer, see
  216.      * http://xml.apache.org/xerces-c/program.html#SAX2Properties to learn
  217.      * exactly what type of object each property returns for replication.
  218.      *
  219.      * @param name The unique identifier (URI) of the property being set.
  220.      * @return     The current value of the property.  The pointer spans the same
  221.      *             life-time as the parser.  A null pointer is returned if nothing
  222.      *             was specified externally.
  223.      * @exception  SAXNotRecognizedException If the requested property is not known.
  224.      */
  225. virtual void* getProperty(const XMLCh* const name) const = 0 ;
  226.     /**
  227.       * This method returns the state of the parser's
  228.       * exit-on-First-Fatal-Error flag.
  229.       *
  230.       * @return true, if the parser is currently configured to
  231.       *         exit on the first fatal error, false otherwise.
  232.       *
  233.       * @see #setExitOnFirstFatalError
  234.       */
  235.     virtual bool getExitOnFirstFatalError() const = 0;
  236.     /**
  237.       * This method returns the state of the parser's
  238.       * validation-constraint-fatal flag.
  239.       *
  240.       * @return true, if the parser is currently configured to
  241.       *         set validation constraint errors as fatal, false
  242.       *         otherwise.
  243.       *
  244.       * @see #setValidationContraintFatal
  245.       */
  246.     virtual bool getValidationConstraintFatal() const = 0;
  247.   /**
  248.     * Parse an XML document.
  249.     *
  250.     * The application can use this method to instruct the SAX parser
  251.     * to begin parsing an XML document from any valid input
  252.     * source (a character stream, a byte stream, or a URI).
  253.     *
  254.     * Applications may not invoke this method while a parse is in
  255.     * progress (they should create a new Parser instead for each
  256.     * additional XML document).  Once a parse is complete, an
  257.     * application may reuse the same Parser object, possibly with a
  258.     * different input source.
  259.     *
  260.     * @param source The input source for the top-level of the
  261.     *               XML document.
  262.     * @exception SAXException Any SAX exception, possibly
  263.     *            wrapping another exception.
  264.     * @exception XMLException An exception from the parser or client
  265.     *            handler code.
  266.     * @see InputSource#InputSource
  267.     * @see #setEntityResolver
  268.     * @see #setDTDHandler
  269.     * @see #setDocumentHandler
  270.     * @see #setErrorHandler
  271.     */
  272.     virtual void parse
  273.     (
  274.         const   InputSource&    source
  275.     ) = 0;
  276.   /**
  277.     * Parse an XML document from a system identifier (URI).
  278.     *
  279.     * This method is a shortcut for the common case of reading a
  280.     * document from a system identifier.  It is the exact equivalent
  281.     * of the following:
  282.     *
  283.     * parse(new URLInputSource(systemId));
  284.     *
  285.     * If the system identifier is a URL, it must be fully resolved
  286.     * by the application before it is passed to the parser.
  287.     *
  288.     * @param systemId The system identifier (URI).
  289.     * @exception SAXException Any SAX exception, possibly
  290.     *            wrapping another exception.
  291.     * @exception XMLException An exception from the parser or client
  292.     *            handler code.
  293.     * @see #parse(InputSource)
  294.     */
  295.     virtual void parse
  296.     (
  297.         const   XMLCh* const    systemId
  298.     ) = 0;
  299.   /**
  300.     * Parse an XML document from a system identifier (URI).
  301.     *
  302.     * This method is a shortcut for the common case of reading a
  303.     * document from a system identifier.  It is the exact equivalent
  304.     * of the following:
  305.     *
  306.     * parse(new URLInputSource(systemId));
  307.     *
  308.     * If the system identifier is a URL, it must be fully resolved
  309.     * by the application before it is passed to the parser.
  310.     *
  311.     * @param systemId The system identifier (URI).
  312.     * @exception SAXException Any SAX exception, possibly
  313.     *            wrapping another exception.
  314.     * @exception XMLException An exception from the parser or client
  315.     *            handler code.
  316.     * @see #parse(InputSource)
  317.     */
  318.     virtual void parse
  319.     (
  320.         const   char* const     systemId
  321.     ) = 0;
  322.   /**
  323.     * Allow an application to register a document event handler.
  324.     *
  325.     * If the application does not register a document handler, all
  326.     * document events reported by the SAX parser will be silently
  327.     * ignored (this is the default behaviour implemented by
  328.     * HandlerBase).
  329.     *
  330.     * Applications may register a new or different handler in the
  331.     * middle of a parse, and the SAX parser must begin using the new
  332.     * handler immediately.
  333.     *
  334.     * @param handler The document handler.
  335.     * @see DocumentHandler#DocumentHandler
  336.     * @see HandlerBase#HandlerBase
  337.     */
  338.     virtual void setContentHandler(ContentHandler* const handler) = 0;
  339.   /**
  340.     * Allow an application to register a DTD event handler.
  341.     *
  342.     * If the application does not register a DTD handler, all DTD
  343.     * events reported by the SAX parser will be silently ignored (this
  344.     * is the default behaviour implemented by HandlerBase).
  345.     *
  346.     * Applications may register a new or different handler in the middle
  347.     * of a parse, and the SAX parser must begin using the new handler
  348.     * immediately.
  349.     *
  350.     * @param handler The DTD handler.
  351.     * @see DTDHandler#DTDHandler
  352.     * @see HandlerBase#HandlerBase
  353.     */
  354.     virtual void setDTDHandler(DTDHandler* const handler) = 0;
  355.   /**
  356.     * Allow an application to register a custom entity resolver.
  357.     *
  358.     * If the application does not register an entity resolver, the
  359.     * SAX parser will resolve system identifiers and open connections
  360.     * to entities itself (this is the default behaviour implemented in
  361.     * DefaultHandler).
  362.     *
  363.     * Applications may register a new or different entity resolver
  364.     * in the middle of a parse, and the SAX parser must begin using
  365.     * the new resolver immediately.
  366.     *
  367.     * @param resolver The object for resolving entities.
  368.     * @see EntityResolver#EntityResolver
  369.     * @see DefaultHandler#DefaultHandler
  370.     */
  371.     virtual void setEntityResolver(EntityResolver* const resolver) = 0;
  372.   /**
  373.     * Allow an application to register an error event handler.
  374.     *
  375.     * If the application does not register an error event handler,
  376.     * all error events reported by the SAX parser will be silently
  377.     * ignored, except for fatalError, which will throw a SAXException
  378.     * (this is the default behaviour implemented by HandlerBase).
  379.     *
  380.     * Applications may register a new or different handler in the
  381.     * middle of a parse, and the SAX parser must begin using the new
  382.     * handler immediately.
  383.     *
  384.     * @param handler The error handler.
  385.     * @see ErrorHandler#ErrorHandler
  386.     * @see SAXException#SAXException
  387.     * @see HandlerBase#HandlerBase
  388.     */
  389.     virtual void setErrorHandler(ErrorHandler* const handler) = 0;
  390.    /**
  391.     * Allow an application to register a lexical event handler.
  392.     *
  393.     * If the application does not register a lexical handler,
  394.     * all events reported by the SAX parser will be silently
  395.     * ignored. (this is the default behaviour implemented by HandlerBase).
  396.     *
  397.     * Applications may register a new or different handler in the
  398.     * middle of a parse, and the SAX parser must begin using the new
  399.     * handler immediately.
  400.     *
  401.     * @param handler The error handler.
  402.     * @see LexicalHandler#LexicalHandler
  403.     * @see SAXException#SAXException
  404.     * @see HandlerBase#HandlerBase
  405.     */
  406.     virtual void setLexicalHandler(LexicalHandler* const handler) = 0;
  407.     /**
  408.       * This method allows users to set the parser's behaviour when it
  409.       * encounters the first fatal error. If set to true, the parser
  410.       * will exit at the first fatal error. If false, then it will
  411.       * report the error and continue processing.
  412.       *
  413.       * <p>The default value is 'true' and the parser exits on the
  414.       * first fatal error.</p>
  415.       *
  416.       * @param newState The value specifying whether the parser should
  417.       *                 continue or exit when it encounters the first
  418.       *                 fatal error.
  419.       *
  420.       * @see #getExitOnFirstFatalError
  421.       */
  422.     virtual void setExitOnFirstFatalError(const bool newState) = 0;
  423.     /**
  424.       * This method allows users to set the parser's behaviour when it
  425.       * encounters a validtion constraint error. If set to true, and the
  426.       * the parser is set to exit when it encounter the first fatal error,
  427.       * the parser will exit at the first encounter. If false, then it will
  428.       * report the error and continue processing.
  429.       *
  430.       * <p>The default value is 'false'.</p>
  431.       *
  432.       * @param newState The value specifying whether the parser should
  433.       *                 continue or exit when it encounters a validation
  434.       *                 constraint error.
  435.       *
  436.       * @see #getValidationConstraintFatal
  437.       */
  438.     virtual void setValidationConstraintFatal(const bool newState) = 0;
  439.   /**
  440.     * Set the state of any feature in a SAX2 XMLReader.
  441.     * Supported features in SAX2 for xerces-c are:
  442.     * <br>(See http://xml.apache.org/xerces-c/program.html#SAX2Features for detail description).
  443.     *
  444.     * <br>http://xml.org/sax/features/validation (default: true)
  445.     * <br>http://xml.org/sax/features/namespaces (default: true)
  446.     * <br>http://xml.org/sax/features/namespace-prefixes (default: true)
  447.     * <br>http://apache.org/xml/features/validation/dynamic (default: false)
  448.     * <br>http://apache.org/xml/features/validation/reuse-grammar (default: false)
  449.     * <br>http://apache.org/xml/features/validation/schema (default: true)
  450.     * <br>http://apache.org/xml/features/validation/schema-full-checking (default: false)
  451.     * <br>http://apache.org/xml/features/validation/reuse-validator (Deprecated) (default: false)
  452.     *
  453.     * @param name The unique identifier (URI) of the feature.
  454.     * @param value The requested state of the feature (true or false).
  455.     * @exception SAXNotRecognizedException If the requested feature is not known.
  456.     * @exception SAXNotSupportedException Feature modification is not supported during parse
  457.     *
  458.     */
  459. virtual void setFeature(const XMLCh* const name, const bool value) = 0;
  460.   /**
  461.     * Set the value of any property in a SAX2 XMLReader.
  462.     * Supported properties in SAX2 for xerces-c are:
  463.     * <br>(See http://xml.apache.org/xerces-c/program.html#SAX2Properties for detail description).
  464.     *
  465.     * <br>http://apache.org/xml/properties/schema/external-schemaLocation
  466.     * <br>http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation.
  467.     *
  468.     * It takes a void pointer as the property value.  Application is required to initialize this void
  469.     * pointer to a correct type.  See http://xml.apache.org/xerces-c/program.html#SAX2Properties
  470.     * to learn exactly what type of property value each property expects for processing.
  471.     * Passing a void pointer that was initialized with a wrong type will lead to unexpected result.
  472.     * If the same property is set more than once, the last one takes effect.
  473.     *
  474.     * @param name The unique identifier (URI) of the property being set.
  475.     * @param value The requested value for the property.  See
  476.     *            http://xml.apache.org/xerces-c/program.html#SAX2Properties to learn
  477.     *            exactly what type of property value each property expects for processing.
  478.     *            Passing a void pointer that was initialized with a wrong type will lead
  479.     *            to unexpected result.
  480.     * @exception SAXNotRecognizedException If the requested property is not known.
  481.     * @exception SAXNotSupportedException Property modification is not supported during parse
  482.     */
  483. virtual void setProperty(const XMLCh* const name, void* value) = 0 ;
  484.     //@}
  485.     // -----------------------------------------------------------------------
  486.     //  Progressive scan methods
  487.     // -----------------------------------------------------------------------
  488.     /** @name Progressive scan methods */
  489.     //@{
  490.     /** Begin a progressive parse operation
  491.       *
  492.       * This method is used to start a progressive parse on a XML file.
  493.       * To continue parsing, subsequent calls must be to the parseNext
  494.       * method.
  495.       *
  496.       * It scans through the prolog and returns a token to be used on
  497.       * subsequent scanNext() calls. If the return value is true, then the
  498.       * token is legal and ready for further use. If it returns false, then
  499.       * the scan of the prolog failed and the token is not going to work on
  500.       * subsequent scanNext() calls.
  501.       *
  502.       * @param systemId A pointer to a Unicode string represting the path
  503.       *                 to the XML file to be parsed.
  504.       * @param toFill   A token maintaing state information to maintain
  505.       *                 internal consistency between invocation of 'parseNext'
  506.       *                 calls.
  507.       * @param reuseGrammar The flag indicating whether the existing Grammar
  508.       *                     should be reused or not for this parsing run.
  509.       *                     If true, there cannot be any internal subset.
  510.       *
  511.       * @return 'true', if successful in parsing the prolog. It indicates the
  512.       *         user can go ahead with parsing the rest of the file. It
  513.       *         returns 'false' to indicate that the parser could parse the
  514.       *         prolog (which means the token will not be valid.)
  515.       *
  516.       * @see #parseNext
  517.       * @see #parseFirst(char*,...)
  518.       * @see #parseFirst(InputSource&,...)
  519.       */
  520.     virtual bool parseFirst
  521.     (
  522.         const   XMLCh* const    systemId
  523.         ,       XMLPScanToken&  toFill
  524.         , const bool            reuseGrammar = false
  525.     ) = 0;
  526.     /** Begin a progressive parse operation
  527.       *
  528.       * This method is used to start a progressive parse on a XML file.
  529.       * To continue parsing, subsequent calls must be to the parseNext
  530.       * method.
  531.       *
  532.       * It scans through the prolog and returns a token to be used on
  533.       * subsequent scanNext() calls. If the return value is true, then the
  534.       * token is legal and ready for further use. If it returns false, then
  535.       * the scan of the prolog failed and the token is not going to work on
  536.       * subsequent scanNext() calls.
  537.       *
  538.       * @param systemId A pointer to a regular native string represting
  539.       *                 the path to the XML file to be parsed.
  540.       * @param toFill   A token maintaing state information to maintain
  541.       *                 internal consIstency between invocation of 'parseNext'
  542.       *                 calls.
  543.       * @param reuseGrammar The flag indicating whether the existing Grammar
  544.       *                     should be reused or not for this parsing run.
  545.       *                     If true, there cannot be any internal subset.
  546.       *
  547.       * @return 'true', if successful in parsing the prolog. It indicates the
  548.       *         user can go ahead with parsing the rest of the file. It
  549.       *         returns 'false' to indicate that the parser could not parse
  550.       *         the prolog.
  551.       *
  552.       * @see #parseNext
  553.       * @see #parseFirst(XMLCh*,...)
  554.       * @see #parseFirst(InputSource&,...)
  555.       */
  556.     virtual bool parseFirst
  557.     (
  558.         const   char* const     systemId
  559.         ,       XMLPScanToken&  toFill
  560.         , const bool            reuseGrammar = false
  561.     ) = 0;
  562.     /** Begin a progressive parse operation
  563.       *
  564.       * This method is used to start a progressive parse on a XML file.
  565.       * To continue parsing, subsequent calls must be to the parseNext
  566.       * method.
  567.       *
  568.       * It scans through the prolog and returns a token to be used on
  569.       * subsequent scanNext() calls. If the return value is true, then the
  570.       * token is legal and ready for further use. If it returns false, then
  571.       * the scan of the prolog failed and the token is not going to work on
  572.       * subsequent scanNext() calls.
  573.       *
  574.       * @param source   A const reference to the InputSource object which
  575.       *                 points to the XML file to be parsed.
  576.       * @param toFill   A token maintaing state information to maintain
  577.       *                 internal consistency between invocation of 'parseNext'
  578.       *                 calls.
  579.       * @param reuseGrammar The flag indicating whether the existing Grammar
  580.       *                     should be reused or not for this parsing run.
  581.       *                     If true, there cannot be any internal subset.
  582.       *
  583.       * @return 'true', if successful in parsing the prolog. It indicates the
  584.       *         user can go ahead with parsing the rest of the file. It
  585.       *         returns 'false' to indicate that the parser could not parse
  586.       *         the prolog.
  587.       *
  588.       * @see #parseNext
  589.       * @see #parseFirst(XMLCh*,...)
  590.       * @see #parseFirst(char*,...)
  591.       */
  592.     virtual bool parseFirst
  593.     (
  594.         const   InputSource&    source
  595.         ,       XMLPScanToken&  toFill
  596.         , const bool            reuseGrammar = false
  597.     ) = 0;
  598.     /** Continue a progressive parse operation
  599.       *
  600.       * This method is used to continue with progressive parsing of
  601.       * XML files started by a call to 'parseFirst' method.
  602.       *
  603.       * It parses the XML file and stops as soon as it comes across
  604.       * a XML token (as defined in the XML specification). Relevant
  605.       * callback handlers are invoked as required by the SAX
  606.       * specification.
  607.       *
  608.       * @param token A token maintaing state information to maintain
  609.       *              internal consistency between invocation of 'parseNext'
  610.       *              calls.
  611.       *
  612.       * @return 'true', if successful in parsing the next XML token.
  613.       *         It indicates the user can go ahead with parsing the rest
  614.       *         of the file. It returns 'false' to indicate that the parser
  615.       *         could not find next token as per the XML specification
  616.       *         production rule.
  617.       *
  618.       * @see #parseFirst(XMLCh*,...)
  619.       * @see #parseFirst(char*,...)
  620.       * @see #parseFirst(InputSource&,...)
  621.       */
  622.     virtual bool parseNext(XMLPScanToken& token) = 0;
  623.     /** Reset the parser after a progressive parse
  624.       *
  625.       * If a progressive parse loop exits before the end of the document
  626.       * is reached, the parser has no way of knowing this. So it will leave
  627.       * open any files or sockets or memory buffers that were in use at
  628.       * the time that the parse loop exited.
  629.       *
  630.       * The next parse operation will cause these open files and such to
  631.       * be closed, but the next parse operation might occur at some unknown
  632.       * future point. To avoid this problem, you should reset the parser if
  633.       * you exit the loop early.
  634.       *
  635.       * If you exited because of an error, then this cleanup will be done
  636.       * for you. Its only when you exit the file prematurely of your own
  637.       * accord, because you've found what you wanted in the file most
  638.       * likely.
  639.       *
  640.       * @param token A token maintaing state information to maintain
  641.       *              internal consistency between invocation of 'parseNext'
  642.       *              calls.
  643.       */
  644.     virtual void parseReset(XMLPScanToken& token) = 0;
  645.     //@}
  646.     // -----------------------------------------------------------------------
  647.     //  Validator: setters and getters
  648.     // -----------------------------------------------------------------------
  649.     /** @name Validator: setters and getters (Xerces-C specific) */
  650.     //@{
  651.     /**
  652.   * This method is used to set a validator.
  653.   *
  654.   * <b>SAX2XMLReader assumes responsibility for the validator.  It will be
  655.   * deleted when the XMLReader is destroyed.</b>
  656.   *
  657.   * @param valueToAdopt A pointer to the validator that the reader should use.
  658.   *
  659.   */
  660. virtual void setValidator(XMLValidator* valueToAdopt) = 0;
  661.     /**
  662.   * This method is used to get the current validator.
  663.   *
  664.   * <b>SAX2XMLReader assumes responsibility for the validator.  It will be
  665.   * deleted when the XMLReader is destroyed.</b>
  666.   *
  667.   * @return A pointer to the validator.  An application should not deleted
  668.   * the object returned.
  669.   *
  670.   */
  671. virtual XMLValidator* getValidator() const = 0;
  672.     //@}
  673.     // -----------------------------------------------------------------------
  674.     //  Advanced document handler list maintenance methods
  675.     // -----------------------------------------------------------------------
  676.     /** @name Advanced document handler list maintenance methods */
  677.     //@{
  678.     /**
  679.       * This method installs the specified 'advanced' document callback
  680.       * handler, thereby allowing the user to customize the processing,
  681.       * if they choose to do so. Any number of advanced callback handlers
  682.       * maybe installed.
  683.       *
  684.       * <p>The methods in the advanced callback interface represent
  685.       * Xerces-C extensions. There is no specification for this interface.</p>
  686.       *
  687.       * @param toInstall A pointer to the users advanced callback handler.
  688.       *
  689.       * @see #removeAdvDocHandler
  690.       */
  691.     virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall) = 0;
  692.     /**
  693.       * This method removes the 'advanced' document handler callback from
  694.       * the underlying parser scanner. If no handler is installed, advanced
  695.       * callbacks are not invoked by the scanner.
  696.       * @param toRemove A pointer to the advanced callback handler which
  697.       *                 should be removed.
  698.       *
  699.       * @see #installAdvDocHandler
  700.       */
  701.     virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove) = 0;
  702.     //@}
  703. private :
  704.     /* The copy constructor, you cannot call this directly */
  705.     SAX2XMLReader(const SAX2XMLReader&);
  706.     /* The assignment operator, you cannot call this directly */
  707.     void operator=(const SAX2XMLReader&);
  708. };
  709. #endif