API Docs for SAX and DOM                 SAX2XMLReader.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2001 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Log: SAX2XMLReader.hpp,v $ * Revision 1.10 2003/03/07 18:10:30 tng * Return a reference instead of void for operator= * * Revision 1.9 2003/01/09 19:07:27 tng * [Bug 15802] Add "const" qualifier to getURIText. * * Revision 1.8 2002/12/23 15:23:18 knoaman * Added a public api to various parsers to return the src offset within the input * source. * * Revision 1.7 2002/11/04 14:55:45 tng * C++ Namespace Support. * * Revision 1.6 2002/07/11 18:29:09 knoaman * Grammar caching/preparsing - initial implementation. * * Revision 1.5 2002/07/04 15:35:44 tng * API Documentation typo fix. * * Revision 1.4 2002/06/27 18:46:53 tng * API Documentation Update. * * Revision 1.3 2002/06/17 15:39:49 tng * To be consistent, SAX2 is updated with: * 1. the progressive parse methods should use the fReuseGrammar flag set from setFeature instead of using parameter * 2. add feature "http://apache.org/xml/features/continue-after-fatal-error", and users should use setFeature instead of setExitOnFirstFatalError * 3. add feature "http://apache.org/xml/features/validation-error-as-fatal", and users should use setFeature instead of setValidationConstraintFatal * * Revision 1.2 2002/05/30 16:22:53 tng * Add feature to optionally ignore external DTD. * * Revision 1.1.1.1 2002/02/01 22:22:09 peiyongz * sane_include * * Revision 1.18 2002/01/28 18:45:40 knoaman * Update documentation for SAX2 feature 'namespace-prefixes'. * * Revision 1.17 2002/01/28 17:08:33 knoaman * SAX2-ext's DeclHandler support. * * Revision 1.16 2002/01/18 16:31:26 tng * Break program.xml which takes too long to load, into program-sax.xml, program-sax2.xml, program-dom.xml, program-idom.xml. * * Revision 1.15 2002/01/02 15:36:54 tng * Some documentation update. * * Revision 1.14 2001/11/20 18:51:44 tng * 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). * * Revision 1.13 2001/11/14 14:15:59 tng * Update SAX2 feature documentation. * * Revision 1.12 2001/09/12 13:03:43 tng * [Bug 3155] SAX2 does not offer progressive parse. * * Revision 1.11 2001/08/01 19:11:02 tng * Add full schema constraint checking flag to the samples and the parser. * * Revision 1.10 2001/06/27 17:40:16 knoaman * Fix for bug #2353. * * Revision 1.9 2001/06/19 16:44:31 tng * Add installAdvDocHandler to SAX2XMLReader as the code is there already. * * Revision 1.8 2001/06/04 21:03:07 jberry * Add pure virtual getErrorCount to SAX2XMLReader interface. * * Revision 1.7 2001/05/11 13:26:25 tng * Copyright update. * * Revision 1.6 2001/02/15 15:56:31 tng * Schema: Add setSchemaValidation and getSchemaValidation for DOMParser and SAXParser. * Add feature "http://apache.org/xml/features/validation/schema" for SAX2XMLReader. * New data field fSchemaValidation in XMLScanner as the flag. * * Revision 1.5 2001/01/12 21:22:00 tng * Documentation Enhancement: Add list of SAX2 feature strings that are supported. * * Revision 1.4 2000/12/22 15:17:04 tng * SAX2-ext's LexicalHandler support added by David Bertoni. * * Revision 1.3 2000/08/09 22:19:29 jpolast * many conformance & stability changes: * - ContentHandler::resetDocument() removed * - attrs param of ContentHandler::startDocument() made const * - SAXExceptions thrown now have msgs * - removed duplicate function signatures that had 'const' * [ eg: getContentHander() ] * - changed getFeature and getProperty to apply to const objs * - setProperty now takes a void* instead of const void* * - SAX2XMLReaderImpl does not inherit from SAXParser anymore * - Reuse Validator (http://apache.org/xml/features/reuse-validator) implemented * - Features & Properties now read-only during parse * * Revision 1.2 2000/08/07 18:21:27 jpolast * change module to * * Revision 1.1 2000/08/02 18:02:35 jpolast * initial checkin of sax2 implementation * submitted by Simon Fell (simon@fell.com) * and Joe Polastre (jpolast@apache.org) * * */ #ifndef SAX2XMLReader_HPP #define SAX2XMLReader_HPP #include <xercesc/util/XercesDefs.hpp> #include <xercesc/util/XMLUniDefs.hpp> #include <xercesc/framework/XMLValidator.hpp> #include <xercesc/framework/XMLPScanToken.hpp> XERCES_CPP_NAMESPACE_BEGIN class ContentHandler ; class DTDHandler; class EntityResolver; class ErrorHandler; class InputSource; class LexicalHandler; class DeclHandler; class XMLDocumentHandler; class Grammar; class SAX2XMLReader { public: // ----------------------------------------------------------------------- // Class types // ----------------------------------------------------------------------- enum ValSchemes { Val_Never , Val_Always , Val_Auto }; // ----------------------------------------------------------------------- // Constructors and Destructor // ----------------------------------------------------------------------- SAX2XMLReader() { } virtual ~SAX2XMLReader() { } //----------------------------------------------------------------------- // The XMLReader interface //----------------------------------------------------------------------- virtual ContentHandler* getContentHandler() const = 0 ; virtual DTDHandler* getDTDHandler() const = 0; virtual EntityResolver* getEntityResolver() const = 0 ; virtual ErrorHandler* getErrorHandler() const = 0 ; virtual bool getFeature(const XMLCh* const name) const = 0; virtual void* getProperty(const XMLCh* const name) const = 0 ; virtual void setContentHandler(ContentHandler* const handler) = 0; virtual void setDTDHandler(DTDHandler* const handler) = 0; virtual void setEntityResolver(EntityResolver* const resolver) = 0; virtual void setErrorHandler(ErrorHandler* const handler) = 0; virtual void setFeature(const XMLCh* const name, const bool value) = 0; virtual void setProperty(const XMLCh* const name, void* value) = 0 ; virtual void parse ( const InputSource& source ) = 0; virtual void parse ( const XMLCh* const systemId ) = 0; virtual void parse ( const char* const systemId ) = 0; // ----------------------------------------------------------------------- // SAX 2.0-ext // ----------------------------------------------------------------------- virtual DeclHandler* getDeclarationHandler() const = 0 ; virtual LexicalHandler* getLexicalHandler() const = 0 ; virtual void setDeclarationHandler(DeclHandler* const handler) = 0; virtual void setLexicalHandler(LexicalHandler* const handler) = 0; // ----------------------------------------------------------------------- // Getter Methods // ----------------------------------------------------------------------- virtual XMLValidator* getValidator() const = 0; virtual int getErrorCount() const = 0 ; virtual bool getExitOnFirstFatalError() const = 0; virtual bool getValidationConstraintFatal() const = 0; virtual Grammar* getGrammar(const XMLCh* const nameSpaceKey) = 0; virtual Grammar* getRootGrammar() = 0; virtual const XMLCh* getURIText(unsigned int uriId) const = 0; virtual unsigned int getSrcOffset() const = 0; // ----------------------------------------------------------------------- // Setter Methods // ----------------------------------------------------------------------- virtual void setValidator(XMLValidator* valueToAdopt) = 0; virtual void setExitOnFirstFatalError(const bool newState) = 0; virtual void setValidationConstraintFatal(const bool newState) = 0; // ----------------------------------------------------------------------- // Progressive scan methods // ----------------------------------------------------------------------- virtual bool parseFirst ( const XMLCh* const systemId , XMLPScanToken& toFill ) = 0; virtual bool parseFirst ( const char* const systemId , XMLPScanToken& toFill ) = 0; virtual bool parseFirst ( const InputSource& source , XMLPScanToken& toFill ) = 0; virtual bool parseNext(XMLPScanToken& token) = 0; virtual void parseReset(XMLPScanToken& token) = 0; // ----------------------------------------------------------------------- // Grammar preparsing interface // ----------------------------------------------------------------------- virtual Grammar* loadGrammar(const InputSource& source, const short grammarType, const bool toCache = false) = 0; virtual Grammar* loadGrammar(const XMLCh* const systemId, const short grammarType, const bool toCache = false) = 0; virtual Grammar* loadGrammar(const char* const systemId, const short grammarType, const bool toCache = false) = 0; virtual void resetCachedGrammarPool() = 0; // ----------------------------------------------------------------------- // Advanced document handler list maintenance methods // ----------------------------------------------------------------------- virtual void installAdvDocHandler(XMLDocumentHandler* const toInstall) = 0; virtual bool removeAdvDocHandler(XMLDocumentHandler* const toRemove) = 0; private : /* The copy constructor, you cannot call this directly */ SAX2XMLReader(const SAX2XMLReader&); /* The assignment operator, you cannot call this directly */ SAX2XMLReader& operator=(const SAX2XMLReader&); }; XERCES_CPP_NAMESPACE_END #endif

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