API Docs for SAX and DOM                 XercesDOMParser.hpp Go to the documentation of this file. /* * The Apache Software License, Version 1.1 * * Copyright (c) 2001-2002 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) 2001, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * $Id: XercesDOMParser.hpp,v 1.17 2003/12/01 23:23:26 neilg Exp $ * */ #if !defined(XercesDOMParser_HPP) #define XercesDOMParser_HPP #include <xercesc/parsers/AbstractDOMParser.hpp> XERCES_CPP_NAMESPACE_BEGIN class EntityResolver; class ErrorHandler; class Grammar; class XMLEntityResolver; class XMLResourceIdentifier; class XercesDOMParser : public AbstractDOMParser { public : // ----------------------------------------------------------------------- // Constructors and Detructor // ----------------------------------------------------------------------- XercesDOMParser ( XMLValidator* const valToAdopt = 0 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager , XMLGrammarPool* const gramPool = 0 ); virtual ~XercesDOMParser(); // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- ErrorHandler* getErrorHandler(); const ErrorHandler* getErrorHandler() const; EntityResolver* getEntityResolver(); const EntityResolver* getEntityResolver() const; XMLEntityResolver* getXMLEntityResolver(); const XMLEntityResolver* getXMLEntityResolver() const; bool isCachingGrammarFromParse() const; bool isUsingCachedGrammarInParse() const; Grammar* getGrammar(const XMLCh* const nameSpaceKey); Grammar* getRootGrammar(); const XMLCh* getURIText(unsigned int uriId) const; unsigned int getSrcOffset() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setErrorHandler(ErrorHandler* const handler); void setEntityResolver(EntityResolver* const handler); void setXMLEntityResolver(XMLEntityResolver* const handler); void cacheGrammarFromParse(const bool newState); void useCachedGrammarInParse(const bool newState); // ----------------------------------------------------------------------- // Utility methods // ----------------------------------------------------------------------- void resetDocumentPool(); // ----------------------------------------------------------------------- // Implementation of the XMLErrorReporter interface. // ----------------------------------------------------------------------- virtual void error ( const unsigned int errCode , const XMLCh* const msgDomain , const XMLErrorReporter::ErrTypes errType , const XMLCh* const errorText , const XMLCh* const systemId , const XMLCh* const publicId , const XMLSSize_t lineNum , const XMLSSize_t colNum ); virtual void resetErrors(); // ----------------------------------------------------------------------- // Implementation of the XMLEntityHandler interface. // ----------------------------------------------------------------------- virtual void endInputSource(const InputSource& inputSource); virtual bool expandSystemId ( const XMLCh* const systemId , XMLBuffer& toFill ); virtual void resetEntities(); virtual InputSource* resolveEntity ( const XMLCh* const publicId , const XMLCh* const systemId , const XMLCh* const baseURI = 0 ); virtual InputSource* resolveEntity ( XMLResourceIdentifier* resourceIdentifier ); virtual void startInputSource(const InputSource& inputSource); // ----------------------------------------------------------------------- // Grammar preparsing interface // ----------------------------------------------------------------------- Grammar* loadGrammar(const InputSource& source, const short grammarType, const bool toCache = false); Grammar* loadGrammar(const XMLCh* const systemId, const short grammarType, const bool toCache = false); Grammar* loadGrammar(const char* const systemId, const short grammarType, const bool toCache = false); void resetCachedGrammarPool(); private : // ----------------------------------------------------------------------- // Private data members // // fEntityResolver // The installed SAX entity resolver, if any. Null if none. // // fErrorHandler // The installed SAX error handler, if any. Null if none. //----------------------------------------------------------------------- EntityResolver* fEntityResolver; XMLEntityResolver* fXMLEntityResolver; ErrorHandler* fErrorHandler; }; // --------------------------------------------------------------------------- // XercesDOMParser: Handlers for the XMLEntityHandler interface // --------------------------------------------------------------------------- inline void XercesDOMParser::endInputSource(const InputSource&) { // The DOM entity resolver doesn't handle this } inline bool XercesDOMParser::expandSystemId(const XMLCh* const, XMLBuffer&) { // The DOM entity resolver doesn't handle this return false; } inline void XercesDOMParser::resetEntities() { // Nothing to do on this one } inline void XercesDOMParser::startInputSource(const InputSource&) { // The DOM entity resolver doesn't handle this } // --------------------------------------------------------------------------- // XercesDOMParser: Getter methods // --------------------------------------------------------------------------- inline ErrorHandler* XercesDOMParser::getErrorHandler() { return fErrorHandler; } inline const ErrorHandler* XercesDOMParser::getErrorHandler() const { return fErrorHandler; } inline EntityResolver* XercesDOMParser::getEntityResolver() { return fEntityResolver; } inline const EntityResolver* XercesDOMParser::getEntityResolver() const { return fEntityResolver; } inline XMLEntityResolver* XercesDOMParser::getXMLEntityResolver() { return fXMLEntityResolver; } inline const XMLEntityResolver* XercesDOMParser::getXMLEntityResolver() const { return fXMLEntityResolver; } XERCES_CPP_NAMESPACE_END #endif

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