Interface Summary : IAttributes

Interface for a list of XML attributes.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

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 original "Namespaces in XML" recommendation, it normally does not give namespace declaration attributes a namespace URI.

Some SAX2 parsers may support using an optional feature flag (http://xml.org/sax/features/xmlns-uris) to request that those attributes be given URIs, conforming to a later backwards-incompatible revision of that recommendation. (The attribute's "local name" will be the prefix, or the empty string when defining a default element namespace.) For portability, handler code should always resolve that conflict, rather than requiring parsers that can change the setting of that feature flag.

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 (IAttributeList) 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 : IDeclHandler.attributeDecl

Methods

function getLength() : Integer
function getURI(Integer) : SAXString
function getLocalName(Integer) : SAXString
function getQName(Integer) : SAXString
function getType(Integer) : SAXString
function getType(SAXString, SAXString) : SAXString
function getType(SAXString) : SAXString
function getValue(Integer) : SAXString
function getValue(SAXString, SAXString) : SAXString
function getValue(SAXString) : SAXString
function getIndex(SAXString, SAXString) : Integer
function getIndex(SAXString) : Integer

Properties



function getLength() : Integer;

Return the number of attributes in the list.

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


Result : The number of attributes in the list.
See : IAttributes.getURI(Integer)
See : IAttributes.getLocalName(Integer)
See : IAttributes.getQName(Integer)
See : IAttributes.getType(Integer)
See : IAttributes.getValue(Integer)

Top


function getURI( index : Integer) : SAXString;

Look up an attribute's Namespace URI by index.
Parameter : index The attribute index (zero-based).
Result : The Namespace URI, or the empty string if none is available or if the index is out of range.
See : IAttributes.getLength

Top


function getLocalName( index : Integer) : SAXString;

Look up an attribute's local name by index.
Parameter : index The attribute index (zero-based).
Result : The local name, or the empty string if Namespace processing is not being performed or if the index is out of range.
See : IAttributes.getLength

Top


function getQName( index : Integer) : SAXString;

Look up an attribute's XML 1.0 qualified name by index.
Parameter : index The attribute index (zero-based).
Result : The XML 1.0 qualified name, or the empty string if none is available or if the index is out of range.
See : IAttributes.getLength

Top


function getType( index : Integer) : SAXString;

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 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".


Parameter : index The attribute index (zero-based).
Result : The attribute's type as a string or an empty string if the index is out of range.
See : IAttributes.getLength

Top


function getType(const uri : SAXString; const localName : SAXString) : SAXString;

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

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


Parameter : qName The XML 1.0 qualified name.
Result : The attribute value as a string, or an empty string if the attribute is not in the list or if qualified names are not available.

Top


function getType(const qName : SAXString) : SAXString;

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

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


Parameter : qName The XML 1.0 qualified name.
Result : The attribute type as a string, or an empty string if the attribute is not in the list or if qualified names are not available.

Top


function getValue( index : Integer) : SAXString;

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.


Parameter : index The attribute index (zero-based).
Result : The attribute's value as a string, or an empty string if the index is out of range.
See : IAttributes.getLength

Top


function getValue(const uri : SAXString; const localName : SAXString) : SAXString;

Look up an attribute's type by Namespace name.

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


Parameter : uri The Namespace URI, or the empty String if the name has no Namespace URI.
Parameter : localName The local name of the attribute.
Result : The attribute type as a string, or an empty string if the attribute is not in the list or if Namespace processing is not being performed.

Top


function getValue(const qName : SAXString) : SAXString;

Look up an attribute's value by Namespace name.

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


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

Top


function getIndex(const uri : SAXString; const localName : SAXString) : Integer;

Look up the index of an attribute by Namespace name.
Parameter : uri The Namespace URI, or the empty string if the name has no Namespace URI.
Parameter : localName The attribute's local name.
Result : The index of the attribute, or -1 if it does not appear in the list.

Top


function getIndex(const qName : SAXString) : Integer;

Look up the index of an attribute by XML 1.0 qualified name.
Parameter : qName The qualified (prefixed) name.
Result : The index of the attribute, or -1 if it does not appear in the list.

Top


Length

Extension property to get the number of Attributes
Result : The number of attributes in the list.
See : IAttributes.getLength

property Length : Integer read getLength

Top