/*

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

 */

#if !defined(PSVIELEMENT_HPP)

#define PSVIELEMENT_HPP

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

XERCES_CPP_NAMESPACE_BEGIN

/**

 * Represent the PSVI contributions for one element information item.

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

 * it is obtained.  The validator will specify 

 * under what conditions it may be relied upon to have meaningful contents.

 */

// forward declarations

class XSElementDeclaration;

class XSNotationDeclaration;

class XSModel;

class XMLPARSER_EXPORT PSVIElement : public PSVIItem  

{

public:

    //  Constructors and Destructor

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

    /** @name Constructors */

    //@{

    /**

      * The default constructor 

      *

      * @param  manager     The configurable memory manager

      */

    PSVIElement( MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);

    //@};

    /** @name Destructor */

    //@{

    ~PSVIElement();

    //@}

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

    /** @name PSVIElement methods */

    //@{

    /**

     * An item isomorphic to the element declaration used to validate

     * this element.

     * 

     * @return  an element declaration

     */

    XSElementDeclaration *getElementDeclaration();

    /**

     * [notation] 

     * @see <a href="http://www.w3.org/TR/xmlschema-1/#e-notation">XML Schema Part 1: Structures [notation]</a>

     * @return The notation declaration. 

     */

    XSNotationDeclaration *getNotationDeclaration();

    /**

     * [schema information]

     * @see <a href="http://www.w3.org/TR/xmlschema-1/#e-schema_information">XML Schema Part 1: Structures [schema information]</a>

     * @return The schema information property if it's the validation root,

     *         null otherwise.

     */

    XSModel *getSchemaInformation();

    /**

     * An item isomorphic to the type definition used to validate this element.

     * 

     * @return  a type declaration

     */

    XSTypeDefinition *getTypeDefinition();

    /**

     * If and only if that type definition is a simple type definition

     * with {variety} union, or a complex type definition whose {content type}

     * is a simple type definition with {variety} union, then an item isomorphic

     * to that member of the union's {member type definitions} which actually

     * validated the element item's normalized value.

     * 

     * @return  a simple type declaration

     */

    XSSimpleTypeDefinition *getMemberTypeDefinition();

    //@}

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

    /** methods needed by implementation */

    //@{

    void reset

    (

        const VALIDITY_STATE            validityState

        , const ASSESSMENT_TYPE         assessmentType

        , const XMLCh* const            validationContext

        , bool                          isSpecified

        , XSElementDeclaration* const   elemDecl

        , XSTypeDefinition* const       typeDef

        , XSSimpleTypeDefinition* const memberType

        , XSModel* const                schemaInfo

        , const XMLCh* const            defaultValue

        , const XMLCh* const            normalizedValue = 0

        , XMLCh* const                  canonicalValue = 0

        , XSNotationDeclaration* const  notationDecl = 0

    );

    //@}

private:

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

    //  Unimplemented constructors and operators

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

    PSVIElement(const PSVIElement&);

    PSVIElement & operator=(const PSVIElement &);

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

    //  data members

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

    // fElementDecl

    //  element declaration component that validated this element

    // fNotationDecl

    //  (optional) notation decl associated with this element

    // fSchemaInfo

    //  Schema Information Item with which this validation episode is associated

    XSElementDeclaration *fElementDecl;

    XSNotationDeclaration *fNotationDecl;

    XSModel *fSchemaInfo;

};

inline XSElementDeclaration *PSVIElement::getElementDeclaration() 

{

    return fElementDecl;

}

inline XSNotationDeclaration* PSVIElement::getNotationDeclaration() 

{

    return fNotationDecl;

}

inline XSModel* PSVIElement::getSchemaInformation() 

{

    return fSchemaInfo;

}

XERCES_CPP_NAMESPACE_END

#endif