Class XMLAttributesImpl
- java.lang.Object
-
- org.apache.xerces.util.XMLAttributesImpl
-
- All Implemented Interfaces:
org.apache.xerces.xni.XMLAttributes
public class XMLAttributesImpl extends java.lang.Object implements org.apache.xerces.xni.XMLAttributesThe 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.
- Version:
- $Id: XMLAttributesImpl.java 1357381 2012-07-04 19:56:10Z mrglavas $
- Author:
- Andy Clark, IBM, Elena Litani, IBM, Michael Glavassevich, IBM
- See Also:
XMLDocumentHandler.startElement(org.apache.xerces.xni.QName, org.apache.xerces.xni.XMLAttributes, org.apache.xerces.xni.Augmentations)
-
-
Field Summary
Fields Modifier and Type Field Description protected org.apache.xerces.util.XMLAttributesImpl.Attribute[]fAttributesAttribute information.protected org.apache.xerces.util.XMLAttributesImpl.Attribute[]fAttributeTableViewHashtable of attribute information.protected int[]fAttributeTableViewChainStateTracks whether each chain in the hash table is stale with respect to the current state of this object.protected int[]fHashMultipliersArray of randomly selected hash function multipliers ornullif the default String.hashCode() function should be used.protected booleanfIsTableViewConsistentIndicates whether the table view contains consistent data.protected intfLargeCountUsage count for the attribute table view.protected intfLengthAttribute count.protected booleanfNamespacesNamespaces.protected intfTableViewBucketsActual number of buckets in the table view.protected static intMAX_HASH_COLLISIONSMaximum hash collisions per bucket.protected static intMULTIPLIERS_MASKprotected static intMULTIPLIERS_SIZEprotected static intSIZE_LIMITThreshold at which an instance is treated as a large attribute list.protected static intTABLE_SIZEDefault table size.
-
Constructor Summary
Constructors Constructor Description XMLAttributesImpl()Default constructor.XMLAttributesImpl(int tableSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intaddAttribute(org.apache.xerces.xni.QName name, java.lang.String type, java.lang.String value)Adds an attribute.voidaddAttributeNS(org.apache.xerces.xni.QName name, java.lang.String type, java.lang.String value)Adds an attribute.org.apache.xerces.xni.QNamecheckDuplicatesNS()Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification.protected voidcleanTableView()Purges all elements from the table view.org.apache.xerces.xni.AugmentationsgetAugmentations(int attributeIndex)Look up an augmentations by attributes index.org.apache.xerces.xni.AugmentationsgetAugmentations(java.lang.String qName)Look up an augmentation by XML 1.0 qualified name.org.apache.xerces.xni.AugmentationsgetAugmentations(java.lang.String uri, java.lang.String localName)Look up an augmentations by Namespace name.intgetIndex(java.lang.String qName)Look up the index of an attribute by XML 1.0 qualified name.intgetIndex(java.lang.String uri, java.lang.String localPart)Look up the index of an attribute by Namespace name.intgetIndexFast(java.lang.String qName)Look up the index of an attribute by XML 1.0 qualified name.intgetIndexFast(java.lang.String uri, java.lang.String localPart)Look up the index of an attribute by Namespace name.intgetLength()Return the number of attributes in the list.java.lang.StringgetLocalName(int index)Look up an attribute's local name by index.java.lang.StringgetName(int index)Return the name of an attribute in this list (by position).voidgetName(int attrIndex, org.apache.xerces.xni.QName attrName)Sets the fields in the given QName structure with the values of the attribute name at the specified index.java.lang.StringgetNonNormalizedValue(int attrIndex)Returns the non-normalized value of the attribute at the specified index.java.lang.StringgetPrefix(int index)Returns the prefix of the attribute at the specified index.java.lang.StringgetQName(int index)Look up an attribute's XML 1.0 qualified name by index.protected intgetTableViewBucket(java.lang.String qname)Returns the position in the table view where the given attribute name would be hashed.protected intgetTableViewBucket(java.lang.String localpart, java.lang.String uri)Returns the position in the table view where the given attribute name would be hashed.java.lang.StringgetType(int index)Look up an attribute's type by index.java.lang.StringgetType(java.lang.String qname)Look up an attribute's type by XML 1.0 qualified name.java.lang.StringgetType(java.lang.String uri, java.lang.String localName)Look up an attribute's type by Namespace name.java.lang.StringgetURI(int index)Look up an attribute's Namespace URI by index.java.lang.StringgetValue(int index)Look up an attribute's value by index.java.lang.StringgetValue(java.lang.String qname)Look up an attribute's value by XML 1.0 qualified name.java.lang.StringgetValue(java.lang.String uri, java.lang.String localName)Look up an attribute's value by Namespace name.booleanisSpecified(int attrIndex)Returns true if the attribute is specified in the instance document.protected voidprepareAndPopulateTableView()Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.protected voidprepareTableView()Prepares the table view of the attributes list for use.voidremoveAllAttributes()Removes all of the attributes.voidremoveAttributeAt(int attrIndex)Removes the attribute at the specified index.voidsetAugmentations(int attrIndex, org.apache.xerces.xni.Augmentations augs)Sets the augmentations of the attribute at the specified index.voidsetName(int attrIndex, org.apache.xerces.xni.QName attrName)Sets the name of the attribute at the specified index.voidsetNamespaces(boolean namespaces)Sets whether namespace processing is being performed.voidsetNonNormalizedValue(int attrIndex, java.lang.String attrValue)Sets the non-normalized value of the attribute at the specified index.voidsetSpecified(int attrIndex, boolean specified)Sets whether an attribute is specified in the instance document or not.voidsetType(int attrIndex, java.lang.String attrType)Sets the type of the attribute at the specified index.voidsetURI(int attrIndex, java.lang.String uri)Sets the uri of the attribute at the specified index.voidsetValue(int attrIndex, java.lang.String attrValue)Sets the value of the attribute at the specified index.
-
-
-
Field Detail
-
TABLE_SIZE
protected static final int TABLE_SIZE
Default table size.- See Also:
- Constant Field Values
-
MAX_HASH_COLLISIONS
protected static final int MAX_HASH_COLLISIONS
Maximum hash collisions per bucket.- See Also:
- Constant Field Values
-
MULTIPLIERS_SIZE
protected static final int MULTIPLIERS_SIZE
- See Also:
- Constant Field Values
-
MULTIPLIERS_MASK
protected static final int MULTIPLIERS_MASK
- See Also:
- Constant Field Values
-
SIZE_LIMIT
protected static final int SIZE_LIMIT
Threshold at which an instance is treated as a large attribute list.- See Also:
- Constant Field Values
-
fNamespaces
protected boolean fNamespaces
Namespaces.
-
fLargeCount
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.
-
fLength
protected int fLength
Attribute count.
-
fAttributes
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributes
Attribute information.
-
fAttributeTableView
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributeTableView
Hashtable of attribute information. Provides an alternate view of the attribute specification.
-
fAttributeTableViewChainState
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.
-
fTableViewBuckets
protected int fTableViewBuckets
Actual number of buckets in the table view.
-
fIsTableViewConsistent
protected boolean fIsTableViewConsistent
Indicates whether the table view contains consistent data.
-
fHashMultipliers
protected int[] fHashMultipliers
Array of randomly selected hash function multipliers ornullif the default String.hashCode() function should be used.
-
-
Method Detail
-
setNamespaces
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.- Parameters:
namespaces- True if namespace processing is turned on.- See Also:
getLocalName(int)
-
addAttribute
public int addAttribute(org.apache.xerces.xni.QName name, java.lang.String type, java.lang.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 thesetNonNormalizedValuemethod. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using thesetSpecifiedmethod.Note: If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.
- Specified by:
addAttributein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
name- The attribute name.type- 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)".value- The attribute value.- Returns:
- Returns the attribute index.
- See Also:
setNonNormalizedValue(int, java.lang.String),setSpecified(int, boolean)
-
removeAllAttributes
public void removeAllAttributes()
Removes all of the attributes. This method will also remove all entities associated to the attributes.- Specified by:
removeAllAttributesin interfaceorg.apache.xerces.xni.XMLAttributes
-
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.
- Specified by:
removeAttributeAtin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.
-
setName
public void setName(int attrIndex, org.apache.xerces.xni.QName attrName)Sets the name of the attribute at the specified index.- Specified by:
setNamein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.attrName- The new attribute name.
-
getName
public void getName(int attrIndex, org.apache.xerces.xni.QName attrName)Sets the fields in the given QName structure with the values of the attribute name at the specified index.- Specified by:
getNamein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.attrName- The attribute name structure to fill in.
-
setType
public void setType(int attrIndex, java.lang.String attrType)Sets the type of the attribute at the specified index.- Specified by:
setTypein interfaceorg.apache.xerces.xni.XMLAttributes- 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)".
-
setValue
public void setValue(int attrIndex, java.lang.String attrValue)Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.- Specified by:
setValuein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.attrValue- The new attribute value.- See Also:
setNonNormalizedValue(int, java.lang.String)
-
setNonNormalizedValue
public void setNonNormalizedValue(int attrIndex, java.lang.String attrValue)Sets the non-normalized value of the attribute at the specified index.- Specified by:
setNonNormalizedValuein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.attrValue- The new non-normalized attribute value.
-
getNonNormalizedValue
public java.lang.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 thegetValue(int)method.- Specified by:
getNonNormalizedValuein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.
-
setSpecified
public void setSpecified(int attrIndex, boolean specified)Sets whether an attribute is specified in the instance document or not.- Specified by:
setSpecifiedin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.specified- True if the attribute is specified in the instance document.
-
isSpecified
public boolean isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document.- Specified by:
isSpecifiedin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.
-
getLength
public int getLength()
Return the number of attributes in the list.Once you know the number of attributes, you can iterate through the list.
- Specified by:
getLengthin interfaceorg.apache.xerces.xni.XMLAttributes- Returns:
- The number of attributes in the list.
- See Also:
XMLAttributes.getURI(int),XMLAttributes.getLocalName(int),XMLAttributes.getQName(int),XMLAttributes.getType(int),XMLAttributes.getValue(int)
-
getType
public java.lang.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".
- Specified by:
getTypein interfaceorg.apache.xerces.xni.XMLAttributes- 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:
getLength()
-
getType
public java.lang.String getType(java.lang.String qname)
Look up an attribute's type by XML 1.0 qualified name.See
getType(int)for a description of the possible types.- Specified by:
getTypein interfaceorg.apache.xerces.xni.XMLAttributes- 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.
-
getValue
public java.lang.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.
- Specified by:
getValuein interfaceorg.apache.xerces.xni.XMLAttributes- 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:
getLength()
-
getValue
public java.lang.String getValue(java.lang.String qname)
Look up an attribute's value by XML 1.0 qualified name.See
getValue(int)for a description of the possible values.- Specified by:
getValuein interfaceorg.apache.xerces.xni.XMLAttributes- 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.
-
getName
public java.lang.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.
- Parameters:
index- The index of the attribute in the list (starting at 0).- Returns:
- The name of the indexed attribute, or null if the index is out of range.
- See Also:
getLength()
-
getIndex
public int getIndex(java.lang.String qName)
Look up the index of an attribute by XML 1.0 qualified name.- Specified by:
getIndexin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
qName- The qualified (prefixed) name.- Returns:
- The index of the attribute, or -1 if it does not appear in the list.
-
getIndex
public int getIndex(java.lang.String uri, java.lang.String localPart)Look up the index of an attribute by Namespace name.- Specified by:
getIndexin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
uri- The Namespace URI, or null 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.
-
getLocalName
public java.lang.String getLocalName(int index)
Look up an attribute's local name by index.- Specified by:
getLocalNamein interfaceorg.apache.xerces.xni.XMLAttributes- 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:
getLength()
-
getQName
public java.lang.String getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.- Specified by:
getQNamein interfaceorg.apache.xerces.xni.XMLAttributes- 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:
getLength()
-
getType
public java.lang.String getType(java.lang.String uri, java.lang.String localName)Look up an attribute's type by Namespace name.See
getType(int)for a description of the possible types.- Specified by:
getTypein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
uri- The Namespace URI, or null 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.
-
getPrefix
public java.lang.String getPrefix(int index)
Returns the prefix of the attribute at the specified index.- Specified by:
getPrefixin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
index- The index of the attribute.
-
getURI
public java.lang.String getURI(int index)
Look up an attribute's Namespace URI by index.- Specified by:
getURIin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
index- The attribute index (zero-based).- Returns:
- The Namespace URI
- See Also:
getLength()
-
getValue
public java.lang.String getValue(java.lang.String uri, java.lang.String localName)Look up an attribute's value by Namespace name.See
getValue(int)for a description of the possible values.- Specified by:
getValuein interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
uri- The Namespace URI, or null if thelocalName- The local name of the attribute.- Returns:
- The attribute value as a string, or null if the attribute is not in the list.
-
getAugmentations
public org.apache.xerces.xni.Augmentations getAugmentations(java.lang.String uri, java.lang.String localName)Look up an augmentations by Namespace name.- Specified by:
getAugmentationsin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
uri- The Namespace URI, or null if thelocalName- The local name of the attribute.- Returns:
- Augmentations
-
getAugmentations
public org.apache.xerces.xni.Augmentations getAugmentations(java.lang.String qName)
Look up an augmentation by XML 1.0 qualified name.- Specified by:
getAugmentationsin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
qName- The XML 1.0 qualified name.- Returns:
- Augmentations
-
getAugmentations
public org.apache.xerces.xni.Augmentations getAugmentations(int attributeIndex)
Look up an augmentations by attributes index.- Specified by:
getAugmentationsin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attributeIndex- The attribute index.- Returns:
- Augmentations
-
setAugmentations
public void setAugmentations(int attrIndex, org.apache.xerces.xni.Augmentations augs)Sets the augmentations of the attribute at the specified index.- Specified by:
setAugmentationsin interfaceorg.apache.xerces.xni.XMLAttributes- Parameters:
attrIndex- The attribute index.augs- The augmentations.
-
setURI
public void setURI(int attrIndex, java.lang.String uri)Sets the uri of the attribute at the specified index.- Parameters:
attrIndex- The attribute index.uri- Namespace uri
-
getIndexFast
public int getIndexFast(java.lang.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.
- Parameters:
qName- The qualified (prefixed) name.- Returns:
- The index of the attribute, or -1 if it does not appear in the list.
-
addAttributeNS
public void addAttributeNS(org.apache.xerces.xni.QName name, java.lang.String type, java.lang.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 thesetNonNormalizedValuemethod. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using thesetSpecifiedmethod.This method differs from
addAttributein 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
addAttributeunless it has been determined that all the attribute names are unique.- Parameters:
name- the attribute nametype- the attribute typevalue- the attribute value- See Also:
setNonNormalizedValue(int, java.lang.String),setSpecified(int, boolean),checkDuplicatesNS()
-
checkDuplicatesNS
public org.apache.xerces.xni.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.
- Returns:
- the name of a duplicate attribute found in the search, otherwise null.
-
getIndexFast
public int getIndexFast(java.lang.String uri, java.lang.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.
- Parameters:
uri- The Namespace URI, or null 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.
-
getTableViewBucket
protected int getTableViewBucket(java.lang.String qname)
Returns the position in the table view where the given attribute name would be hashed.- Parameters:
qname- the attribute name- Returns:
- the position in the table view where the given attribute would be hashed
-
getTableViewBucket
protected int getTableViewBucket(java.lang.String localpart, java.lang.String uri)Returns the position in the table view where the given attribute name would be hashed.- Parameters:
localpart- the local part of the attributeuri- the namespace name of the attribute- Returns:
- the position in the table view where the given attribute would be hashed
-
cleanTableView
protected void cleanTableView()
Purges all elements from the table view.
-
prepareTableView
protected void prepareTableView()
Prepares the table view of the attributes list for use.
-
prepareAndPopulateTableView
protected void prepareAndPopulateTableView()
Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.
-
-