artefaktur
software engineer &        architecture
 
 
 
 

class Attributes

Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

org::xml::sax::Attributes Class Reference

#include <Attributes.h>

Inheritance diagram for org::xml::sax::Attributes:

org::xml::sax::helpers::AttributesImpl List of all members.

Detailed Description

Interface for a list of XML attributes.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This interface allows access to a list of attributes in three different ways:

  1. by attribute index;
  2. by Namespace-qualified name; or
  3. by qualified (prefixed) name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default). Because SAX2 conforms to the Namespaces in XML specification, it does not give namespace declaration attributes a namespace URI. Some other W3C specifications are in conflict with that, expecting these declarations to be in a namespace. Handler code may need to resolve that conflict.

If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the http://xml.org/sax/features/namespaces feature is false, access by Namespace-qualified names may not be available.

This interface replaces the now-deprecated SAX1 AttributeList interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below).

The order of attributes in the list is unspecified, and will vary from implementation to implementation.

Since:
SAX 2.0
See also:
org::xml::sax::helpers::AttributesImpl

org.xml.sax.ext.DeclHandler#attributeDecl


Public Member Functions

virtual int getLength ()=0
 Return the number of attributes in the list.

virtual acdk::lang::RString getURI (int index)=0
 Look up an attribute's Namespace URI by index.

virtual acdk::lang::RString getLocalName (int index)=0
 Look up an attribute's local name by index.

virtual acdk::lang::RString getQName (int index)=0
 Look up an attribute's XML 1.0 qualified name by index.

virtual acdk::lang::RString getType (int index)=0
 Look up an attribute's type by index.

virtual acdk::lang::RString getValue (int index)=0
 Look up an attribute's value by index.

virtual int getIndex (IN(acdk::lang::RString) uri, IN(acdk::lang::RString) localName)=0
 Look up the index of an attribute by Namespace name.

virtual int getIndex (IN(acdk::lang::RString) qName)=0
 Look up the index of an attribute by XML 1.0 qualified name.

virtual acdk::lang::RString getType (IN(acdk::lang::RString) uri, IN(acdk::lang::RString) localName)=0
 Look up an attribute's type by Namespace name.

virtual acdk::lang::RString getType (IN(acdk::lang::RString) qName)=0
 Look up an attribute's type by XML 1.0 qualified name.

virtual acdk::lang::RString getValue (IN(acdk::lang::RString) uri, IN(acdk::lang::RString) localName)=0
 Look up an attribute's value by Namespace name.

virtual acdk::lang::RString getValue (IN(acdk::lang::RString) qName)=0
 Look up an attribute's value by XML 1.0 qualified name.

Member Function Documentation

virtual int org::xml::sax::Attributes::getIndex (  IN(acdk::lang::RString)  qName  )  [pure virtual]
 

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

Parameters:
qName The qualified (prefixed) name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

virtual int org::xml::sax::Attributes::getIndex (  IN(acdk::lang::RString)  uri,
IN(acdk::lang::RString)  localName
)  [pure virtual]
 

Look up the index of an attribute by Namespace name.

Parameters:
uri The Namespace URI, or the empty string if the name has no Namespace URI.
localName The attribute's local name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

virtual int org::xml::sax::Attributes::getLength (   )  [pure virtual]
 

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns:
The number of attributes in the list.
See also:
getURI(int)

getLocalName(int)

getQName(int)

getType(int)

getValue(int)

Implemented in org::xml::sax::helpers::AttributesImpl.

virtual acdk::lang::RString org::xml::sax::Attributes::getLocalName (  int  index  )  [pure virtual]
 

Look up an attribute's local name by index.

Parameters:
index The attribute index (zero-based).
Returns:
The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.
See also:
getLength

Implemented in org::xml::sax::helpers::AttributesImpl.

virtual acdk::lang::RString org::xml::sax::Attributes::getQName (  int  index  )  [pure virtual]
 

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

Parameters:
index The attribute index (zero-based).
Returns:
The XML 1.0 qualified name, or the empty string if none is available, or null if the index is out of range.
See also:
getLength

Implemented in org::xml::sax::helpers::AttributesImpl.

virtual acdk::lang::RString org::xml::sax::Attributes::getType (  IN(acdk::lang::RString)  qName  )  [pure virtual]
 

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

See getType(int) for a description of the possible types.

Parameters:
qName The XML 1.0 qualified name.
Returns:
The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

virtual acdk::lang::RString org::xml::sax::Attributes::getType (  IN(acdk::lang::RString)  uri,
IN(acdk::lang::RString)  localName
)  [pure virtual]
 

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Parameters:
uri The Namespace URI, or the empty String if the name has no Namespace URI.
localName The local name of the attribute.
Returns:
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 acdk::lang::RString org::xml::sax::Attributes::getType (  int  index  )  [pure virtual]
 

Look up an attribute's type by index.

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.

Parameters:
index The attribute index (zero-based).
Returns:
The attribute's type as a string, or null if the index is out of range.
See also:
getLength

Implemented in org::xml::sax::helpers::AttributesImpl.

virtual acdk::lang::RString org::xml::sax::Attributes::getURI (  int  index  )  [pure virtual]
 

Look up an attribute's Namespace URI by index.

Parameters:
index The attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.
See also:
getLength

Implemented in org::xml::sax::helpers::AttributesImpl.

virtual acdk::lang::RString org::xml::sax::Attributes::getValue (  IN(acdk::lang::RString)  qName  )  [pure virtual]
 

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

See getValue(int) for a description of the possible values.

Parameters:
qName The XML 1.0 qualified name.
Returns:
The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

virtual acdk::lang::RString org::xml::sax::Attributes::getValue (  IN(acdk::lang::RString)  uri,
IN(acdk::lang::RString)  localName
)  [pure virtual]
 

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Parameters:
uri The Namespace URI, or the empty String if the name has no Namespace URI.
localName The local name of the attribute.
Returns:
The attribute value as a string, or null if the attribute is not in the list.

virtual acdk::lang::RString org::xml::sax::Attributes::getValue (  int  index  )  [pure virtual]
 

Look up an attribute's value by index.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters:
index The attribute index (zero-based).
Returns:
The attribute's value as a string, or null if the index is out of range.
See also:
getLength

Implemented in org::xml::sax::helpers::AttributesImpl.

 
Last modified 2005-05-08 18:34 by SYSTEM By Artefaktur, Ing. Bureau Kommer