/*

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

 */

#ifndef ATTRIBUTES_HPP

#define ATTRIBUTES_HPP

#include <xercesc/util/XercesDefs.hpp>

XERCES_CPP_NAMESPACE_BEGIN

/**

  * Interface for an element's attribute specifications.

  *

  * The SAX2 parser implements this interface and passes an instance

  * to the SAX2 application as the last argument of each startElement

  * event.

  *

  * The instance provided will return valid results only during the

  * scope of the startElement invocation (to save it for future

  * use, the application must make a copy: the AttributesImpl

  * helper class provides a convenient constructor for doing so).

  *

  * An Attributes includes only attributes that have been

  * specified or defaulted: #IMPLIED attributes will not be included.

  *

  * There are two ways for the SAX application to obtain information

  * from the Attributes.  First, it can iterate through the entire

  * list:

  *

  * <code>

  * public void startElement (String uri, String localpart, String qName, Attributes atts) {<br>

  * &nbsp;for (int i = 0; i < atts.getLength(); i++) {<br>

  * &nbsp;&nbsp;String Qname = atts.getQName(i);<br>

  * &nbsp;&nbsp;String URI   = atts.getURI(i)<br>

  * &nbsp;&nbsp;String local = atts.GetLocalName(i)<br>

  * &nbsp;&nbsp;String type  = atts.getType(i);<br>

  * &nbsp;&nbsp;String value = atts.getValue(i);<br>

  * &nbsp;&nbsp;[...]<br>

  * &nbsp;}<br>

  * }

  * </code>

  *

  * (Note that the result of getLength() will be zero if there

  * are no attributes.)

  *

  * As an alternative, the application can request the value or

  * type of specific attributes:

  *

  * <code>

  * public void startElement (String uri, String localpart, String qName, Attributes atts) {<br>

  * &nbsp;String identifier = atts.getValue("id");<br>

  * &nbsp;String label = atts.getValue("label");<br>

  * &nbsp;[...]<br>

  * }

  * </code>

  *

  * The AttributesImpl helper class provides a convenience

  * implementation for use by parser or application writers.

  *

  * @see Sax2DocumentHandler#startElement

  * @see AttributesImpl#AttributesImpl

  */

class SAX2_EXPORT Attributes

{

public:

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

    //  Constructors and Destructor

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

    /** @name Constructors and Destructor */

    //@{

    /** Default constructor */

    Attributes()

    {

    }

    /** Destructor */

    virtual ~Attributes()

    {

    }

    //@}

    /** @name The virtual attribute list interface */

    //@{

  /**

    * Return the number of attributes in this list.

    *

    * The SAX parser may provide attributes in any

    * arbitrary order, regardless of the order in which they were

    * declared or specified.  The number of attributes may be

    * zero.

    *

    * @return The number of attributes in the list.

    */

    virtual unsigned int getLength() const = 0;

  /**

    * Return the namespace URI of an attribute in this list (by position).

    *

    * The QNames must be unique: the SAX parser shall not include the

    * same attribute twice.  Attributes without values (those declared

    * #IMPLIED without a value specified in the start tag) will be

    * omitted from the list.

    *

    * @param index The index of the attribute in the list (starting at 0).

    * @return The URI of the indexed attribute, or null

    *         if the index is out of range.

    * @see #getLength

    */

	virtual const XMLCh* getURI(const unsigned int index) const = 0;

  /**

    * Return the local name of an attribute in this list (by position).

    *

    * The QNames must be unique: the SAX parser shall not include the

    * same attribute twice.  Attributes without values (those declared

    * #IMPLIED without a value specified in the start tag) will be

    * omitted from the list.

    *

    * @param index The index of the attribute in the list (starting at 0).

    * @return The local name of the indexed attribute, or null

    *         if the index is out of range.

    * @see #getLength

    */

    virtual const XMLCh* getLocalName(const unsigned int index) const = 0;

  /**

    * Return the qName of an attribute in this list (by position).

    *

    * The QNames must be unique: the SAX parser shall not include the

    * same attribute twice.  Attributes without values (those declared

    * #IMPLIED without a value specified in the start tag) will be

    * omitted from the list.

    *

    * @param index The index of the attribute in the list (starting at 0).

    * @return The qName of the indexed attribute, or null

    *         if the index is out of range.

    * @see #getLength

    */

