/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

/*

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

 */

#if !defined(XSTYPEDEFINITION_HPP)

#define XSTYPEDEFINITION_HPP

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

XERCES_CPP_NAMESPACE_BEGIN

// forward declarations

class XSNamespaceItem;

/**

 * This class represents a complexType or simpleType definition.

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

 * it is obtained.  

 *

 */

class XMLPARSER_EXPORT XSTypeDefinition : public XSObject

{

public:

    enum TYPE_CATEGORY {

        /**

        * This constant value signifies a complex type.

        */

        COMPLEX_TYPE              = 15,

	    /**

	     * This constant value signifies a simple type.

	     */

	    SIMPLE_TYPE               = 16

    };

    //  Constructors and Destructor

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

    /** @name Constructors */

    //@{

    /**

      * The default constructor 

      *

      * @param  typeCategory

      * @param  xsBaseType

      * @param  xsModel

      * @param  manager     The configurable memory manager

      */

    XSTypeDefinition

    (

        TYPE_CATEGORY             typeCategory

        , XSTypeDefinition* const xsBaseType

        , XSModel* const          xsModel

        , MemoryManager* const    manager = XMLPlatformUtils::fgMemoryManager

    );

    //@};

    /** @name Destructor */

    //@{

    virtual ~XSTypeDefinition();

    //@}

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

    /** @name overloaded XSObject methods */

    //@{

    /**

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

     * XML Namespaces.

     */

    virtual const XMLCh* getName() = 0;

    /**

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

     * unspecified. 

     */

    virtual const XMLCh* getNamespace() = 0;

    /**

     * A namespace schema information item corresponding to the target 

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

     * otherwise.

     */

    virtual XSNamespaceItem *getNamespaceItem() = 0;

    //@}

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

    /** @name XSTypeDefinition methods */

    //@{

    /**

     * Return whether this type definition is a simple type or complex type.

     */

    TYPE_CATEGORY getTypeCategory() const;

    /**

     * {base type definition}: either a simple type definition or a complex 

     * type definition. 

     */

    virtual XSTypeDefinition *getBaseType() = 0;

    /**

     * {final}. For complex type definition it is a subset of {extension, 

     * restriction}. For simple type definition it is a subset of 

     * {extension, list, restriction, union}. 

     * @param toTest       Extension, restriction, list, union constants 

     *   (defined in <code>XSObject</code>). 

     * @return True if toTest is in the final set, otherwise false.

     */

    bool isFinal(short toTest);

    /**

     * For complex types the returned value is a bit combination of the subset 

     * of {<code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} 

     * corresponding to <code>final</code> set of this type or 

     * <code>DERIVATION_NONE</code>. For simple types the returned value is 

     * a bit combination of the subset of { 

     * <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>

     * } corresponding to <code>final</code> set of this type or 

     * <code>DERIVATION_NONE</code>. 

     */

    short getFinal() const;

    /**

     *  A boolean that specifies if the type definition is 

     * anonymous. Convenience attribute. 

     */

    virtual bool getAnonymous() const = 0;

    /**

     * Convenience method: check if this type is derived from the given 

     * <code>ancestorType</code>. 

     * @param ancestorType  An ancestor type definition. 

     * @return  Return true if this type is derived from 

     *   <code>ancestorType</code>.

     */

    virtual bool derivedFromType(const XSTypeDefinition* const ancestorType) = 0;

    /**

     * Convenience method: check if this type is derived from the given 

     * ancestor type. 

     * @param typeNamespace  An ancestor type namespace. 

     * @param name  An ancestor type name. 

     * @return  Return true if this type is derived from 

     *   the ancestor defined by <code>typeNamespace</code> and <code>name</code>.

     */

    bool derivedFrom(const XMLCh* typeNamespace, 

                               const XMLCh* name);

    //@}

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

    /** methods needed by implementation */

    //@{

    //@}

private:

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

    //  Unimplemented constructors and operators

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

    XSTypeDefinition(const XSTypeDefinition&);

    XSTypeDefinition & operator=(const XSTypeDefinition &);

protected:

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

    //  data members

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

    // fTypeCategory

    //  whether this is a simpleType or complexType

    // fFinal

    //  the final properties which is set by the derived class.

    TYPE_CATEGORY     fTypeCategory;

    short             fFinal;

    XSTypeDefinition* fBaseType; // owned by XSModel

};

inline XSTypeDefinition::TYPE_CATEGORY XSTypeDefinition::getTypeCategory() const

{

    return fTypeCategory;

}

inline short XSTypeDefinition::getFinal() const

{

    return fFinal;

}

XERCES_CPP_NAMESPACE_END

#endif