org.apache.xerces.xni
public interface XMLAttributes
The attributes are read-write so that subsequent stages in the document pipeline can modify the values or change the attributes that are propogated to the next stage.
Version: $Id: XMLAttributes.java,v 1.11 2004/10/03 21:53:25 mrglavas Exp $
See Also: XMLDocumentHandler
Method Summary | |
---|---|
int | addAttribute(QName attrName, String attrType, String attrValue)
Adds an attribute. |
Augmentations | getAugmentations(int attributeIndex)
Look up an augmentation by attribute's index.
|
Augmentations | getAugmentations(String uri, String localPart)
Look up an augmentation by namespace name.
|
Augmentations | getAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.
|
int | getIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
|
int | getIndex(String uri, String localPart)
Look up the index of an attribute by Namespace name.
|
int | getLength()
Returns the number of attributes in the list.
|
String | getLocalName(int index)
Look up an attribute's local name by index.
|
void | getName(int attrIndex, QName attrName)
Sets the fields in the given QName structure with the values
of the attribute name at the specified index.
|
String | getNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified
index. |
String | getPrefix(int index)
Returns the prefix of the attribute at the specified index.
|
String | getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
|
String | getType(int index)
Look up an attribute's type by index.
|
String | getType(String qName)
Look up an attribute's type by XML 1.0 qualified name.
|
String | getType(String uri, String localName)
Look up an attribute's type by Namespace name.
|
String | getURI(int index)
Look up an attribute's Namespace URI by index.
|
String | getValue(int index)
Look up an attribute's value by index.
|
String | getValue(String qName)
Look up an attribute's value by XML 1.0 qualified name.
|
String | getValue(String uri, String localName)
Look up an attribute's value by Namespace name.
|
boolean | isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document.
|
void | removeAllAttributes()
Removes all of the attributes. |
void | removeAttributeAt(int attrIndex)
Removes the attribute at the specified index.
|
void | setAugmentations(int attrIndex, Augmentations augs)
Sets the augmentations of the attribute at the specified index.
|
void | setName(int attrIndex, QName attrName)
Sets the name of the attribute at the specified index.
|
void | setNonNormalizedValue(int attrIndex, String attrValue)
Sets the non-normalized value of the attribute at the specified
index.
|
void | setSpecified(int attrIndex, boolean specified)
Sets whether an attribute is specified in the instance document
or not.
|
void | setType(int attrIndex, String attrType)
Sets the type of the attribute at the specified index.
|
void | setValue(int attrIndex, String attrValue)
Sets the value of the attribute at the specified index. |
setNonNormalizedValue
method. Also,
the added attribute will be marked as specified in the XML instance
document unless set otherwise using the setSpecified
method.
Note: If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.
Parameters: attrName The attribute name. attrType The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true|false)". attrValue The attribute value.
Returns: Returns the attribute index.
See Also: XMLAttributes XMLAttributes
Parameters: attributeIndex The attribute index.
Returns: Augmentations
Parameters: uri The Namespace URI, or the empty string if the name has no Namespace URI. localPart
Returns: Augmentations
Parameters: qName The XML 1.0 qualified name.
Returns: Augmentations
Parameters: qName The qualified (prefixed) name.
Returns: The index of the attribute, or -1 if it does not appear in the list.
Parameters: uri The Namespace URI, or the empty string if the name has no Namespace URI. localPart The attribute's local name.
Returns: The index of the attribute, or -1 if it does not appear in the list.
Once you know the number of attributes, you can iterate through the list.
See Also: XMLAttributes XMLAttributes XMLAttributes XMLAttributes XMLAttributes
Parameters: index The attribute index (zero-based).
Returns: The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.
See Also: XMLAttributes
Parameters: attrIndex The attribute index. attrName The attribute name structure to fill in.
getValue(int)
method.
Parameters: attrIndex The attribute index.
Parameters: index The index of the attribute.
Parameters: index The attribute index (zero-based).
Returns: The XML 1.0 qualified name, or the empty string if none is available, or null if the index is out of range.
See Also: XMLAttributes
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 Recommentation (clause 3.3.3, "Attribute-Value Normalization").
For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".
Parameters: index The attribute index (zero-based).
Returns: The attribute's type as a string, or null if the index is out of range.
See Also: XMLAttributes
See getType(int)
for a description
of the possible types.
Parameters: qName The XML 1.0 qualified name.
Returns: The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.
See getType(int)
for a description
of the possible types.
Parameters: uri The Namespace URI, or the empty String if the name has no Namespace URI. localName The local name of the attribute.
Returns: The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.
Parameters: index The attribute index (zero-based).
Returns: The Namespace URI, or the empty string if none is available, or null if the index is out of range.
See Also: XMLAttributes
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.
Parameters: index The attribute index (zero-based).
Returns: The attribute's value as a string, or null if the index is out of range.
See Also: XMLAttributes
See getValue(int)
for a description
of the possible values.
Parameters: qName The XML 1.0 qualified name.
Returns: The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.
See getValue(int)
for a description
of the possible values.
Parameters: uri The Namespace URI, or the empty String if the name has no Namespace URI. localName The local name of the attribute.
Returns: The attribute value as a string, or null if the attribute is not in the list.
Parameters: attrIndex The attribute index.
Note: This operation changes the indexes of all attributes following the attribute at the specified index.
Parameters: attrIndex The attribute index.
Parameters: attrIndex The attribute index. augs The augmentations.
Parameters: attrIndex The attribute index. attrName The new attribute name.
Parameters: attrIndex The attribute index. attrValue The new non-normalized attribute value.
Parameters: attrIndex The attribute index. specified True if the attribute is specified in the instance document.
Parameters: attrIndex The attribute index. attrType The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true|false)".
Parameters: attrIndex The attribute index. attrValue The new attribute value.
See Also: XMLAttributes