XercesDOMParser.hpp Source File

| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XercesDOMParser.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 2001-2002 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) 2001, 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  * $Id: XercesDOMParser.hpp,v 1.14 2003/05/15 18:26:50 knoaman Exp $
    00059  *
    00060  */
    00061
    00062 #if !defined(XercesDOMParser_HPP)
    00063 #define XercesDOMParser_HPP
    00064
    00065
    00066 #include <xercesc/parsers/AbstractDOMParser.hpp>
    00067
    00068 XERCES_CPP_NAMESPACE_BEGIN
    00069
    00070
    00071 class EntityResolver;
    00072 class ErrorHandler;
    00073 class Grammar;
    00074
    00075
    00086 class  XercesDOMParser : public AbstractDOMParser
    00087 {
    00088 public :
    00089     // -----------------------------------------------------------------------
    00090     //  Constructors and Detructor
    00091     // -----------------------------------------------------------------------
    00092
    00104     XercesDOMParser
    00105     (
    00106           XMLValidator* const  valToAdopt = 0
    00107         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00108     );
    00109
    00113     virtual ~XercesDOMParser();
    00114
    00116
    00117
    00118     // -----------------------------------------------------------------------
    00119     //  Getter methods
    00120     // -----------------------------------------------------------------------
    00121
    00124
    00132     ErrorHandler* getErrorHandler();
    00133
    00141     const ErrorHandler* getErrorHandler() const;
    00142
    00150     EntityResolver* getEntityResolver();
    00151
    00159     const EntityResolver* getEntityResolver() const;
    00160
    00171     bool isCachingGrammarFromParse() const;
    00172
    00183     bool isUsingCachedGrammarInParse() const;
    00184
    00191     Grammar* getGrammar(const XMLCh* const nameSpaceKey);
    00192
    00198     Grammar* getRootGrammar();
    00199
    00206     const XMLCh* getURIText(unsigned int uriId) const;
    00207
    00213     unsigned int getSrcOffset() const;
    00214
    00216
    00217
    00218     // -----------------------------------------------------------------------
    00219     //  Setter methods
    00220     // -----------------------------------------------------------------------
    00221
    00224
    00238     void setErrorHandler(ErrorHandler* const handler);
    00239
    00255     void setEntityResolver(EntityResolver* const handler);
    00256
    00274     void cacheGrammarFromParse(const bool newState);
    00275
    00294     void useCachedGrammarInParse(const bool newState);
    00295
    00297
    00298     // -----------------------------------------------------------------------
    00299     //  Utility methods
    00300     // -----------------------------------------------------------------------
    00301
    00327     void resetDocumentPool();
    00328
    00330
    00331     // -----------------------------------------------------------------------
    00332     //  Implementation of the XMLErrorReporter interface.
    00333     // -----------------------------------------------------------------------
    00334
    00337
    00362     virtual void error
    00363     (
    00364         const   unsigned int                errCode
    00365         , const XMLCh* const                msgDomain
    00366         , const XMLErrorReporter::ErrTypes  errType
    00367         , const XMLCh* const                errorText
    00368         , const XMLCh* const                systemId
    00369         , const XMLCh* const                publicId
    00370         , const XMLSSize_t                  lineNum
    00371         , const XMLSSize_t                  colNum
    00372     );
    00373
    00382     virtual void resetErrors();
    00384
    00385
    00386     // -----------------------------------------------------------------------
    00387     //  Implementation of the XMLEntityHandler interface.
    00388     // -----------------------------------------------------------------------
    00389
    00392
    00405     virtual void endInputSource(const InputSource& inputSource);
    00406
    00422     virtual bool expandSystemId
    00423     (
    00424         const   XMLCh* const    systemId
    00425         ,       XMLBuffer&      toFill
    00426     );
    00427
    00436     virtual void resetEntities();
    00437
    00459     virtual InputSource* resolveEntity
    00460     (
    00461         const   XMLCh* const    publicId
    00462         , const XMLCh* const    systemId
    00463         , const XMLCh* const    baseURI = 0
    00464     );
    00465
    00478     virtual void startInputSource(const InputSource& inputSource);
    00479
    00481
    00482     // -----------------------------------------------------------------------
    00483     //  Grammar preparsing interface
    00484     // -----------------------------------------------------------------------
    00485
    00515     Grammar* loadGrammar(const InputSource& source,
    00516                          const short grammarType,
    00517                          const bool toCache = false);
    00518
    00544     Grammar* loadGrammar(const XMLCh* const systemId,
    00545                          const short grammarType,
    00546                          const bool toCache = false);
    00547
    00572     Grammar* loadGrammar(const char* const systemId,
    00573                          const short grammarType,
    00574                          const bool toCache = false);
    00575
    00579     void resetCachedGrammarPool();
    00580
    00582
    00583
    00584 private :
    00585     // -----------------------------------------------------------------------
    00586     //  Private data members
    00587     //
    00588     //  fEntityResolver
    00589     //      The installed SAX entity resolver, if any. Null if none.
    00590     //
    00591     //  fErrorHandler
    00592     //      The installed SAX error handler, if any. Null if none.
    00593     //-----------------------------------------------------------------------
    00594     EntityResolver*          fEntityResolver;
    00595     ErrorHandler*            fErrorHandler;
    00596 };
    00597
    00598
    00599
    00600 // ---------------------------------------------------------------------------
    00601 //  XercesDOMParser: Handlers for the XMLEntityHandler interface
    00602 // ---------------------------------------------------------------------------
    00603 inline void XercesDOMParser::endInputSource(const InputSource&)
    00604 {
    00605     // The DOM entity resolver doesn't handle this
    00606 }
    00607
    00608 inline bool XercesDOMParser::expandSystemId(const XMLCh* const, XMLBuffer&)
    00609 {
    00610     // The DOM entity resolver doesn't handle this
    00611     return false;
    00612 }
    00613
    00614 inline void XercesDOMParser::resetEntities()
    00615 {
    00616     // Nothing to do on this one
    00617 }
    00618
    00619 inline void XercesDOMParser::startInputSource(const InputSource&)
    00620 {
    00621     // The DOM entity resolver doesn't handle this
    00622 }
    00623
    00624
    00625 // ---------------------------------------------------------------------------
    00626 //  XercesDOMParser: Getter methods
    00627 // ---------------------------------------------------------------------------
    00628 inline ErrorHandler* XercesDOMParser::getErrorHandler()
    00629 {
    00630     return fErrorHandler;
    00631 }
    00632
    00633 inline const ErrorHandler* XercesDOMParser::getErrorHandler() const
    00634 {
    00635     return fErrorHandler;
    00636 }
    00637
    00638 inline EntityResolver* XercesDOMParser::getEntityResolver()
    00639 {
    00640     return fEntityResolver;
    00641 }
    00642
    00643 inline const EntityResolver* XercesDOMParser::getEntityResolver() const
    00644 {
    00645     return fEntityResolver;
    00646 }
    00647
    00648
    00649 XERCES_CPP_NAMESPACE_END
    00650
    00651 #endif

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