| com.sun.xml.stream.xerces.xni.XMLAttributes
All known Subclasses: com.sun.xml.stream.xerces.util.XMLAttributesImpl, com.sun.xml.stream.xerces.util.STAXAttributesImpl,
| XMLAttributes | | public interface XMLAttributes (Code) | | 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
propogated to the next stage.
See Also: XMLDocumentHandler.startElement
author:
Andy Clark, IBM
version:
$Id: XMLAttributes.java,v 1.2 2006/04/01 06:01:46 jeffsuttor Exp $ |
| Method Summary | |
| public int | addAttribute(QName attrName, String attrType, String attrValue)
Adds an attribute. | | public Augmentations | getAugmentations(int attributeIndex)
Look up an augmentation by attribute's index.
Parameters:
attributeIndex - The attribute index. | | public Augmentations | getAugmentations(String uri, String localPart)
Look up an augmentation by namespace name. | | public Augmentations | getAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.
Parameters:
qName - The XML 1.0 qualified name. | | public int | getIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
Parameters:
qName - The qualified (prefixed) name. | | public int | getIndex(String uri, String localPart)
Look up the index of an attribute by Namespace name.
Parameters:
uri - The Namespace URI, or the empty string ifthe name has no Namespace URI.
Parameters:
localName - The attribute's local name. | | public int | getLength()
Returns the number of attributes in the list. | | public String | getLocalName(int index)
Look up an attribute's local name by index.
Parameters:
index - The attribute index (zero-based). | | 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. | | public String | getNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified
index. | | public String | getPrefix(int index)
Returns the prefix of the attribute at the specified index. | | public String | getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
Parameters:
index - The attribute index (zero-based). | | public QName | getQualifiedName(int index)
| | 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 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). | | public String | getType(String qName)
Look up an attribute's type by XML 1.0 qualified name.
See
XMLAttributes.getType(int) getType(int) for a description
of the possible types.
Parameters:
qName - The XML 1.0 qualified name. | | public String | getType(String uri, String localName)
Look up an attribute's type by Namespace name.
See
XMLAttributes.getType(int) getType(int) for a description
of the possible types.
Parameters:
uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. | | public String | getURI(int index)
Look up an attribute's Namespace URI by index.
Parameters:
index - The attribute index (zero-based). | | 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.
Parameters:
index - The attribute index (zero-based). | | public String | getValue(String qName)
Look up an attribute's value by XML 1.0 qualified name.
See
XMLAttributes.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
qName - The XML 1.0 qualified name. | | public String | getValue(String uri, String localName)
Look up an attribute's value by Namespace name.
See
XMLAttributes.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. | | public boolean | isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document. | | public void | removeAllAttributes()
Removes all of the attributes. | | public void | removeAttributeAt(int attrIndex)
Removes the attribute at the specified index. | | public void | setName(int attrIndex, QName attrName)
Sets the name of the attribute at the specified index. | | public void | setNonNormalizedValue(int attrIndex, String attrValue)
Sets the non-normalized value of the attribute at the specified
index. | | public void | setSpecified(int attrIndex, boolean specified)
Sets whether an attribute is specified in the instance document
or not. | | public void | setType(int attrIndex, String attrType)
Sets the type of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrType - The attribute type. | | public void | setValue(int attrIndex, String attrValue)
Sets the value of the attribute at the specified index. |
| addAttribute | | public int addAttribute(QName attrName, String attrType, String attrValue)(Code) | | 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.
Parameters:
attrName - The attribute name.
Parameters:
attrType - The attribute type. The type name is determined bythe type specified for this attribute in the DTD.For example: "CDATA", "ID", "NMTOKEN", etc. However,attributes of type enumeration will have the typevalue specified as the pipe ('|') separated list ofthe enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis.For example: "(true|false)".
Parameters:
attrValue - The attribute value. Returns the attribute index.
See Also: XMLAttributes.setNonNormalizedValue
See Also: XMLAttributes.setSpecified |
| getAugmentations | | public Augmentations getAugmentations(int attributeIndex)(Code) | | Look up an augmentation by attribute's index.
Parameters:
attributeIndex - The attribute index. Augmentations |
| getAugmentations | | public Augmentations getAugmentations(String uri, String localPart)(Code) | | Look up an augmentation by namespace name.
Parameters:
uri - The Namespace URI, or the empty string ifthe name has no Namespace URI.
Parameters:
localPart - Augmentations |
| getAugmentations | | public Augmentations getAugmentations(String qName)(Code) | | Look up an augmentation by XML 1.0 qualified name.
Parameters:
qName - The XML 1.0 qualified name. Augmentations |
| getIndex | | public int getIndex(String qName)(Code) | | Look up the index of an attribute by XML 1.0 qualified name.
Parameters:
qName - The qualified (prefixed) name. The index of the attribute, or -1 if it does notappear in the list. |
| getIndex | | public int getIndex(String uri, String localPart)(Code) | | Look up the index of an attribute by Namespace name.
Parameters:
uri - The Namespace URI, or the empty string ifthe name has no Namespace URI.
Parameters:
localName - The attribute's local name. The index of the attribute, or -1 if it does notappear in the list. |
| getLocalName | | public String getLocalName(int index)(Code) | | Look up an attribute's local name by index.
Parameters:
index - The attribute index (zero-based). The local name, or the empty string if Namespaceprocessing is not being performed, or nullif the index is out of range.
See Also: XMLAttributes.getLength |
| getName | | public void getName(int attrIndex, QName attrName)(Code) | | Sets the fields in the given QName structure with the values
of the attribute name at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrName - The attribute name structure to fill in. |
| getNonNormalizedValue | | public String getNonNormalizedValue(int attrIndex)(Code) | | 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.
Parameters:
attrIndex - The attribute index. |
| getPrefix | | public String getPrefix(int index)(Code) | | Returns the prefix of the attribute at the specified index.
Parameters:
index - The index of the attribute. |
| getQName | | public String getQName(int index)(Code) | | Look up an attribute's XML 1.0 qualified name by index.
Parameters:
index - The attribute index (zero-based). The XML 1.0 qualified name, or the empty stringif none is available, or null if the indexis out of range.
See Also: XMLAttributes.getLength |
| getQualifiedName | | public QName getQualifiedName(int index)(Code) | | |
| getType | | public String getType(int index)(Code) | | 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 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). The attribute's type as a string, or null if theindex is out of range.
See Also: XMLAttributes.getLength |
| getType | | public String getType(String qName)(Code) | | Look up an attribute's type by XML 1.0 qualified name.
See
XMLAttributes.getType(int) getType(int) for a description
of the possible types.
Parameters:
qName - The XML 1.0 qualified name. The attribute type as a string, or null if theattribute is not in the list or if qualified namesare not available. |
| getType | | public String getType(String uri, String localName)(Code) | | Look up an attribute's type by Namespace name.
See
XMLAttributes.getType(int) getType(int) for a description
of the possible types.
Parameters:
uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. The attribute type as a string, or null if theattribute is not in the list or if Namespaceprocessing is not being performed. |
| getURI | | public String getURI(int index)(Code) | | Look up an attribute's Namespace URI by index.
Parameters:
index - The attribute index (zero-based). The Namespace URI, or the empty string if noneis available, or null if the index is out ofrange.
See Also: XMLAttributes.getLength |
| getValue | | public String getValue(int index)(Code) | | 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). The attribute's value as a string, or null if theindex is out of range.
See Also: XMLAttributes.getLength |
| getValue | | public String getValue(String qName)(Code) | | Look up an attribute's value by XML 1.0 qualified name.
See
XMLAttributes.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
qName - The XML 1.0 qualified name. The attribute value as a string, or null if theattribute is not in the list or if qualified namesare not available. |
| getValue | | public String getValue(String uri, String localName)(Code) | | Look up an attribute's value by Namespace name.
See
XMLAttributes.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
uri - The Namespace URI, or the empty String if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. The attribute value as a string, or null if theattribute is not in the list. |
| isSpecified | | public boolean isSpecified(int attrIndex)(Code) | | Returns true if the attribute is specified in the instance document.
Parameters:
attrIndex - The attribute index. |
| removeAllAttributes | | public void removeAllAttributes()(Code) | | Removes all of the attributes. This method will also remove all
entities associated to the attributes.
|
| removeAttributeAt | | public void removeAttributeAt(int attrIndex)(Code) | | 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. |
| setName | | public void setName(int attrIndex, QName attrName)(Code) | | Sets the name of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrName - The new attribute name. |
| setNonNormalizedValue | | public void setNonNormalizedValue(int attrIndex, String attrValue)(Code) | | Sets the non-normalized value of the attribute at the specified
index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrValue - The new non-normalized attribute value. |
| setSpecified | | public void setSpecified(int attrIndex, boolean specified)(Code) | | Sets whether an attribute is specified in the instance document
or not.
Parameters:
attrIndex - The attribute index.
Parameters:
specified - True if the attribute is specified in the instancedocument. |
| setType | | public void setType(int attrIndex, String attrType)(Code) | | Sets the type of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrType - The attribute type. The type name is determined bythe type specified for this attribute in the DTD.For example: "CDATA", "ID", "NMTOKEN", etc. However,attributes of type enumeration will have the typevalue specified as the pipe ('|') separated list ofthe 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)(Code) | | 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.
Parameters:
attrValue - The new attribute value.
See Also: XMLAttributes.setNonNormalizedValue |
|
|