| API Docs for SAX and DOM |

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

# DOMBuilder.hpp

Go to the documentation of this file.

    00001 #ifndef DOMBuilder_HEADER_GUARD_
    00002 #define DOMBuilder_HEADER_GUARD_
    00003
    00004 /*
    00005  * The Apache Software License, Version 1.1
    00006  *
    00007  * Copyright (c) 2002 The Apache Software Foundation.  All rights
    00008  * reserved.
    00009  *
    00010  * Redistribution and use in source and binary forms, with or without
    00011  * modification, are permitted provided that the following conditions
    00012  * are met:
    00013  *
    00014  * 1. Redistributions of source code must retain the above copyright
    00015  *    notice, this list of conditions and the following disclaimer.
    00016  *
    00017  * 2. Redistributions in binary form must reproduce the above copyright
    00018  *    notice, this list of conditions and the following disclaimer in
    00019  *    the documentation and/or other materials provided with the
    00020  *    distribution.
    00021  *
    00022  * 3. The end-user documentation included with the redistribution,
    00023  *    if any, must include the following acknowledgment:
    00024  *       "This product includes software developed by the
    00025  *        Apache Software Foundation (http://www.apache.org/)."
    00026  *    Alternately, this acknowledgment may appear in the software itself,
    00027  *    if and wherever such third-party acknowledgments normally appear.
    00028  *
    00029  * 4. The names "Xerces" and "Apache Software Foundation" must
    00030  *    not be used to endorse or promote products derived from this
    00031  *    software without prior written permission. For written
    00032  *    permission, please contact apache\@apache.org.
    00033  *
    00034  * 5. Products derived from this software may not be called "Apache",
    00035  *    nor may "Apache" appear in their name, without prior written
    00036  *    permission of the Apache Software Foundation.
    00037  *
    00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00049  * SUCH DAMAGE.
    00050  * ====================================================================
    00051  *
    00052  * This software consists of voluntary contributions made by many
    00053  * individuals on behalf of the Apache Software Foundation, and was
    00054  * originally based on software copyright (c) 2001, International
    00055  * Business Machines, Inc., http://www.ibm.com .  For more information
    00056  * on the Apache Software Foundation, please see
    00057  * <http://www.apache.org/>.
    00058  */
    00059
    00060 /*
    00061  * $Id: DOMBuilder.hpp,v 1.8 2002/08/22 15:04:57 tng Exp $
    00062  *
    00063  */
    00064
    00065
    00066 #include <xercesc/util/XercesDefs.hpp>
    00067
    00068 class DOMErrorHandler;
    00069 class DOMEntityResolver;
    00070 class DOMInputSource;
    00071 class DOMBuilderFilter;
    00072 class DOMNode;
    00073 class DOMDocument;
    00074 class Grammar;
    00075
    00086 class  DOMBuilder
    00087 {
    00088 protected :
    00089     // -----------------------------------------------------------------------
    00090     //  Hidden constructors
    00091     // -----------------------------------------------------------------------
    00094     DOMBuilder() {};
    00095     DOMBuilder(const DOMBuilder &) {};
    00096     DOMBuilder & operator = (const DOMBuilder &) {return *this;};
    00098
    00099 public:
    00100     // -----------------------------------------------------------------------
    00101     //  All constructors are hidden, just the destructor is available
    00102     // -----------------------------------------------------------------------
    00105
    00109     virtual ~DOMBuilder() {};
    00111
    00112     // -----------------------------------------------------------------------
    00113     //  Class types
    00114     // -----------------------------------------------------------------------
    00117
    00144     enum ActionType
    00145     {
    00146         ACTION_REPLACE            = 1,
    00147         ACTION_APPEND_AS_CHILDREN = 2,
    00148         ACTION_INSERT_AFTER       = 3,
    00149         ACTION_INSERT_BEFORE      = 4
    00150     };
    00152
    00153     // -----------------------------------------------------------------------
    00154     //  Virtual DOMBuilder interface
    00155     // -----------------------------------------------------------------------
    00158
    00159     // -----------------------------------------------------------------------
    00160     //  Getter methods
    00161     // -----------------------------------------------------------------------
    00162
    00174     virtual DOMErrorHandler* getErrorHandler() = 0;
    00175
    00187     virtual const DOMErrorHandler* getErrorHandler() const = 0;
    00188
    00200     virtual DOMEntityResolver* getEntityResolver() = 0;
    00201
    00213     virtual const DOMEntityResolver* getEntityResolver() const = 0;
    00214
    00226     virtual DOMBuilderFilter* getFilter() = 0;
    00227
    00239     virtual const DOMBuilderFilter* getFilter() const = 0;
    00240
    00241     // -----------------------------------------------------------------------
    00242     //  Setter methods
    00243     // -----------------------------------------------------------------------
    00261     virtual void setErrorHandler(DOMErrorHandler* const handler) = 0;
    00262
    00282     virtual void setEntityResolver(DOMEntityResolver* const handler) = 0;
    00283
    00305     virtual void setFilter(DOMBuilderFilter* const filter) = 0;
    00306
    00307     // -----------------------------------------------------------------------
    00308     //  Feature methods
    00309     // -----------------------------------------------------------------------
    00333     virtual void setFeature(const XMLCh* const name, const bool state) = 0;
    00334
    00350     virtual bool getFeature(const XMLCh* const name) const = 0;
    00351
    00368     virtual bool canSetFeature(const XMLCh* const name, const bool state) const = 0;
    00369
    00370     // -----------------------------------------------------------------------
    00371     //  Parsing methods
    00372     // -----------------------------------------------------------------------
    00403     virtual DOMDocument* parse(const DOMInputSource& source) = 0;
    00404
    00432     virtual DOMDocument* parseURI(const XMLCh* const systemId) = 0;
    00433
    00460     virtual DOMDocument* parseURI(const char* const systemId) = 0;
    00461
    00490     virtual void parseWithContext
    00491     (
    00492         const   DOMInputSource& source
    00493         ,       DOMNode* const contextNode
    00494         , const short action
    00495     ) = 0;
    00497
    00498     // -----------------------------------------------------------------------
    00499     //  Non-standard Extension
    00500     // -----------------------------------------------------------------------
    00503
    00525     virtual void* getProperty(const XMLCh* const name) const = 0 ;
    00526
    00548     virtual void setProperty(const XMLCh* const name, void* value) = 0 ;
    00549
    00556     virtual void              release() = 0;
    00557
    00581     virtual void              resetDocumentPool() = 0;
    00582
    00610     virtual Grammar* loadGrammar(const DOMInputSource& source,
    00611                                  const short grammarType,
    00612                                  const bool toCache = false) = 0;
    00613
    00639     virtual Grammar* loadGrammar(const XMLCh* const systemId,
    00640                                  const short grammarType,
    00641                                  const bool toCache = false) = 0;
    00642
    00668     virtual Grammar* loadGrammar(const char* const systemId,
    00669                                  const short grammarType,
    00670                                  const bool toCache = false) = 0;
    00671
    00678     virtual Grammar* getGrammar(const XMLCh* const nameSpaceKey) const = 0;
    00679
    00685     virtual Grammar* getRootGrammar() const = 0;
    00686
    00693     virtual const XMLCh* getURIText(unsigned int uriId) const = 0;
    00694
    00698     virtual void resetCachedGrammarPool() = 0;
    00699
    00701
    00702 };
    00703
    00704
    00705 #endif

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