    virtual const XMLCh* getQName(const unsigned int index) const = 0;

  /**

    * Return the type of an attribute in the list (by position).

    *

    * The attribute type is one of the strings "CDATA", "ID",

    * "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES",

    * or "NOTATION" (always in upper case).

    *

    * If the parser has not read a declaration for the attribute,

    * or if the parser does not report attribute types, then it must

    * return the value "CDATA" as stated in the XML 1.0 Recommentation

    * (clause 3.3.3, "Attribute-Value Normalization").

    *

    * For an enumerated attribute that is not a notation, the

    * parser will report the type as "NMTOKEN".

    *

    * @param index The index of the attribute in the list (starting at 0).

    * @return The attribute type as a string, or

    *         null if the index is out of range.

    * @see #getLength

    * @see #getType(String)

    */

    virtual const XMLCh* getType(const unsigned int index) const = 0;

  /**

    * Return the value of an attribute in the list (by position).

    *

    * If the attribute value is a list of tokens (IDREFS,

    * ENTITIES, or NMTOKENS), the tokens will be concatenated

    * into a single string separated by whitespace.

    *

    * @param index The index of the attribute in the list (starting at 0).

    * @return The attribute value as a string, or

    *         null if the index is out of range.

    * @see #getLength

    * @see #getValue(XMLCh*)

    */

    virtual const XMLCh* getValue(const unsigned int index) const = 0;

    ////////////////////////////////////////////////////////////////////

    // Name-based query.

    ////////////////////////////////////////////////////////////////////

   /**

     * Look up the index of an attribute by Namespace name.

     *

     * @param uri The Namespace URI, or the empty string if

     *        the name has no Namespace URI.

     * @param localPart The attribute's local name.

     * @return The index of the attribute, or -1 if it does not

     *         appear in the list.

     */

	virtual int getIndex(const XMLCh* const uri, const XMLCh* const localPart ) const = 0 ;

   /**

     * Look up the index of an attribute by XML 1.0 qualified name.

     *

     * @param qName The qualified (prefixed) name.

     * @return The index of the attribute, or -1 if it does not

     *         appear in the list.

     */

	virtual int getIndex(const XMLCh* const qName ) const = 0 ;

   /**

     * Look up an attribute's type by Namespace name.

     *

     * <p>See #getType for a description of the possible types.</p>

     *

     * @param uri The Namespace URI, or the empty String if the

     *        name has no Namespace URI.

     * @param localPart The local name of the attribute.

     * @return The attribute type as a string, or null if the

     *         attribute is not in the list or if Namespace

     *         processing is not being performed.

     */

	virtual const XMLCh* getType(const XMLCh* const uri, const XMLCh* const localPart ) const = 0 ;

   /**

     * Look up an attribute's type by XML 1.0 qualified name.

     *

     * <p>See #getType for a description of the possible types.</p>

     *

     * @param qName The XML 1.0 qualified name.

     * @return The attribute type as a string, or null if the

     *         attribute is not in the list or if qualified names

     *         are not available.

     */

    virtual const XMLCh* getType(const XMLCh* const qName) const = 0;

   /**

     * Look up an attribute's value by Namespace name.

     *

     * <p>See #getValue for a description of the possible values.</p>

     *

     * @param uri The Namespace URI, or the empty String if the

     *        name has no Namespace URI.

     * @param localPart The local name of the attribute.

     * @return The attribute value as a string, or null if the

     *         attribute is not in the list.

     */

	virtual const XMLCh* getValue(const XMLCh* const uri, const XMLCh* const localPart ) const = 0 ;

   /**

     * Look up an attribute's value by XML 1.0 qualified name.

     *

     * <p>See #getValue for a description of the possible values.</p>

     *

     * @param qName The XML 1.0 qualified name.

     * @return The attribute value as a string, or null if the

     *         attribute is not in the list or if qualified names

     *         are not available.

     */

    virtual const XMLCh* getValue(const XMLCh* const qName) const = 0;

    //@}

private :

    /* Constructors and operators */

    /* Copy constructor */

    Attributes(const Attributes&);

    /* Assignment operator */

    Attributes& operator=(const Attributes&);

};

XERCES_CPP_NAMESPACE_END

#endif