Interface Summary : IBufferedAttributes2

SAX2 extension to augment the per-attribute information provided though
IBufferedAttributes. If an implementation supports this extension, the attributes provided in IBufferedContentHandler.startElement will implement this interface, and the http://xml.org/sax/features/use-attributes2 feature flag will have the value true.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

XMLReader implementations are not required to support this information, and it is not part of core-only SAX2 distributions.

Note that if an attribute was defaulted (not isSpecified()) it will of necessity also have been declared (isDeclared()) in the DTD. Similarly if an attribute's type is anything except CDATA, then it must have been declared.


Since : SAX 2.0 (extensions 1.1 alpha)

Methods

function isDeclared(Integer) : Boolean
function isDeclared(PSAXChar, Integer) : Boolean
function isDeclared(PSAXChar, Integer, PSAXChar, Integer) : Boolean
function isSpecified(Integer) : Boolean
function isSpecified(PSAXChar, Integer, PSAXChar, Integer) : Boolean
function isSpecified(PSAXChar, Integer) : Boolean


function isDeclared( index : Integer) : Boolean;

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).
Parameter : index The attribute index (zero-based).
Result : true if the attribute was declared in the DTD, false otherwise.
Exception : Exception When the supplied index does not identify an attribute.

Top


function isDeclared( qName : PSAXChar; qNameLength : Integer) : Boolean;

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).
Parameter : qName The XML 1.0 qualified name.
Parameter : qNameLength 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.
Result : true if the attribute was declared in the DTD, false otherwise.
Exception : ESAXIllegalArgumentException When the supplied name does not identify an attribute.

Top


function isDeclared( uri : PSAXChar; uriLength : Integer; localName : PSAXChar; localNameLength : Integer) : Boolean;

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.


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 : 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.
Result : true if the attribute was declared in the DTD, false otherwise.
Exception : ESAXIllegalArgumentException When the supplied names do not identify an attribute.

Top


function isSpecified( index : Integer) : Boolean;

Returns true unless the attribute value was provided by DTD defaulting.
Parameter : index The attribute index (zero-based).
Result : true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Exception : ESAXIllegalArgumentException When the supplied index does not identify an attribute.

Top


function isSpecified( uri : PSAXChar; uriLength : Integer; localName : PSAXChar; localNameLength : Integer) : Boolean;

Returns true unless the attribute value was provided by DTD defaulting.

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.


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 : 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.
Result : true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Exception : ESAXIllegalArgumentException When the supplied names do not identify an attribute.

Top


function isSpecified( qName : PSAXChar; qNameLength : Integer) : Boolean;

Returns true unless the attribute value was provided by DTD defaulting.
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.
Result : true if the value was found in the XML text, false if the value was provided by DTD defaulting.
Exception : ESAXIllegalArgumentException When the supplied name does not identify an attribute.

Top