| java.lang.Object
 com.sun.xml.stream.xerces.util.XMLAttributesImpl
All known Subclasses: com.sun.xml.stream.xerces.util.XMLAttributesIteratorImpl,
| XMLAttributesImpl | | public class XMLAttributesImpl implements XMLAttributes,XMLBufferListener(Code) | | 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.
See Also: com.sun.xml.stream.xerces.xni.XMLDocumentHandler.startElement
author:
Andy Clark, IBM
author:
Elena Litani, IBM
author:
Michael Glavassevich, IBM
version:
$Id: XMLAttributesImpl.java,v 1.2 2006/04/01 06:01:40 jeffsuttor Exp $ |
| Inner Class :static class Attribute | |
| Field Summary | |
| final protected static int | SIZE_LIMIT
Threshold at which an instance is treated
as a large attribute list. | | final protected static int | TABLE_SIZE
Default table size. | | protected 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 Attribute[] | fAttributes
Attribute information. | | protected boolean | fIsTableViewConsistent
Indicates whether the table view contains consistent data. | | protected int | fLargeCount
Usage count for the attribute table view. | | protected int | fLength
Attribute count. | | protected boolean | fNamespaces
Namespaces. | | protected int | fTableViewBuckets
Actual number of buckets in the table view. |
| Method Summary | |
| public int | addAttribute(QName name, String type, String value)
Adds an attribute. | | public int | addAttribute(QName name, String type, String value, XMLString valueCache)
| | public void | addAttributeNS(QName name, String type, String value)
Adds an attribute. | | public QName | checkDuplicatesNS()
Checks for duplicate expanded names (local part and namespace name
pairs) in the attribute specification. | | protected void | cleanTableView()
Purges all elements from the table view. | | public Augmentations | getAugmentations(String uri, String localName)
Look up an augmentations by Namespace name.
Parameters:
uri - The Namespace URI, or null if the
Parameters:
localName - The local name of the attribute. | | public Augmentations | getAugmentations(String qName)
Look up an augmentation by XML 1.0 qualified name.
Parameters:
qName - The XML 1.0 qualified name. | | public Augmentations | getAugmentations(int attributeIndex)
Look up an augmentations by attributes index.
Parameters:
attributeIndex - The attribute index. | | public int | getIndex(String qName)
Look up the index of an attribute by XML 1.0 qualified name.
Parameters:
qName - The qualified (prefixed) name. | | public int | getIndex(String uri, String localPart)
Look up the index of an attribute by Namespace name.
Parameters:
uri - The Namespace URI, or null ifthe name has no Namespace URI.
Parameters:
localName - The attribute's local 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. | | 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. | | public int | getLength()
Return the number of attributes in the list. | | public String | getLocalName(int index)
Look up an attribute's local name by index.
Parameters:
index - The attribute index (zero-based). | | 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 | 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. | | public String | getNonNormalizedValue(int attrIndex)
Returns the non-normalized value of the attribute at the specified
index. | | 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.
Parameters:
index - The attribute index (zero-based). | | public QName | getQualifiedName(int index)
| | protected String | getReportableType(String type)
Returns the value passed in or NMTOKEN if it's an enumerated type. | | 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".
Parameters:
index - The attribute index (zero-based). | | public String | getType(String qname)
Look up an attribute's type by XML 1.0 qualified name.
See
XMLAttributesImpl.getType(int) getType(int) for a description
of the possible types.
Parameters:
qname - The XML 1.0 qualified name. | | public String | getType(String uri, String localName)
Look up an attribute's type by Namespace name.
See
XMLAttributesImpl.getType(int) getType(int) for a description
of the possible types.
Parameters:
uri - The Namespace URI, or null if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. | | public String | getURI(int index)
Look up an attribute's Namespace URI by index.
Parameters:
index - The attribute index (zero-based). | | 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). | | public String | getValue(String qname)
Look up an attribute's value by XML 1.0 qualified name.
See
XMLAttributesImpl.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
qname - The XML 1.0 qualified name. | | public String | getValue(String uri, String localName)
Look up an attribute's value by Namespace name.
See
XMLAttributesImpl.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
uri - The Namespace URI, or null if the
Parameters:
localName - The local name of the attribute. | | 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 | refresh()
This method will be invoked by XMLEntityReader before ScannedEntities buffer
is reloaded. | | public void | refresh(int pos)
| | public void | removeAllAttributes()
Removes all of the attributes. | | public void | removeAttributeAt(int attrIndex)
Removes 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. | | 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.
Parameters:
attrIndex - The attribute index.
Parameters:
attrType - The attribute type. | | 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. | | public void | setValue(int attrIndex, String attrValue, XMLString value)
|
| SIZE_LIMIT | | final protected static int SIZE_LIMIT(Code) | | Threshold at which an instance is treated
as a large attribute list.
|
| TABLE_SIZE | | final protected static int TABLE_SIZE(Code) | | Default table size.
|
| fAttributeTableView | | protected Attribute[] fAttributeTableView(Code) | | Hashtable of attribute information.
Provides an alternate view of the attribute specification.
|
| fAttributeTableViewChainState | | protected int[] fAttributeTableViewChainState(Code) | | 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.
|
| fAttributes | | protected Attribute[] fAttributes(Code) | | Attribute information.
|
| fIsTableViewConsistent | | protected boolean fIsTableViewConsistent(Code) | | Indicates whether the table view contains consistent data.
|
| fLargeCount | | protected int fLargeCount(Code) | | 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(Code) | | Attribute count.
|
| fNamespaces | | protected boolean fNamespaces(Code) | | Namespaces.
|
| fTableViewBuckets | | protected int fTableViewBuckets(Code) | | Actual number of buckets in the table view.
|
| XMLAttributesImpl | | public XMLAttributesImpl()(Code) | | Default constructor.
|
| XMLAttributesImpl | | public XMLAttributesImpl(int tableSize)(Code) | |
Parameters:
tableSize - initial size of table view |
| addAttribute | | public int addAttribute(QName name, String type, String value)(Code) | | 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.
Parameters:
type - The attribute type. The type name is determined bythe type specified for this attribute in the DTD.For example: "CDATA", "ID", "NMTOKEN", etc. However,attributes of type enumeration will have the typevalue specified as the pipe ('|') separated list ofthe enumeration values prefixed by an openparenthesis and suffixed by a close parenthesis.For example: "(true|false)".
Parameters:
value - The attribute value. Returns the attribute index.
See Also: XMLAttributesImpl.setNonNormalizedValue
See Also: XMLAttributesImpl.setSpecified |
| addAttributeNS | | public void addAttributeNS(QName name, String type, String value)(Code) | | 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
Parameters:
type - the attribute type
Parameters:
value - the attribute value
See Also: XMLAttributesImpl.setNonNormalizedValue
See Also: XMLAttributesImpl.setSpecified
See Also: XMLAttributesImpl.checkDuplicatesNS |
| checkDuplicatesNS | | public QName checkDuplicatesNS()(Code) | | 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.
the name of a duplicate attribute found in the search,otherwise null. |
| cleanTableView | | protected void cleanTableView()(Code) | | Purges all elements from the table view.
|
| getAugmentations | | public Augmentations getAugmentations(String uri, String localName)(Code) | | Look up an augmentations by Namespace name.
Parameters:
uri - The Namespace URI, or null if the
Parameters:
localName - The local name of the attribute. Augmentations |
| getAugmentations | | public Augmentations getAugmentations(String qName)(Code) | | Look up an augmentation by XML 1.0 qualified name.
Parameters:
qName - The XML 1.0 qualified name. Augmentations |
| getAugmentations | | public Augmentations getAugmentations(int attributeIndex)(Code) | | Look up an augmentations by attributes index.
Parameters:
attributeIndex - The attribute index. Augmentations |
| getIndex | | public int getIndex(String qName)(Code) | | Look up the index of an attribute by XML 1.0 qualified name.
Parameters:
qName - The qualified (prefixed) name. The index of the attribute, or -1 if it does notappear in the list. |
| getIndex | | public int getIndex(String uri, String localPart)(Code) | | Look up the index of an attribute by Namespace name.
Parameters:
uri - The Namespace URI, or null ifthe name has no Namespace URI.
Parameters:
localName - The attribute's local name. The index of the attribute, or -1 if it does notappear in the list. |
| getIndexFast | | public int getIndexFast(String qName)(Code) | | 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. The index of the attribute, or -1 if it does notappear in the list. |
| getIndexFast | | public int getIndexFast(String uri, String localPart)(Code) | | 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 ifthe name has no Namespace URI.
Parameters:
localName - The attribute's local name. The index of the attribute, or -1 if it does notappear in the list. |
| getLength | | public int getLength()(Code) | | Return the number of attributes in the list.
Once you know the number of attributes, you can iterate
through the list.
The number of attributes in the list. |
| getLocalName | | public String getLocalName(int index)(Code) | | Look up an attribute's local name by index.
Parameters:
index - The attribute index (zero-based). The local name, or the empty string if Namespaceprocessing is not being performed, or nullif the index is out of range.
See Also: XMLAttributesImpl.getLength |
| getName | | public void getName(int attrIndex, QName attrName)(Code) | | Sets the fields in the given QName structure with the values
of the attribute name at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrName - The attribute name structure to fill in. |
| getName | | public String getName(int index)(Code) | | 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:
i - The index of the attribute in the list (starting at 0). The name of the indexed attribute, or nullif the index is out of range.
See Also: XMLAttributesImpl.getLength |
| getNonNormalizedValue | | public String getNonNormalizedValue(int attrIndex)(Code) | | 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)(Code) | | Returns the prefix of the attribute at the specified index.
Parameters:
index - The index of the attribute. |
| getQName | | public String getQName(int index)(Code) | | Look up an attribute's XML 1.0 qualified name by index.
Parameters:
index - The attribute index (zero-based). The XML 1.0 qualified name, or the empty stringif none is available, or null if the indexis out of range.
See Also: XMLAttributesImpl.getLength |
| getQualifiedName | | public QName getQualifiedName(int index)(Code) | | |
| getReportableType | | protected String getReportableType(String type)(Code) | | Returns the value passed in or NMTOKEN if it's an enumerated type.
Parameters:
type - attribute type the value passed in or NMTOKEN if it's an enumerated type. |
| getSchemaId | | public boolean getSchemaId(int index)(Code) | | |
| getTableViewBucket | | protected int getTableViewBucket(String qname)(Code) | | Returns the position in the table view
where the given attribute name would be hashed.
Parameters:
qname - the attribute name the position in the table view where the given attributewould be hashed |
| getTableViewBucket | | protected int getTableViewBucket(String localpart, String uri)(Code) | | Returns the position in the table view
where the given attribute name would be hashed.
Parameters:
localpart - the local part of the attribute
Parameters:
uri - the namespace name of the attribute the position in the table view where the given attributewould be hashed |
| getType | | public String getType(int index)(Code) | | 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). The attribute's type as a string, or null if theindex is out of range.
See Also: XMLAttributesImpl.getLength |
| getType | | public String getType(String qname)(Code) | | Look up an attribute's type by XML 1.0 qualified name.
See
XMLAttributesImpl.getType(int) getType(int) for a description
of the possible types.
Parameters:
qname - The XML 1.0 qualified name. The attribute type as a string, or null if theattribute is not in the list or if qualified namesare not available. |
| getType | | public String getType(String uri, String localName)(Code) | | Look up an attribute's type by Namespace name.
See
XMLAttributesImpl.getType(int) getType(int) for a description
of the possible types.
Parameters:
uri - The Namespace URI, or null if thename has no Namespace URI.
Parameters:
localName - The local name of the attribute. The attribute type as a string, or null if theattribute is not in the list or if Namespaceprocessing is not being performed. |
| getURI | | public String getURI(int index)(Code) | | Look up an attribute's Namespace URI by index.
Parameters:
index - The attribute index (zero-based). The Namespace URI
See Also: XMLAttributesImpl.getLength |
| getValue | | public String getValue(int index)(Code) | | 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). The attribute's value as a string, or null if theindex is out of range.
See Also: XMLAttributesImpl.getLength |
| getValue | | public String getValue(String qname)(Code) | | Look up an attribute's value by XML 1.0 qualified name.
See
XMLAttributesImpl.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
qname - The XML 1.0 qualified name. The attribute value as a string, or null if theattribute is not in the list or if qualified namesare not available. |
| getValue | | public String getValue(String uri, String localName)(Code) | | Look up an attribute's value by Namespace name.
See
XMLAttributesImpl.getValue(int) getValue(int) for a description
of the possible values.
Parameters:
uri - The Namespace URI, or null if the
Parameters:
localName - The local name of the attribute. The attribute value as a string, or null if theattribute is not in the list. |
| isSpecified | | public boolean isSpecified(int attrIndex)(Code) | | Returns true if the attribute is specified in the instance document.
Parameters:
attrIndex - The attribute index. |
| prepareAndPopulateTableView | | protected void prepareAndPopulateTableView()(Code) | | 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()(Code) | | Prepares the table view of the attributes list for use.
|
| refresh | | public void refresh()(Code) | | This method will be invoked by XMLEntityReader before ScannedEntities buffer
is reloaded.
|
| refresh | | public void refresh(int pos)(Code) | | |
| removeAllAttributes | | public void removeAllAttributes()(Code) | | Removes all of the attributes. This method will also remove all
entities associated to the attributes.
|
| removeAttributeAt | | public void removeAttributeAt(int attrIndex)(Code) | | 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)(Code) | | Sets the augmentations of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
augs - The augmentations. |
| setName | | public void setName(int attrIndex, QName attrName)(Code) | | Sets the name of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrName - The new attribute name. |
| setNamespaces | | public void setNamespaces(boolean namespaces)(Code) | | 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.getLocalName |
| setNonNormalizedValue | | public void setNonNormalizedValue(int attrIndex, String attrValue)(Code) | | Sets the non-normalized value of the attribute at the specified
index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrValue - The new non-normalized attribute value. |
| setSchemaId | | public void setSchemaId(int attrIndex, boolean schemaId)(Code) | | |
| setSpecified | | public void setSpecified(int attrIndex, boolean specified)(Code) | | Sets whether an attribute is specified in the instance document
or not.
Parameters:
attrIndex - The attribute index.
Parameters:
specified - True if the attribute is specified in the instancedocument. |
| setType | | public void setType(int attrIndex, String attrType)(Code) | | Sets the type of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
attrType - The attribute type. The type name is determined bythe type specified for this attribute in the DTD.For example: "CDATA", "ID", "NMTOKEN", etc. However,attributes of type enumeration will have the typevalue specified as the pipe ('|') separated list ofthe enumeration values prefixed by an openparenthesis and suffixed by a close parenthesis.For example: "(true|false)". |
| setURI | | public void setURI(int attrIndex, String uri)(Code) | | Sets the uri of the attribute at the specified index.
Parameters:
attrIndex - The attribute index.
Parameters:
uri - Namespace uri |
| setValue | | public void setValue(int attrIndex, String attrValue)(Code) | | 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.
Parameters:
attrValue - The new attribute value.
See Also: XMLAttributesImpl.setNonNormalizedValue |
|
|