DOMBuilder.hpp

Go to the documentation of this file.

#ifndef DOMBuilder_HEADER_GUARD_
#define DOMBuilder_HEADER_GUARD_

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * $Id: DOMBuilder.hpp 568078 2007-08-21 11:43:25Z amassari $
 *
 */


#include <xercesc/util/XercesDefs.hpp>

XERCES_CPP_NAMESPACE_BEGIN


class DOMErrorHandler;
class DOMEntityResolver;
class DOMInputSource;
class DOMBuilderFilter;
class DOMNode;
class DOMDocument;
class Grammar;

class CDOM_EXPORT DOMBuilder
{
protected :
    // -----------------------------------------------------------------------
    //  Hidden constructors
    // -----------------------------------------------------------------------
    DOMBuilder() {};

private:    
    // -----------------------------------------------------------------------
    // Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    DOMBuilder(const DOMBuilder &);
    DOMBuilder & operator = (const DOMBuilder &);

public:
    // -----------------------------------------------------------------------
    //  All constructors are hidden, just the destructor is available
    // -----------------------------------------------------------------------
    virtual ~DOMBuilder() {};

    // -----------------------------------------------------------------------
    //  Class types
    // -----------------------------------------------------------------------
    enum ActionType
    {
        ACTION_REPLACE            = 1,
        ACTION_APPEND_AS_CHILDREN = 2,
        ACTION_INSERT_AFTER       = 3,
        ACTION_INSERT_BEFORE      = 4
    };

    // -----------------------------------------------------------------------
    //  Virtual DOMBuilder interface
    // -----------------------------------------------------------------------

    // -----------------------------------------------------------------------
    //  Getter methods
    // -----------------------------------------------------------------------

    virtual DOMErrorHandler* getErrorHandler() = 0;

    virtual const DOMErrorHandler* getErrorHandler() const = 0;

    virtual DOMEntityResolver* getEntityResolver() = 0;

    virtual const DOMEntityResolver* getEntityResolver() const = 0;

    virtual DOMBuilderFilter* getFilter() = 0;

    virtual const DOMBuilderFilter* getFilter() const = 0;

    // -----------------------------------------------------------------------
    //  Setter methods
    // -----------------------------------------------------------------------
    virtual void setErrorHandler(DOMErrorHandler* const handler) = 0;

    virtual void setEntityResolver(DOMEntityResolver* const handler) = 0;

    virtual void setFilter(DOMBuilderFilter* const filter) = 0;

    // -----------------------------------------------------------------------
    //  Feature methods
    // -----------------------------------------------------------------------
    virtual void setFeature(const XMLCh* const name, const bool state) = 0;

    virtual bool getFeature(const XMLCh* const name) const = 0;

    virtual bool canSetFeature(const XMLCh* const name, const bool state) const = 0;

    // -----------------------------------------------------------------------
    //  Parsing methods
    // -----------------------------------------------------------------------
    virtual DOMDocument* parse(const DOMInputSource& source) = 0;

    virtual DOMDocument* parseURI(const XMLCh* const systemId) = 0;

    virtual DOMDocument* parseURI(const char* const systemId) = 0;

    virtual void parseWithContext
    (
        const   DOMInputSource& source
        ,       DOMNode* const contextNode
        , const short action
    ) = 0;

    // -----------------------------------------------------------------------
    //  Non-standard Extension
    // -----------------------------------------------------------------------

    virtual void* getProperty(const XMLCh* const name) const = 0 ;

    virtual void setProperty(const XMLCh* const name, void* value) = 0 ;

    virtual void              release() = 0;

    virtual void              resetDocumentPool() = 0;

    virtual Grammar* loadGrammar(const DOMInputSource& 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 Grammar* getGrammar(const XMLCh* const nameSpaceKey) const = 0;

    virtual Grammar* getRootGrammar() const = 0;

    virtual const XMLCh* getURIText(unsigned int uriId) const = 0;

    virtual void resetCachedGrammarPool() = 0;

    virtual unsigned int getSrcOffset() const = 0;


};


XERCES_CPP_NAMESPACE_END

#endif

---