org.apache.xerces.util

Class XMLAttributesImpl

public class XMLAttributesImpl extends Object implements 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.

Version: $Id: XMLAttributesImpl.java,v 1.26 2004/03/25 04:03:22 mrglavas Exp $

Author: Andy Clark, IBM Elena Litani, IBM Michael Glavassevich, IBM

See Also: org.apache.xerces.xni.XMLDocumentHandler#startElement

Field Summary
protected XMLAttributesImpl.Attribute[]fAttributes
Attribute information.
protected XMLAttributesImpl.Attribute[]fAttributeTableView
Hashtable of attribute information.
protected int[]fAttributeTableViewChainState
Tracks whether each chain in the hash table is stale with respect to the current state of this object.
protected booleanfIsTableViewConsistent
Indicates whether the table view contains consistent data.
protected intfLargeCount
Usage count for the attribute table view.
protected intfLength
Attribute count.
protected booleanfNamespaces
Namespaces.
protected intfTableViewBuckets
Actual number of buckets in the table view.
protected static intSIZE_LIMIT
Threshold at which an instance is treated as a large attribute list.
protected static intTABLE_SIZE
Default table size.
Constructor Summary
XMLAttributesImpl()
Default constructor.
XMLAttributesImpl(int tableSize)
Method Summary
intaddAttribute(QName name, String type, String value)
Adds an attribute.
voidaddAttributeNS(QName name, String type, String value)
Adds an attribute.
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.
AugmentationsgetAugmentations(String uri, String localName)
Look up an augmentations by Namespace name.
AugmentationsgetAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.
AugmentationsgetAugmentations(int attributeIndex)
Look up an augmentations by attributes index.
intgetIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
intgetIndex(String uri, String localPart)
Look up the index of an attribute by Namespace name.
intgetIndexFast(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
intgetIndexFast(String uri, String localPart)
Look up the index of an attribute by Namespace name.
intgetLength()
Return the number of attributes in the list.
StringgetLocalName(int index)
Look up an attribute's local name by index.
voidgetName(int attrIndex, QName attrName)
Sets the fields in the given QName structure with the values of the attribute name at the specified index.
StringgetName(int index)
Return the name of an attribute in this list (by position).
StringgetNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified index.
StringgetPrefix(int index)
Returns the prefix of the attribute at the specified index.
StringgetQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
booleangetSchemaId(int index)
booleangetSchemaId(String qname)
booleangetSchemaId(String uri, String localName)
protected intgetTableViewBucket(String qname)
Returns the position in the table view where the given attribute name would be hashed.
protected intgetTableViewBucket(String localpart, String uri)
Returns the position in the table view where the given attribute name would be hashed.
StringgetType(int index)
Look up an attribute's type by index.
StringgetType(String qname)
Look up an attribute's type by XML 1.0 qualified name.
StringgetType(String uri, String localName)
Look up an attribute's type by Namespace name.
StringgetURI(int index)
Look up an attribute's Namespace URI by index.
StringgetValue(int index)
Look up an attribute's value by index.
StringgetValue(String qname)
Look up an attribute's value by XML 1.0 qualified name.
StringgetValue(String uri, 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, Augmentations augs)
Sets the augmentations of the attribute at the specified index.
voidsetName(int attrIndex, 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, String attrValue)
Sets the non-normalized value of the attribute at the specified index.
voidsetSchemaId(int attrIndex, boolean schemaId)
voidsetSpecified(int attrIndex, boolean specified)
Sets whether an attribute is specified in the instance document or not.
voidsetType(int attrIndex, String attrType)
Sets the type of the attribute at the specified index.
voidsetURI(int attrIndex, String uri)
Sets the uri of the attribute at the specified index.
voidsetValue(int attrIndex, String attrValue)
Sets the value of the attribute at the specified index.

Field Detail

fAttributes

protected XMLAttributesImpl.Attribute[] fAttributes
Attribute information.

fAttributeTableView

protected 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.

fIsTableViewConsistent

protected boolean fIsTableViewConsistent
Indicates whether the table view contains consistent data.

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.

fNamespaces

protected boolean fNamespaces
Namespaces.

fTableViewBuckets

protected int fTableViewBuckets
Actual number of buckets in the table view.

SIZE_LIMIT

protected static final int SIZE_LIMIT
Threshold at which an instance is treated as a large attribute list.

TABLE_SIZE

protected static final int TABLE_SIZE
Default table size.

Constructor Detail

XMLAttributesImpl

public XMLAttributesImpl()
Default constructor.

XMLAttributesImpl

public XMLAttributesImpl(int tableSize)

Parameters: tableSize initial size of table view

Method Detail

addAttribute

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.

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: XMLAttributesImpl XMLAttributesImpl

addAttributeNS

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.

Parameters: name the attribute name type the attribute type value the attribute value

See Also: XMLAttributesImpl XMLAttributesImpl XMLAttributesImpl

checkDuplicatesNS

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.

Returns: the name of a duplicate attribute found in the search, otherwise null.

cleanTableView

protected void cleanTableView()
Purges all elements from the table view.

getAugmentations

public Augmentations getAugmentations(String uri, String localName)
Look up an augmentations by Namespace name.

Parameters: uri The Namespace URI, or null if the localName The local name of the attribute.

Returns: Augmentations

getAugmentations

public Augmentations getAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.

Parameters: qName The XML 1.0 qualified name.

Returns: Augmentations

getAugmentations

public Augmentations getAugmentations(int attributeIndex)
Look up an augmentations by attributes index.

Parameters: attributeIndex The attribute index.

Returns: Augmentations

getIndex

public int getIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.

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(String uri, String localPart)
Look up the index of an attribute by Namespace name.

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.

getIndexFast

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.

Parameters: qName The qualified (prefixed) name.

Returns: The index of the attribute, or -1 if it does not appear in the list.

getIndexFast

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.

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.

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.

Returns: The number of attributes in the list.

getLocalName

public String getLocalName(int index)
Look up an attribute's local name by index.

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: XMLAttributesImpl

getName

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.

Parameters: attrIndex The attribute index. attrName The attribute name structure to fill in.

getName

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.

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: XMLAttributesImpl

getNonNormalizedValue

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.

Parameters: attrIndex The attribute index.

getPrefix

public String getPrefix(int index)
Returns the prefix of the attribute at the specified index.

Parameters: index The index of the attribute.

getQName

public String getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.

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: XMLAttributesImpl

getSchemaId

public boolean getSchemaId(int index)

getSchemaId

public boolean getSchemaId(String qname)

getSchemaId

public boolean getSchemaId(String uri, String localName)

getTableViewBucket

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

Parameters: localpart the local part of the attribute uri the namespace name of the attribute

Returns: the position in the table view where the given attribute would be hashed

getType

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).

