XMLSchemaDescription.hpp

Go to the documentation of this file.

/*
 * 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: XMLSchemaDescription.hpp 527149 2007-04-10 14:56:39Z amassari $
 */

#if !defined(XERCESC_INCLUDE_GUARD_XMLSCHEMADESCRIPTION_HPP)
#define XERCESC_INCLUDE_GUARD_XMLSCHEMADESCRIPTION_HPP

#include <xercesc/framework/XMLGrammarDescription.hpp>
#include <xercesc/util/RefArrayVectorOf.hpp>

XERCES_CPP_NAMESPACE_BEGIN

typedef const XMLCh* const LocationHint;

class XMLPARSER_EXPORT XMLSchemaDescription : public XMLGrammarDescription
{
public :
    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------

    virtual ~XMLSchemaDescription();

    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------

    virtual Grammar::GrammarType   getGrammarType() const
    {
        return Grammar::SchemaGrammarType;
    }

    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------

    enum ContextType 
         {
            CONTEXT_INCLUDE,
            CONTEXT_REDEFINE,
            CONTEXT_IMPORT,
            CONTEXT_PREPARSE,
            CONTEXT_INSTANCE,
            CONTEXT_ELEMENT,
            CONTEXT_ATTRIBUTE,
            CONTEXT_XSITYPE,
            CONTEXT_UNKNOWN
         };

    virtual ContextType                getContextType() const = 0;

    virtual const XMLCh*               getTargetNamespace() const = 0;

    virtual const RefArrayVectorOf<XMLCh>*   getLocationHints() const = 0;

    virtual const QName*               getTriggeringComponent() const = 0;

    virtual const QName*               getEnclosingElementName() const = 0;

    virtual const XMLAttDef*           getAttributes() const = 0;

    virtual void                       setContextType(ContextType) = 0;

    virtual void                       setTargetNamespace(const XMLCh* const) = 0;

    virtual void                       setLocationHints(const XMLCh* const) = 0;

    virtual void                       setTriggeringComponent(QName* const) = 0;

    virtual void                       setEnclosingElementName(QName* const) = 0;

    virtual void                       setAttributes(XMLAttDef* const) = 0;
              
    /***
     * Support for Serialization/De-serialization
     ***/
    DECL_XSERIALIZABLE(XMLSchemaDescription)

protected :
    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------
    XMLSchemaDescription(MemoryManager* const memMgr = XMLPlatformUtils::fgMemoryManager);

private :
    // -----------------------------------------------------------------------
    // -----------------------------------------------------------------------
    XMLSchemaDescription(const XMLSchemaDescription& );
    XMLSchemaDescription& operator=(const XMLSchemaDescription& );

};


XERCES_CPP_NAMESPACE_END

#endif