Interface Summary : IBufferedAttributes
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:
- by attribute index;
- by Namespace-qualified name; or
- 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 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.
For reasons of generality and efficiency, strings that are returned
from the interface are declared as pointers (PSAXChar) and lengths.
This requires that the model use procedural out parameters rather
than functions as in the original interfaces.
Since : SAX 2.0
See : IBufferedDeclHandler.attributeDecl
Methods
function
getLength() : Integer
procedure
getURI(Integer, PSAXChar, Integer)
procedure
getLocalName(Integer, PSAXChar, Integer)
procedure
getQName(Integer, PSAXChar, Integer)
procedure
getType(Integer, PSAXChar, Integer)
procedure
getType(PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer)
procedure
getType(PSAXChar, Integer, PSAXChar, Integer)
procedure
getValue(Integer, PSAXChar, Integer)
procedure
getValue(PSAXChar, Integer, PSAXChar, Integer, PSAXChar, Integer)
procedure
getValue(PSAXChar, Integer, PSAXChar, Integer)
function
getIndex(PSAXChar, Integer, PSAXChar, Integer) : Integer
function
getIndex(PSAXChar, Integer) : 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 : IBufferedAttributes.getURI(Integer,PSAXChar,Integer)
See : IBufferedAttributes.getLocalName(Integer,PSAXChar,Integer)
See : IBufferedAttributes.getQName(Integer,PSAXChar,Integer)
See : IBufferedAttributes.getType(Integer,PSAXChar,Integer)
See : IBufferedAttributes.getValue(Integer,PSAXChar,Integer)
Top
procedure getURI( index : Integer; uri : PSAXChar; uriLength : Integer);
Look up an attribute's Namespace URI by index.
Parameter : index The attribute index (zero-based).
Parameter : uri The Namespace URI, or the empty string if none
is available or if the index is out of range.
Parameter : uriLength The length of the Namespace URI buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
See : IBufferedAttributes.getLength
Top
procedure getLocalName( index : Integer; localName : PSAXChar; localNameLength : Integer);
Look up an attribute's local name by index.
Parameter : index The attribute index (zero-based).
Parameter : localName The local name, or the empty string if Namespace
processing is not being performed or if the
index is out of range.
Parameter : localNameLength The length of the localName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
See : IBufferedAttributes.getLength
Top
procedure getQName( index : Integer; qName : PSAXChar; qNameLength : Integer);
Look up an attribute's XML 1.0 qualified name by index.
Parameter : index The attribute index (zero-based).
Parameter : qName The XML 1.0 qualified name, or the empty string
if none is available or if the index is out of
range.
Parameter : qNameLength The length of the qName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
See : IBufferedAttributes.getLength
Top
procedure getType( index : Integer; attType : PSAXChar; attTypeLength : Integer);
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).
Parameter : attType The attribute's type as a string or an empty string if the
index is out of range.
Parameter : attTypeLength The length of the attType buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
See : IBufferedAttributes.getLength
Top
procedure getType( uri : PSAXChar; uriLength : Integer; localName : PSAXChar; localNameLength : Integer; attType : PSAXChar; attTypeLength : Integer);
Look up an attribute's type by XML 1.0 local name and Namespace URI.
See getType(Integer, PSAXChar, Integer) for a description
of the possible types.
Parameter : uri The Namespace uri
Parameter : uriLength The length of the uri Buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : localName The XML 1.0 local name
Parameter : localNameLength The length of the localName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : uri The Namespace uri
Parameter : uriLength The length of the uri buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : attType The attribute's type as a string or an empty string if the
attribute is not in the list
Parameter : attTypeLength The length of the attType buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Top
procedure getType( qName : PSAXChar; qNameLength : Integer; attType : PSAXChar; attTypeLength : Integer);
Look up an attribute's type by XML 1.0 qualified name.
See getType(Integer, PSAXChar, Integer)
for a description of the possible types.
Parameter : qName The XML 1.0 qualified name.
Parameter : qNameLength The length of the qName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : attType 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.
Parameter : attTypeLength The length of the attType buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Top
procedure getValue( index : Integer; value : PSAXChar; valueLength : Integer);
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).
Parameter : value The attribute's value as a string, or an empty string if the
index is out of range.
Parameter : valueLength The length of the value buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
See : IBufferedAttributes.getLength
Top
procedure getValue( uri : PSAXChar; uriLength : Integer; localName : PSAXChar; localNameLength : Integer; value : PSAXChar; valueLength : Integer);
Look up an attribute's value by Namespace name.
See getValue(Integer, PSAXChar, 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 : uriLength The length of the uri buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : localName The local name of the attribute.
Parameter : localNameLength The length of the localName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : value The attribute value as a string, or an empty string if the
attribute is not in the list.
Parameter : valueLength The length of the value buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Top
procedure getValue( qName : PSAXChar; qNameLength : Integer; value : PSAXChar; valueLength : Integer);
Look up an attribute's value by XML 1.0 QName
See getValue(Integer, PSAXChar, Integer)
for a description of the possible values.
Parameter : qName The qualified (prefixed) name.
Parameter : qNameLength The length of the qName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : value The attribute value as a string, or an empty string if the
attribute is not in the list.
Parameter : valueLength The length of the value buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Top
function getIndex( uri : PSAXChar; uriLength : Integer; localName : PSAXChar; localNameLength : Integer) : 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 : uriLength The length of the uri buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Parameter : localName The attribute's local name.
Parameter : loclaNameLength The length of the localName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Result : The index of the attribute, or -1 if it does not
appear in the list.
Top
function getIndex( qName : PSAXChar; qNameLength : Integer) : Integer;
Look up the index of an attribute by XML 1.0 qualified name.
Parameter : qName The qualified (prefixed) name.
Parameter : qNameLength The length of the qName buffer
The value may be -1 which indicates that the buffer is
null-terminated. If the value is 0 then the buffer may be nil.
Result : The index of the attribute, or -1 if it does not
appear in the list.
Top