Save This Page
Home » Xerces-J-src.2.9.1 » org.apache.xerces » xni » [javadoc | source]
org.apache.xerces.xni
public interface: XMLAttributes [javadoc | source]

All Known Implementing Classes:
    XMLAttributesProxy, XMLAttributesImpl

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.

Method from org.apache.xerces.xni.XMLAttributes Summary:
addAttribute,   getAugmentations,   getAugmentations,   getAugmentations,   getIndex,   getIndex,   getLength,   getLocalName,   getName,   getNonNormalizedValue,   getPrefix,   getQName,   getType,   getType,   getType,   getURI,   getValue,   getValue,   getValue,   isSpecified,   removeAllAttributes,   removeAttributeAt,   setAugmentations,   setName,   setNonNormalizedValue,   setSpecified,   setType,   setValue
Method from org.apache.xerces.xni.XMLAttributes Detail:
 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.
 public Augmentations getAugmentations(int attributeIndex)
    Look up an augmentation by attribute's index.
 public Augmentations getAugmentations(String qName)
    Look up an augmentation by XML 1.0 qualified name.

 public Augmentations getAugmentations(String uri,
    String localPart)
    Look up an augmentation by namespace name.
 public int getIndex(String qName)
    Look up the index of an attribute by XML 1.0 qualified name.
 public int getIndex(String uri,
    String localPart)
    Look up the index of an attribute by Namespace name.
 public int getLength()
    Returns the number of attributes in the list.

    
Once you know the number of attributes, you can iterate
through the list.
 public String getLocalName(int index)
    Look up an attribute's local name by index.
 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. If no non-normalized value is set, this method will return
the same value as the getValue(int) method.
 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.
 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".
 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.
 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.
 public String getURI(int index)
    Look up an attribute's Namespace URI by index.
 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.
 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.
 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.
 public boolean isSpecified(int attrIndex)
    Returns true if the attribute is specified in the instance document.
 public  void removeAllAttributes()
    Removes all of the attributes. This method will also remove all
entities associated to the attributes.
 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.
 public  void setAugmentations(int attrIndex,
    Augmentations augs)
    Sets the augmentations of 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.
 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.