org.apache.xerces.util
Class XMLAttributesImpl

java.lang.Object
  |
  +--org.apache.xerces.util.XMLAttributesImpl

public class XMLAttributesImpl
extends java.lang.Object
implements org.apache.xerces.xni.XMLAttributes, org.xml.sax.AttributeList, org.xml.sax.Attributes

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.1.2.6 2001/07/24 08:10:35 andyc Exp $
Author:
Andy Clark, IBM
See Also:
XMLDocumentHandler#startElement

Field Summary
protected  org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributes
          Attribute information.
protected  int fLength
          Attribute count.
protected  boolean fNamespaces
          Namespaces.
 
Constructor Summary
XMLAttributesImpl()
          Default constructor.
 
Method Summary
 int addAttribute(org.apache.xerces.xni.QName name, java.lang.String type, java.lang.String value)
          Adds an attribute.
 int addAttributeEntity(int attrIndex, java.lang.String entityName, int entityOffset, int entityLength)
          Adds an entity to the specified attribute.
 int getEntityCount(int attrIndex)
          Returns the number of entities for the specified attribute.
 int getEntityLength(int attrIndex, int entityIndex)
          Returns the length of the entity of a given attribute.
 java.lang.String getEntityName(int attrIndex, int entityIndex)
          Returns the name of the entity of a given attribute.
 int getEntityOffset(int attrIndex, int entityIndex)
          Returns the offset of the entity of a given attribute.
 int getIndex(java.lang.String qName)
          Look up the index of an attribute by XML 1.0 qualified name.
 int getIndex(java.lang.String uri, java.lang.String localPart)
          Look up the index of an attribute by Namespace name.
 int getLength()
          Return the number of attributes in the list.
 java.lang.String getLocalName(int index)
          Look up an attribute's local name by index.
 java.lang.String 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.
 java.lang.String getNonNormalizedValue(int attrIndex)
          Returns the non-normalized value of the attribute at the specified index.
 java.lang.String getQName(int index)
          Look up an attribute's XML 1.0 qualified name by index.
 java.lang.String getType(int index)
          Look up an attribute's type by index.
 java.lang.String getType(java.lang.String qname)
          Look up an attribute's type by XML 1.0 qualified name.
 java.lang.String getType(java.lang.String uri, java.lang.String localName)
          Look up an attribute's type by Namespace name.
 java.lang.String getURI(int index)
          Look up an attribute's Namespace URI by index.
 java.lang.String getValue(int index)
          Look up an attribute's value by index.
 java.lang.String getValue(java.lang.String qname)
          Look up an attribute's value by XML 1.0 qualified name.
 java.lang.String getValue(java.lang.String uri, java.lang.String localName)
          Look up an attribute's value by Namespace name.
 boolean isSpecified(int attrIndex)
          Returns true if the attribute is specified in the instance document.
 void removeAllAttributes()
          Removes all of the attributes.
 void removeAllEntitiesFor(int attrIndex)
          Removes all of the entities for the specified attribute.
 void removeAttributeAt(int attrIndex)
          Removes the attribute at the specified index.
 void removeEntityAt(int attrIndex, int entityIndex)
          Removes the specified entity of a given attribute.
 void setEntityLength(int attrIndex, int entityIndex, int entityLength)
          Sets the entity length.
 void setEntityName(int attrIndex, int entityIndex, java.lang.String entityName)
          Sets the entity name.
 void setEntityOffset(int attrIndex, int entityIndex, int entityOffset)
          Sets the entity offset.
 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, java.lang.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 setType(int attrIndex, java.lang.String attrType)
          Sets the type of the attribute at the specified index.
 void setValue(int attrIndex, java.lang.String attrValue)
          Sets the value of the attribute at the specified index.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fNamespaces

protected boolean fNamespaces
Namespaces.

fLength

protected int fLength
Attribute count.

fAttributes

protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributes
Attribute information.
Constructor Detail

XMLAttributesImpl

public XMLAttributesImpl()
Default constructor.
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.

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 interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrName - The attribute name.
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)".
attrValue - The attribute value.
Returns:
Returns the attribute index.

removeAllAttributes

