/*

 * 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: XSNotationDeclaration.hpp 568078 2007-08-21 11:43:25Z amassari $

 */

#if !defined(XSNOTATIONDECLARATION_HPP)

#define XSNOTATIONDECLARATION_HPP

#include <xercesc/framework/psvi/XSObject.hpp>

XERCES_CPP_NAMESPACE_BEGIN

/**

 * This class describes all properties of a Schema Notation Declaration

 * component.

 * This is *always* owned by the validator /parser object from which

 * it is obtained.  

 */

// forward declarations

class XSAnnotation;

class XMLNotationDecl;

class XMLPARSER_EXPORT XSNotationDeclaration : public XSObject

{

public:

    //  Constructors and Destructor

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

    /** @name Constructors */

    //@{

    /**

      * The default constructor 

      *

      * @param  xmlNotationDecl

      * @param  annot

      * @param  xsModel

      * @param  manager     The configurable memory manager

      */

    XSNotationDeclaration

    (

        XMLNotationDecl*  const xmlNotationDecl

        , XSAnnotation* const   annot

        , XSModel* const        xsModel

        , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager

    );

    //@};

    /** @name Destructor */

    //@{

    ~XSNotationDeclaration();

    //@}

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

    /** @name overridden XSXSObject methods */

    //@{

    /**

     * The name of type <code>NCName</code> of this declaration as defined in 

     * XML Namespaces.

     */

    const XMLCh* getName();

    /**

     *  The [target namespace] of this object, or <code>null</code> if it is 

     * unspecified. 

     */

    const XMLCh* getNamespace();

    /**

     * A namespace schema information item corresponding to the target 

     * namespace of the component, if it's globally declared; or null 

     * otherwise.

     */

    XSNamespaceItem *getNamespaceItem();

    //@}

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

    /** @name XSNotationDeclaration methods */

    //@{

    /**

     *  The URI reference representing the system identifier for the notation 

     * declaration, if present, <code>null</code> otherwise. 

     */

    const XMLCh *getSystemId();

    /**

     *  The string representing the public identifier for this notation 

     * declaration, if present; <code>null</code> otherwise. 

     */

    const XMLCh *getPublicId();

    /**

     * Optional. An [annotation]. 

     */

    XSAnnotation *getAnnotation() const;

    //@}

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

    /** methods needed by implementation */

    //@{

    //@}

private:

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

    //  Unimplemented constructors and operators

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

    XSNotationDeclaration(const XSNotationDeclaration&);

    XSNotationDeclaration & operator=(const XSNotationDeclaration &);

protected:

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

    //  data members

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

    XMLNotationDecl* fXMLNotationDecl;

    XSAnnotation*    fAnnotation;

};

inline XSAnnotation* XSNotationDeclaration::getAnnotation() const

{

    return fAnnotation;

}

XERCES_CPP_NAMESPACE_END

#endif