net.sf.saxon.om
public final class AttributeCollectionImpl extends Object implements Attributes, AttributeCollection
As well as providing the information required by the SAX2 interface, an AttributeCollection can hold type information (as needed to support the JAXP 1.3 javax.xml.validation.ValidatorHandler interface), and location information for debugging. The location information is used in the case of attributes on a result tree to identify the location in the query or stylesheet from which they were generated.
Field Summary | |
---|---|
static AttributeCollection | EMPTY_ATTRIBUTE_COLLECTION |
Constructor Summary | |
---|---|
AttributeCollectionImpl(NamePool pool)
Create an empty attribute list. |
Method Summary | |
---|---|
void | addAttribute(int nameCode, int typeCode, String value, int locationId, int properties)
Add an attribute to an attribute list. |
void | clear()
Clear the attribute list. |
void | compact()
Compact the attribute list to avoid wasting memory |
int | getIndex(String qname)
Get the index of an attribute, from its lexical QName
|
int | getIndex(String uri, String localname)
Get the index of an attribute (by name).
|
int | getIndexByFingerprint(int fingerprint)
Get the index, given the fingerprint.
|
int | getLength()
Return the number of attributes in the list.
|
int | getLineNumber(int index)
Get the line number part of the location of an attribute, at a given index.
|
String | getLocalName(int index)
Get the local name of an attribute (by position).
|
int | getLocationId(int index)
Get the locationID of an attribute (by position) |
int | getNameCode(int index)
Get the namecode of an attribute (by position).
|
String | getPrefix(int index)
Get the prefix of the name of an attribute (by position).
|
int | getProperties(int index)
Get the properties of an attribute (by position) |
String | getQName(int index)
Get the lexical QName of an attribute (by position).
|
String | getSystemId(int index)
Get the systemId part of the location of an attribute, at a given index.
|
String | getType(int index)
Get the type of an attribute (by position). |
String | getType(String uri, String localname)
Get the type of an attribute (by name).
|
String | getType(String name)
Get the type of an attribute (by lexical QName).
|
int | getTypeAnnotation(int index)
Get the namecode of an attribute (by position).
|
String | getURI(int index)
Get the namespace URI of an attribute (by position).
|
String | getValue(int index)
Get the value of an attribute (by position).
|
String | getValue(String uri, String localname)
Get the value of an attribute (by name).
|
String | getValue(String name)
Get the value of an attribute (by lexical QName).
|
String | getValueByFingerprint(int fingerprint)
Get the attribute value using its fingerprint |
boolean | isId(int index)
Determine whether a given attribute has the is-ID property set |
void | setAttribute(int index, int nameCode, int typeCode, String value, int locationId, int properties)
Set (overwrite) an attribute in the attribute list. |
void | setLocationProvider(LocationProvider provider)
Set the location provider. |
Parameters: nameCode Integer representing the attribute name. typeCode The attribute type code value The attribute value (must not be null) locationId Identifies the attribtue location. properties Attribute properties
Parameters: qname The lexical QName of the attribute. The prefix must match.
Returns: The index position of the attribute
Parameters: uri The namespace uri of the attribute. localname The local name of the attribute.
Returns: The index position of the attribute
Returns: The number of attributes in the list.
Attribute location information is not available from a SAX parser, so this method is not useful for getting the location of an attribute in a source document. However, in a Saxon result document, the location information represents the location in the stylesheet of the instruction used to generate this attribute, which is useful for debugging.
Parameters: index the required attribute
Returns: the line number of the location of the attribute
Parameters: index The position of the attribute in the list.
Returns: The local name of the attribute as a string, or null if there is no attribute at that position.
Parameters: index The position of the attribute in the list.
Returns: The location identifier of the attribute. This can be supplied to a LocationProvider in order to obtain the actual system identifier and line number of the relevant location
Parameters: index The position of the attribute in the list.
Returns: The display name of the attribute as a string, or null if there is no attribute at that position.
Parameters: index The position of the attribute in the list.
Returns: The prefix of the attribute name as a string, or null if there is no attribute at that position. Returns "" for an attribute that has no prefix.
Parameters: index The position of the attribute in the list.
Returns: The properties of the attribute. This is a set of bit-settings defined in class ReceiverOptions. The most interesting of these is {DEFAULTED_ATTRIBUTE, which indicates an attribute that was added to an element as a result of schema validation.
Parameters: index The position of the attribute in the list.
Returns: The lexical QName of the attribute as a string, or null if there is no attribute at that position.
Attribute location information is not available from a SAX parser, so this method is not useful for getting the location of an attribute in a source document. However, in a Saxon result document, the location information represents the location in the stylesheet of the instruction used to generate this attribute, which is useful for debugging.
Parameters: index the required attribute
Returns: the systemId of the location of the attribute
Parameters: index The position of the attribute in the list.
Returns: The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read), or null if there is no attribute at that position.
Parameters: uri The namespace uri of the attribute. localname The local name of the attribute.
Returns: The index position of the attribute
Parameters: name The lexical QName of the attribute.
Returns: The attribute type as a string (e.g. "NMTOKEN", or "CDATA" if no declaration was read).
Parameters: index The position of the attribute in the list.
Returns: The type annotation, as the fingerprint of the type name. The bit net.sf.saxon.om.NodeInfo.IS_DTD_TYPE represents a DTD-derived type.
Parameters: index The position of the attribute in the list.
Returns: The local name of the attribute as a string, or null if there is no attribute at that position.
Parameters: index The position of the attribute in the list.
Returns: The attribute value as a string, or null if there is no attribute at that position.
Parameters: uri The namespace uri of the attribute. localname The local name of the attribute.
Returns: The index position of the attribute
Parameters: name The attribute name (a lexical QName). The prefix must match the prefix originally used. This method is defined in SAX, but is not recommended except where the prefix is null.
Parameters: index Identifies the entry to be replaced nameCode Integer representing the attribute name. typeCode The attribute type code value The attribute value (must not be null) locationId Identifies the attribtue location. properties Attribute properties