Returns: The attribute's type as a string, or null if the index is out of range.

See Also: XMLAttributesImpl

getType

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.

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.

getType

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.

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.

getURI

public String getURI(int index)
Look up an attribute's Namespace URI by index.

Parameters: index The attribute index (zero-based).

Returns: The Namespace URI

See Also: XMLAttributesImpl

getValue

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).

Returns: The attribute's value as a string, or null if the index is out of range.

See Also: XMLAttributesImpl

getValue

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.

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.

getValue

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.

Parameters: uri The Namespace URI, or null if the localName The local name of the attribute.

Returns: The attribute value as a string, or null if the attribute is not in the list.

isSpecified

public boolean isSpecified(int attrIndex)
Returns true if the attribute is specified in the instance document.

Parameters: attrIndex The attribute index.

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.

prepareTableView

protected void prepareTableView()
Prepares the table view of the attributes list for use.

removeAllAttributes

public void removeAllAttributes()
Removes all of the attributes. This method will also remove all entities associated to the attributes.

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.

Parameters: attrIndex The attribute index.

setAugmentations

public void setAugmentations(int attrIndex, Augmentations augs)
Sets the augmentations of the attribute at the specified index.

Parameters: attrIndex The attribute index. augs The augmentations.

setName

public void setName(int attrIndex, QName attrName)
Sets the name of the attribute at the specified index.

Parameters: attrIndex The attribute index. attrName The new attribute name.

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: XMLAttributesImpl

setNonNormalizedValue

public void setNonNormalizedValue(int attrIndex, String attrValue)
Sets the non-normalized value of the attribute at the specified index.

Parameters: attrIndex The attribute index. attrValue The new non-normalized attribute value.

setSchemaId

public void setSchemaId(int attrIndex, boolean schemaId)

setSpecified

public void setSpecified(int attrIndex, boolean specified)
Sets whether an attribute is specified in the instance document or not.

Parameters: attrIndex The attribute index. specified True if the attribute is specified in the instance document.

setType

public void setType(int attrIndex, String attrType)
Sets the type of the attribute at the specified index.

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)".

setURI

public void setURI(int attrIndex, String uri)
Sets the uri of the attribute at the specified index.

Parameters: attrIndex The attribute index. uri Namespace uri

setValue

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.

Parameters: attrIndex The attribute index. attrValue The new attribute value.

See Also: XMLAttributesImpl

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.