The XMLAttributes interface defines a collection of attributes for
an element. In the parser, the document source would scan the entire
start element and collect the attributes. The attributes are
communicated to the document handler in the startElement method.
The attributes are read-write so that subsequent stages in the document
pipeline can modify the values or change the attributes that are
propagated to the next stage.
addAttribute
public int addAttribute(QName attrName,
String attrType,
String attrValue)
Adds an attribute. The attribute's non-normalized value of the
attribute will have the same value as the attribute value until
set using the
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.
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 the attribute index.
getAugmentations
public Augmentations getAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.
qName
- The XML 1.0 qualified name.
getAugmentations
public Augmentations getAugmentations(String uri,
String localPart)
Look up an augmentation by namespace name.
uri
- The Namespace URI, or the empty string if
the name has no Namespace URI.localPart
-
getAugmentations
public Augmentations getAugmentations(int attributeIndex)
Look up an augmentation by attribute's index.
attributeIndex
- The attribute index.
getIndex
public int getIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
qName
- The qualified (prefixed) name.
- The index of the attribute, or -1 if it does not
appear in the list.
getIndex
public int getIndex(String uri,
String localPart)
Look up the index of an attribute by Namespace name.
uri
- The Namespace URI, or the empty string if
the name has no Namespace URI.localPart
- The attribute's local name.
- The index of the attribute, or -1 if it does not
appear in the list.
getLength
public int getLength()
Returns the number of attributes in the list.
Once you know the number of attributes, you can iterate
through the list.
getLocalName
public String getLocalName(int index)
Look up an attribute's local name by index.
index
- The attribute index (zero-based).
- The local name, or the empty string if Namespace
processing is not being performed, or null
if the index is out of range.
getName
public 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.
attrIndex
- The attribute index.attrName
- The attribute name structure to fill in.
getNonNormalizedValue
public String getNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified
index. If no non-normalized value is set, this method will return
the same value as the getValue(int)
method.
attrIndex
- The attribute index.
getPrefix
public String getPrefix(int index)
Returns the prefix of the attribute at the specified index.
index
- The index of the attribute.
getQName
public String getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
index
- The attribute index (zero-based).
- The XML 1.0 qualified name, or the empty string
if none is available, or null if the index
is out of range.
getType
public String getType(String qName)
Look up an attribute's type by XML 1.0 qualified name.
See
getType(int)
for a description
of the possible types.
qName
- The XML 1.0 qualified name.
- The attribute type as a string, or null if the
attribute is not in the list or if qualified names
are not available.
getType
public String getType(String uri,
String localName)
Look up an attribute's type by Namespace name.
See
getType(int)
for a description
of the possible types.
uri
- The Namespace URI, or the empty String if the
name has no Namespace URI.localName
- The local name of the attribute.
- The attribute type as a string, or null if the
attribute is not in the list or if Namespace
processing is not being performed.
getType
public String getType(int index)
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".
index
- The attribute index (zero-based).
- The attribute's type as a string, or null if the
index is out of range.
getURI
public String getURI(int index)
Look up an attribute's Namespace URI by index.
index
- The attribute index (zero-based).
- The Namespace URI, or the empty string if none
is available, or null if the index is out of
range.
getValue
public String getValue(String qName)
Look up an attribute's value by XML 1.0 qualified name.
See
getValue(int)
for a description
of the possible values.
qName
- The XML 1.0 qualified name.
- The attribute value as a string, or null if the
attribute is not in the list or if qualified names
are not available.
getValue
public String getValue(String uri,
String localName)
Look up an attribute's value by Namespace name.
See
getValue(int)
for a description
of the possible values.
uri
- The Namespace URI, or the empty String if the
name has no Namespace URI.localName
- The local name of the attribute.
- The attribute value as a string, or null if the
attribute is not in the list.
getValue
public String getValue(int index)
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.
index
- The attribute index (zero-based).
- The attribute's value as a string, or null if the
index is out of range.
isSpecified
public boolean isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document.
attrIndex
- The attribute index.
removeAllAttributes
public void removeAllAttributes()
Removes all of the attributes. This method will also remove all
entities associated to the attributes.
removeAttributeAt
public void removeAttributeAt(int attrIndex)
Removes the attribute at the specified index.
Note: This operation changes the indexes of all
attributes following the attribute at the specified index.
attrIndex
- The attribute index.
setAugmentations
public void setAugmentations(int attrIndex,
Augmentations augs)
Sets the augmentations of the attribute at the specified index.
attrIndex
- The attribute index.augs
- The augmentations.
setName
public void setName(int attrIndex,
QName attrName)
Sets the name of the attribute at the specified index.
attrIndex
- The attribute index.attrName
- The new attribute name.
setNonNormalizedValue
public void setNonNormalizedValue(int attrIndex,
String attrValue)
Sets the non-normalized value of the attribute at the specified
index.
attrIndex
- The attribute index.attrValue
- The new non-normalized attribute value.
setSpecified
public void setSpecified(int attrIndex,
boolean specified)
Sets whether an attribute is specified in the instance document
or not.
attrIndex
- The attribute index.specified
- True if the attribute is specified in the instance
document.
setType
public void setType(int attrIndex,
String attrType)
Sets the type of the attribute at the specified index.
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)".
setValue
public void setValue(int attrIndex,
String attrValue)
Sets the value of the attribute at the specified index. This
method will overwrite the non-normalized value of the attribute.
attrIndex
- The attribute index.attrValue
- The new attribute value.