Class XMLAttributesImpl
- All Implemented Interfaces:
org.apache.xerces.xni.XMLAttributes
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.apache.xerces.util.XMLAttributesImpl.Attribute[]
Attribute information.protected org.apache.xerces.util.XMLAttributesImpl.Attribute[]
Hashtable of attribute information.protected int[]
Tracks whether each chain in the hash table is stale with respect to the current state of this object.protected int[]
Array of randomly selected hash function multipliers ornull
if the default String.hashCode() function should be used.protected boolean
Indicates whether the table view contains consistent data.protected int
Usage count for the attribute table view.protected int
Attribute count.protected boolean
Namespaces.protected int
Actual number of buckets in the table view.protected static final int
Maximum hash collisions per bucket.protected static final int
protected static final int
protected static final int
Threshold at which an instance is treated as a large attribute list.protected static final int
Default table size. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
addAttribute
(org.apache.xerces.xni.QName name, String type, String value) Adds an attribute.void
addAttributeNS
(org.apache.xerces.xni.QName name, String type, String value) Adds an attribute.org.apache.xerces.xni.QName
Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification.protected void
Purges all elements from the table view.org.apache.xerces.xni.Augmentations
getAugmentations
(int attributeIndex) Look up an augmentations by attributes index.org.apache.xerces.xni.Augmentations
getAugmentations
(String qName) Look up an augmentation by XML 1.0 qualified name.org.apache.xerces.xni.Augmentations
getAugmentations
(String uri, String localName) Look up an augmentations 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
getIndexFast
(String qName) Look up the index of an attribute by XML 1.0 qualified name.int
getIndexFast
(String uri, String localPart) Look up the index of an attribute by Namespace name.int
Return the number of attributes in the list.getLocalName
(int index) Look up an attribute's local name by index.getName
(int index) Return the name of an attribute in this list (by position).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.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.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.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.protected void
Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.protected void
Prepares the table view of the attributes list for use.void
Removes all of the attributes.void
removeAttributeAt
(int attrIndex) Removes the attribute at the specified index.void
setAugmentations
(int attrIndex, org.apache.xerces.xni.Augmentations augs) Sets the augmentations of the attribute at the specified index.void
setName
(int attrIndex, org.apache.xerces.xni.QName attrName) Sets the name of the attribute at the specified index.void
setNamespaces
(boolean namespaces) Sets whether namespace processing is being performed.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 uri of the attribute at the specified index.void
Sets the value of the attribute at the specified index.
-
Field Details
-
TABLE_SIZE
protected static final int TABLE_SIZEDefault table size.- See Also:
-
MAX_HASH_COLLISIONS
protected static final int MAX_HASH_COLLISIONSMaximum hash collisions per bucket.- See Also:
-
MULTIPLIERS_SIZE
protected static final int MULTIPLIERS_SIZE- See Also:
-
MULTIPLIERS_MASK
protected static final int MULTIPLIERS_MASK- See Also:
-
SIZE_LIMIT
protected static final int SIZE_LIMITThreshold at which an instance is treated as a large attribute list.- See Also:
-
fNamespaces
protected boolean fNamespacesNamespaces. -
fLargeCount
protected int fLargeCountUsage count for the attribute table view. Incremented each time all attributes are removed when the attribute table view is in use. -
fLength
protected int fLengthAttribute count. -
fAttributes
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributesAttribute information. -
fAttributeTableView
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributeTableViewHashtable of attribute information. Provides an alternate view of the attribute specification. -
fAttributeTableViewChainState
protected int[] fAttributeTableViewChainStateTracks 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 fTableViewBucketsActual number of buckets in the table view. -
fIsTableViewConsistent
protected boolean fIsTableViewConsistentIndicates whether the table view contains consistent data. -
fHashMultipliers
protected int[] fHashMultipliersArray of randomly selected hash function multipliers ornull
if the default String.hashCode() function should be used.
-
-
Constructor Details
-
XMLAttributesImpl
public XMLAttributesImpl()Default constructor. -
XMLAttributesImpl
public XMLAttributesImpl(int tableSize) - Parameters:
tableSize
- initial size of table view
-
-
Method Details
-
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:
-
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.
- Specified by:
addAttribute
in 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:
-
removeAllAttributes
public void removeAllAttributes()Removes all of the attributes. This method will also remove all entities associated to the attributes.- Specified by:
removeAllAttributes
in 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:
removeAttributeAt
in 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:
setName
in 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:
getName
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
attrIndex
- The attribute index.attrName
- The attribute name structure to fill in.
-
setType
Sets the type of the attribute at the specified index.- Specified by:
setType
in 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
Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.- Specified by:
setValue
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
attrIndex
- The attribute index.attrValue
- The new attribute value.- See Also:
-
setNonNormalizedValue
Sets the non-normalized value of the attribute at the specified index.- Specified by:
setNonNormalizedValue
in interfaceorg.apache.xerces.xni.XMLAttributes
- 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.- Specified by:
getNonNormalizedValue
in 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:
setSpecified
in 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:
isSpecified
in 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:
getLength
in interfaceorg.apache.xerces.xni.XMLAttributes
- Returns:
- The number of attributes in the list.
- See Also:
-
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 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:
getType
in 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:
-
getType
Look up an attribute's type by XML 1.0 qualified name.See
getType(int)
for a description of the possible types.- Specified by:
getType
in 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
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:
getValue
in 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:
-
getValue
Look up an attribute's value by XML 1.0 qualified name.See
getValue(int)
for a description of the possible values.- Specified by:
getValue
in 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
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:
-
getIndex
Look up the index of an attribute by XML 1.0 qualified name.- Specified by:
getIndex
in 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
Look up the index of an attribute by Namespace name.- Specified by:
getIndex
in 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
Look up an attribute's local name by index.- Specified by:
getLocalName
in 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:
-
getQName
Look up an attribute's XML 1.0 qualified name by index.- Specified by:
getQName
in 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:
-
getType
Look up an attribute's type by Namespace name.See
getType(int)
for a description of the possible types.- Specified by:
getType
in 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
Returns the prefix of the attribute at the specified index.- Specified by:
getPrefix
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
index
- The index of the attribute.
-
getURI
Look up an attribute's Namespace URI by index.- Specified by:
getURI
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- The Namespace URI
- See Also:
-
getValue
Look up an attribute's value by Namespace name.See
getValue(int)
for a description of the possible values.- Specified by:
getValue
in 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
Look up an augmentations by Namespace name.- Specified by:
getAugmentations
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
uri
- The Namespace URI, or null if thelocalName
- The local name of the attribute.- Returns:
- Augmentations
-
getAugmentations
Look up an augmentation by XML 1.0 qualified name.- Specified by:
getAugmentations
in 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:
getAugmentations
in 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:
setAugmentations
in interfaceorg.apache.xerces.xni.XMLAttributes
- Parameters:
attrIndex
- The attribute index.augs
- The augmentations.
-
setURI
Sets the uri of the attribute at the specified index.- Parameters:
attrIndex
- The attribute index.uri
- Namespace uri
-
getIndexFast
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
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.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.- Parameters:
name
- the attribute nametype
- the attribute typevalue
- the attribute value- See Also:
-
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
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
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
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.
-