public void removeAllAttributes()
Removes all of the attributes. This method will also remove all entities associated to the attributes.
Specified by:
removeAllAttributes in interface org.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 interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.

addAttributeEntity

public int addAttributeEntity(int attrIndex,
                              java.lang.String entityName,
                              int entityOffset,
                              int entityLength)
Adds an entity to the specified attribute.

Note: This method does not replace any existing entities for the specified attribute, even if an entity of the same name already exists.

Note: This method does not ensure that the entities appear in increasing offset order. The caller is required to add attribute entities in increasing offset order.

Specified by:
addAttributeEntity in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityName - The entity name.
entityOffset - The entity offset.
entityLength - The entity length

removeAllEntitiesFor

public void removeAllEntitiesFor(int attrIndex)
Removes all of the entities for the specified attribute.
Specified by:
removeAllEntitiesFor in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.

removeEntityAt

public void removeEntityAt(int attrIndex,
                           int entityIndex)
Removes the specified entity of a given attribute.

Note: This operation changes the indexes of all entities following the entity at the specified index.

Specified by:
removeEntityAt in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity 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 interface org.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 interface org.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:
setType in interface org.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.
Specified by:
setValue in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
attrValue - The new attribute value.

setNonNormalizedValue

public void setNonNormalizedValue(int attrIndex,
                                  java.lang.String attrValue)
Sets the non-normalized value of the attribute at the specified index.
Specified by:
setNonNormalizedValue in interface org.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 the getValue(int) method.
Specified by:
getNonNormalizedValue in interface org.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 interface org.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 interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.

getEntityCount

public int getEntityCount(int attrIndex)
Returns the number of entities for the specified attribute.
Specified by:
getEntityCount in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.

setEntityName

public void setEntityName(int attrIndex,
                          int entityIndex,
                          java.lang.String entityName)
Sets the entity name.
Specified by:
setEntityName in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity index.
entityName - The new entity name.

getEntityName

public java.lang.String getEntityName(int attrIndex,
                                      int entityIndex)
Returns the name of the entity of a given attribute.
Specified by:
getEntityName in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity index.

setEntityOffset

public void setEntityOffset(int attrIndex,
                            int entityIndex,
                            int entityOffset)
Sets the entity offset.
Specified by:
setEntityOffset in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity index.
entityOffset - The new entity offset.

getEntityOffset

public int getEntityOffset(int attrIndex,
                           int entityIndex)
Returns the offset of the entity of a given attribute.
Specified by:
getEntityOffset in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity index.

setEntityLength

public void setEntityLength(int attrIndex,
                            int entityIndex,
                            int entityLength)
Sets the entity length.
Specified by:
setEntityLength in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity index.
entityLength - The new entity length.

getEntityLength

public int getEntityLength(int attrIndex,
                           int entityIndex)
Returns the length of the entity of a given attribute.
Specified by:
getEntityLength in interface org.apache.xerces.xni.XMLAttributes
Parameters:
attrIndex - The attribute index.
entityIndex - The entity 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 interface org.apache.xerces.xni.XMLAttributes
Returns:
The number of attributes in the list.

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:
getType in interface org.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:
getType in interface org.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:
getValue in interface org.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:
getValue in interface org.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.

Specified by:
getName in interface org.xml.sax.AttributeList
Parameters:
i - 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:
getIndex in interface org.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:
getIndex in interface org.apache.xerces.xni.XMLAttributes
Parameters:
uri - The Namespace URI, or the empty string if the name has no Namespace URI.
localName - 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:
getLocalName in interface org.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:
getQName in interface org.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:
getType in interface org.apache.xerces.xni.XMLAttributes
Parameters:
uri - The Namespace URI, or the empty String 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 java.lang.String getURI(int index)
Look up an attribute's Namespace URI by index.
Specified by:
getURI in interface org.apache.xerces.xni.XMLAttributes
Parameters:
index - The attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.
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:
getValue in interface org.apache.xerces.xni.XMLAttributes
Parameters:
uri - The Namespace URI, or the empty String if the name has no Namespace URI.
localName - The local name of the attribute.
Returns:
The attribute value as a string, or null if the attribute is not in the list.


Copyright © 1999-2001 Apache XML Project. All Rights Reserved.