Save This Page
Home » Xerces-J-src.2.9.1 » org.apache.xerces » util » [javadoc | source]
org.apache.xerces.util
public class: XMLAttributesImpl [javadoc | source]
java.lang.Object
   org.apache.xerces.util.XMLAttributesImpl

All Implemented Interfaces:
    XMLAttributes

The XMLAttributesImpl class is an implementation of the XMLAttributes interface which 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.

Nested Class Summary:
static class  XMLAttributesImpl.Attribute  Attribute information. 
Field Summary
protected static final  int TABLE_SIZE    Default table size. 
protected static final  int SIZE_LIMIT    Threshold at which an instance is treated as a large attribute list. 
protected  boolean fNamespaces    Namespaces. 
protected  int fLargeCount    Usage count for the attribute table view. Incremented each time all attributes are removed when the attribute table view is in use. 
protected  int fLength    Attribute count. 
protected  XMLAttributesImpl.Attribute[] fAttributes    Attribute information. 
protected  XMLAttributesImpl.Attribute[] fAttributeTableView    Hashtable of attribute information. Provides an alternate view of the attribute specification. 
protected  int[] fAttributeTableViewChainState    Tracks whether each chain in the hash table is stale with respect to the current state of this object. A chain is stale if its state is not the same as the number of times the attribute table view has been used. 
protected  int fTableViewBuckets    Actual number of buckets in the table view. 
protected  boolean fIsTableViewConsistent    Indicates whether the table view contains consistent data. 
Constructor:
 public XMLAttributesImpl() 
 public XMLAttributesImpl(int tableSize) 
Method from org.apache.xerces.util.XMLAttributesImpl Summary:
addAttribute,   addAttributeNS,   checkDuplicatesNS,   cleanTableView,   getAugmentations,   getAugmentations,   getAugmentations,   getIndex,   getIndex,   getIndexFast,   getIndexFast,   getLength,   getLocalName,   getName,   getName,   getNonNormalizedValue,   getPrefix,   getQName,   getSchemaId,   getSchemaId,   getSchemaId,   getTableViewBucket,   getTableViewBucket,   getType,   getType,   getType,   getURI,   getValue,   getValue,   getValue,   isSpecified,   prepareAndPopulateTableView,   prepareTableView,   removeAllAttributes,   removeAttributeAt,   setAugmentations,   setName,   setNamespaces,   setNonNormalizedValue,   setSchemaId,   setSpecified,   setType,   setURI,   setValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xerces.util.XMLAttributesImpl Detail:
 public int addAttribute(QName name,
    String type,
    String value) 
    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  void addAttributeNS(QName name,
    String type,
    String value) 
    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.

    This method differs from addAttribute in that it does not check if an attribute of the same name already exists in the list before adding it. In order to improve performance of namespace processing, this method allows uniqueness checks to be deferred until all the namespace information is available after the entire attribute specification has been read.

    Caution: If this method is called it should not be mixed with calls to addAttribute unless it has been determined that all the attribute names are unique.

 public QName checkDuplicatesNS() 
    Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification. If a duplicate is found its name is returned.

    This should be called once all the in-scope namespaces for the element enclosing these attributes is known, and after all the attributes have gone through namespace binding.

 protected  void cleanTableView() 
    Purges all elements from the table view.
 public Augmentations getAugmentations(String qName) 
    Look up an augmentation by XML 1.0 qualified name.

 public Augmentations getAugmentations(int attributeIndex) 
    Look up an augmentations by attributes index.
 public Augmentations getAugmentations(String uri,
    String localName) 
    Look up an augmentations 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 getIndexFast(String qName) 
    Look up the index of an attribute by XML 1.0 qualified name.

    Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.

 public int getIndexFast(String uri,
    String localPart) 
    Look up the index of an attribute by Namespace name.

    Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.

 public int getLength() 
    Return 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 String getName(int index) 
    Return the name of an attribute in this list (by position).

    The names must be unique: the SAX parser shall not include the same attribute twice. Attributes without values (those declared #IMPLIED without a value specified in the start tag) will be omitted from the list.

    If the attribute name has a namespace prefix, the prefix will still be attached.

 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 boolean getSchemaId(int index) 
 public boolean getSchemaId(String qname) 
 public boolean getSchemaId(String uri,
    String localName) 
 protected int getTableViewBucket(String qname) 
    Returns the position in the table view where the given attribute name would be hashed.
 protected int getTableViewBucket(String localpart,
    String uri) 
    Returns the position in the table view where the given attribute name would be hashed.
 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".

 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.
 protected  void prepareAndPopulateTableView() 
    Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.
 protected  void prepareTableView() 
    Prepares the table view of the attributes list for use.
 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 setNamespaces(boolean namespaces) 
    Sets whether namespace processing is being performed. This state is needed to return the correct value from the getLocalName method.
 public  void setNonNormalizedValue(int attrIndex,
    String attrValue) 
    Sets the non-normalized value of the attribute at the specified index.
 public  void setSchemaId(int attrIndex,
    boolean schemaId) 
 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 setURI(int attrIndex,
    String uri) 
    Sets the uri 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.