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 propagated to the next stage.
- Version:
- $Id: XMLAttributes.java 570130 2007-08-27 14:10:55Z mrglavas $
- Author:
- Andy Clark, IBM
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionint
addAttribute
(QName attrName, String attrType, String attrValue) Adds an attribute.getAugmentations
(int attributeIndex) Look up an augmentation by attribute's index.getAugmentations
(String qName) Look up an augmentation by XML 1.0 qualified name.getAugmentations
(String uri, String localPart) Look up an augmentation by namespace name.int
Look up the index of an attribute by XML 1.0 qualified name.int
Look up the index of an attribute by Namespace name.int
Returns the number of attributes in the list.getLocalName
(int index) Look up an attribute's local name by index.void
Sets the fields in the given QName structure with the values of the attribute name at the specified index.getNonNormalizedValue
(int attrIndex) Returns the non-normalized value of the attribute at the specified index.getPrefix
(int index) Returns the prefix of the attribute at the specified index.getQName
(int index) Look up an attribute's XML 1.0 qualified name by index.getType
(int index) Look up an attribute's type by index.Look up an attribute's type by XML 1.0 qualified name.Look up an attribute's type by Namespace name.getURI
(int index) Look up an attribute's Namespace URI by index.getValue
(int index) Look up an attribute's value by index.Look up an attribute's value by XML 1.0 qualified name.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
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
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
Sets the type of the attribute at the specified index.void
Sets the value of the attribute at the specified index.
-
Method Details
-
addAttribute
Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value until set using thesetNonNormalizedValue
method. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using thesetSpecified
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:
-
removeAllAttributes
void removeAllAttributes()Removes all of the attributes. This method will also remove all entities associated to the attributes. -
removeAttributeAt
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.
- Parameters:
attrIndex
- The attribute index.
-
getLength
int getLength()Returns the number of attributes in the list.Once you know the number of attributes, you can iterate through the list.
-
getIndex
Look up the index of an attribute by XML 1.0 qualified name.- Parameters:
qName
- The qualified (prefixed) name.- Returns:
- The index of the attribute, or -1 if it does not appear in the list.
-
getIndex
Look up the index of an attribute by Namespace name.- 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.
-
setName
Sets the name of the attribute at the specified index.- Parameters:
attrIndex
- The attribute index.attrName
- The new attribute name.
-
getName
Sets the fields in the given QName structure with the values of the attribute name at the specified index.- Parameters:
attrIndex
- The attribute index.attrName
- The attribute name structure to fill in.
-
getPrefix
Returns the prefix of the attribute at the specified index.- Parameters:
index
- The index of the attribute.
-
getURI
Look up an attribute's Namespace URI by index.- 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:
-
getLocalName
Look up an attribute's local name by index.- 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:
-
getQName
Look up an attribute's XML 1.0 qualified name by index.- 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:
-
setType
Sets the type of the attribute at the specified index.- 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)".
-
getType
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".
- 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:
-
getType
Look up an attribute's type by XML 1.0 qualified name.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.
-
getType
Look up an attribute's type by Namespace name.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.
-
setValue
Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.- Parameters:
attrIndex
- The attribute index.attrValue
- The new attribute value.- See Also:
-
getValue
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.
- 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:
-
getValue
Look up an attribute's value by XML 1.0 qualified name.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.
-
getValue
Look up an attribute's value by Namespace name.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.
-
setNonNormalizedValue
Sets the non-normalized value of the attribute at the specified index.- Parameters:
attrIndex
- The attribute index.attrValue
- The new non-normalized attribute value.
-
getNonNormalizedValue
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 thegetValue(int)
method.- Parameters:
attrIndex
- The attribute index.
-
setSpecified
void setSpecified(int attrIndex, boolean specified) Sets whether an attribute is specified in the instance document or not.- Parameters:
attrIndex
- The attribute index.specified
- True if the attribute is specified in the instance document.
-
isSpecified
boolean isSpecified(int attrIndex) Returns true if the attribute is specified in the instance document.- Parameters:
attrIndex
- The attribute index.
-
getAugmentations
Look up an augmentation by attribute's index.- Parameters:
attributeIndex
- The attribute index.- Returns:
- Augmentations
-
getAugmentations
Look up an augmentation by namespace name.- Parameters:
uri
- The Namespace URI, or the empty string if the name has no Namespace URI.localPart
-- Returns:
- Augmentations
-
getAugmentations
Look up an augmentation by XML 1.0 qualified name.- Parameters:
qName
- The XML 1.0 qualified name.- Returns:
- Augmentations
-
setAugmentations
Sets the augmentations of the attribute at the specified index.- Parameters:
attrIndex
- The attribute index.augs
- The augmentations.
-