/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

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

 */

#if !defined(XSFACET_HPP)

#define XSFACET_HPP

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

XERCES_CPP_NAMESPACE_BEGIN

/**

 * This represents all Schema Facet components with the exception 

 * of Enumeration and Pattern Facets, which are represented by the 

 * XSMultiValueFacet interface.

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

 * it is obtained.  

 */

// forward declarations

class XSAnnotation;

class XMLPARSER_EXPORT XSFacet : public XSObject

{

public:

    //  Constructors and Destructor

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

    /** @name Constructors */

    //@{

    /**

      * The default constructor 

      *

      * @param  facetKind

      * @param  lexicalValue

      * @param  isFixed

      * @param  annot

      * @param  xsModel

      * @param  manager     The configurable memory manager

      */

    XSFacet

    (

        XSSimpleTypeDefinition::FACET facetKind

        , const XMLCh* const          lexicalValue

        , bool                        isFixed

        , XSAnnotation* const         annot

        , XSModel* const              xsModel

        , MemoryManager* const        manager = XMLPlatformUtils::fgMemoryManager

    );

    //@};

    /** @name Destructor */

    //@{

    ~XSFacet();

    //@}

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

    /** @name XSFacet methods */

    //@{

    /**

     * @return An indication as to the facet's type; see <code>XSSimpleTypeDefinition::FACET</code>

     */

    XSSimpleTypeDefinition::FACET getFacetKind() const;

    /**

     * @return Returns a value of a constraining facet. 

     */

    const XMLCh *getLexicalFacetValue() const;

    /**

     * Check whether a facet value is fixed. 

     */

    bool isFixed() const;

    /**

     * @return an annotation

     */

    XSAnnotation *getAnnotation() const;

    //@}

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

    /** methods needed by implementation */

    //@{

    //@}

private:

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

    //  Unimplemented constructors and operators

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

    XSFacet(const XSFacet&);

    XSFacet & operator=(const XSFacet &);

protected:

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

    //  data members

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

    XSSimpleTypeDefinition::FACET fFacetKind;

    bool                          fIsFixed;

    const XMLCh*                  fLexicalValue;

    XSAnnotation*                 fAnnotation;

};

inline XSSimpleTypeDefinition::FACET XSFacet::getFacetKind() const

{   

    return fFacetKind;

}

inline const XMLCh* XSFacet::getLexicalFacetValue() const

{

    return fLexicalValue;    

}

inline bool XSFacet::isFixed() const

{

    return fIsFixed;

}

inline XSAnnotation* XSFacet::getAnnotation() const

{

    return fAnnotation;

}

XERCES_CPP_NAMESPACE_END

#endif