Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.om.AttributeCollectionImpl
public final class AttributeCollectionImpl
extends java.lang.Object
implements Attributes, AttributeCollection
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 |
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
int |
|
int |
|
int |
|
int |
|
int |
|
String |
|
int |
|
int |
|
String |
|
int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
boolean |
|
boolean |
|
void |
|
void |
|
public AttributeCollectionImpl(NamePool pool)
Create an empty attribute list.
- Parameters:
pool
- the NamePool
public void addAttribute(int nameCode, int typeCode, String value, long locationId, int properties)
Add an attribute to an attribute list. The parameters correspond to the parameters of theReceiver.attribute(int,int,CharSequence,int,int)
method. There is no check that the name of the attribute is distinct from other attributes already in the collection: this check must be made by the caller.
- Parameters:
nameCode
- Integer representing the attribute name.typeCode
- The attribute type codevalue
- The attribute value (must not be null)locationId
- Identifies the attribtue location.properties
- Attribute properties
public void clear()
Clear the attribute list. This removes the values but doesn't free the memory used. free the memory, use clear() then compact().
public void compact()
Compact the attribute list to avoid wasting memory
public int getIndex(String qname)
Get the index of an attribute, from its lexical QName
- Parameters:
qname
- The lexical QName of the attribute. The prefix must match.
- Returns:
- The index position of the attribute
public int getIndex(String uri, String localname)
Get the index of an attribute (by name).
- Specified by:
- getIndex in interface AttributeCollection
- Parameters:
uri
- The namespace uri of the attribute.localname
- The local name of the attribute.
- Returns:
- The index position of the attribute
public int getIndexByFingerprint(int fingerprint)
Get the index, given the fingerprint. Return -1 if not found.
- Specified by:
- getIndexByFingerprint in interface AttributeCollection
public int getLength()
Return the number of attributes in the list.
- Specified by:
- getLength in interface AttributeCollection
- Returns:
- The number of attributes in the list.
public int getLineNumber(int index)
Get the line number part of the location of an attribute, at a given index. 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.
- Specified by:
- getLineNumber in interface AttributeCollection
- Parameters:
index
- the required attribute
- Returns:
- the line number of the location of the attribute
public String getLocalName(int index)
Get the local name of an attribute (by position).
- Specified by:
- getLocalName in interface AttributeCollection
- 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.
public int getLocationId(int index)
Get the locationID of an attribute (by position)
- Specified by:
- getLocationId in interface AttributeCollection
- 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
public int getNameCode(int index)
Get the namecode of an attribute (by position).
- Specified by:
- getNameCode in interface AttributeCollection
- 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.
public String getPrefix(int index)
Get the prefix of the name of an attribute (by position).
- Specified by:
- getPrefix in interface AttributeCollection
- 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.
public int getProperties(int index)
Get the properties of an attribute (by position)
- Specified by:
- getProperties in interface AttributeCollection
- 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 {ReceiverOptions.DEFAULTED_ATTRIBUTE
, which indicates an attribute that was added to an element as a result of schema validation.
public String getQName(int index)
Get the lexical QName of an attribute (by position).
- Specified by:
- getQName in interface AttributeCollection
- 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.
public String getSystemId(int index)
Get the systemId part of the location of an attribute, at a given index. 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.
- Specified by:
- getSystemId in interface AttributeCollection
- Parameters:
index
- the required attribute
- Returns:
- the systemId of the location of the attribute
public String getType(String name)
Get the type of an attribute (by lexical QName).
- 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).
public String getType(String uri, String localname)
Get the type of an attribute (by name).
- Parameters:
uri
- The namespace uri of the attribute.localname
- The local name of the attribute.
- Returns:
- The index position of the attribute
public String getType(int index)
Get the type of an attribute (by position). This is a SAX2 method, so it gets the type name as a DTD attribute type, mapped from the schema type code.
- 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.
public int getTypeAnnotation(int index)
Get the namecode of an attribute (by position).
- Specified by:
- getTypeAnnotation in interface AttributeCollection
- Parameters:
index
- The position of the attribute in the list.
- Returns:
- The type annotation, as the fingerprint of the type name. The bit
NodeInfo.IS_DTD_TYPE
represents a DTD-derived type.
public String getURI(int index)
Get the namespace URI of an attribute (by position).
- Specified by:
- getURI in interface AttributeCollection
- 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.
public String getValue(String name)
Get the value of an attribute (by lexical QName).
- 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.
public String getValue(String uri, String localname)
Get the value of an attribute (by name).
- Specified by:
- getValue in interface AttributeCollection
- Parameters:
uri
- The namespace uri of the attribute.localname
- The local name of the attribute.
- Returns:
- The index position of the attribute
public String getValue(int index)
Get the value of an attribute (by position).
- Specified by:
- getValue in interface AttributeCollection
- 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.
public String getValueByFingerprint(int fingerprint)
Get the attribute value using its fingerprint
- Specified by:
- getValueByFingerprint in interface AttributeCollection
public boolean isId(int index)
Determine whether a given attribute has the is-ID property set
- Specified by:
- isId in interface AttributeCollection
public boolean isIdref(int index)
Determine whether a given attribute has the is-idref property set
- Specified by:
- isIdref in interface AttributeCollection
public void setAttribute(int index, int nameCode, int typeCode, String value, long locationId, int properties)
Set (overwrite) an attribute in the attribute list. The parameters correspond to the parameters of theReceiver.attribute(int,int,CharSequence,int,int)
method.
- Parameters:
index
- Identifies the entry to be replacednameCode
- Integer representing the attribute name.typeCode
- The attribute type codevalue
- The attribute value (must not be null)locationId
- Identifies the attribtue location.properties
- Attribute properties
public void setLocationProvider(LocationProvider provider)
Set the location provider. This must be set if the methods getSystemId() and getLineNumber() are to be used to get location information for an attribute.
- Parameters:
provider
- the location provider