XML for Java EA2

com.ibm.xml.framework
Class XMLAttrList

java.lang.Object
  |
  +--com.ibm.xml.framework.XMLAttrList

public final class XMLAttrList
extends java.lang.Object
implements AttributeList

Version:
Revision: %M% %I% %W% %Q%

Constructor Summary
XMLAttrList(com.ibm.xml.utils.StringPool stringPool)
           
 
Method Summary
 int addAttr(int attrName, int attValue, int attType, boolean search, boolean specified)
           
 int attrListStart()
           
 void endAttrList()
           
 AttributeList getAttributeList(int attrListIndex)
           
 int getAttrName(int attrIndex)
           
 int getAttType(int attrIndex)
           
 int getAttValue(int attrIndex)
           
 int getFirstAttr(int attrListIndex)
          Returns the index of the first attribute in the specified attribute list or -1 if the index is invalid.
 int getLength()
          Return the number of attributes in this list.
 java.lang.String getName(int i)
          Return the name of an attribute in this list (by position).
 int getNextAttr(int attrIndex)
          Returns the next index of the specified attribute or -1 if there is no next index.
 java.lang.String getType(int i)
          Return the type of an attribute in the list (by position).
 java.lang.String getType(java.lang.String name)
          Return the type of an attribute in the list (by name).
 java.lang.String getValue(int i)
          Return the value of an attribute in the list (by position).
 java.lang.String getValue(java.lang.String name)
          Return the value of an attribute in the list (by name).
 boolean isSpecified(int attrIndex)
           
 void releaseAttrList(int attrListIndex)
           
 void reset(com.ibm.xml.utils.StringPool stringPool)
           
 void setAttType(int attrIndex, int attType)
           
 int startAttrList()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLAttrList

public XMLAttrList(com.ibm.xml.utils.StringPool stringPool)
Method Detail

reset

public void reset(com.ibm.xml.utils.StringPool stringPool)

addAttr

public int addAttr(int attrName,
                   int attValue,
                   int attType,
                   boolean search,
                   boolean specified)
            throws java.lang.Exception

attrListStart

public int attrListStart()

startAttrList

public int startAttrList()

endAttrList

public void endAttrList()

setAttType

public void setAttType(int attrIndex,
                       int attType)

getAttrName

public int getAttrName(int attrIndex)

getAttValue

public int getAttValue(int attrIndex)

getAttType

public int getAttType(int attrIndex)

isSpecified

public boolean isSpecified(int attrIndex)

releaseAttrList

public void releaseAttrList(int attrListIndex)

getFirstAttr

public int getFirstAttr(int attrListIndex)
Returns the index of the first attribute in the specified attribute list or -1 if the index is invalid.
Parameters:
attrListIndex - The attribute list index.

getNextAttr

public int getNextAttr(int attrIndex)
Returns the next index of the specified attribute or -1 if there is no next index.
Parameters:
attrIndex - The attribute index.
See Also:
#isLastAttr

getAttributeList

public AttributeList getAttributeList(int attrListIndex)

getLength

public int getLength()
Return the number of attributes in this list.

The SAX parser may provide attributes in any arbitrary order, regardless of the order in which they were declared or specified. The number of attributes may be zero.

Specified by:
getLength in interface AttributeList
Returns:
The number of attributes in the list.

getName

public java.lang.String getName(int i)
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 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()

getType

public java.lang.String getType(int i)
Return the type of an attribute in the list (by position).

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 AttributeList
Parameters:
i - The index of the attribute in the list (starting at 0).
Returns:
The attribute type as a string, or null if the index is out of range.
See Also:
getLength(), getType(java.lang.String)

getValue

public java.lang.String getValue(int i)
Return the value of an attribute in the list (by position).

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string separated by whitespace.

Specified by:
getValue in interface AttributeList
Parameters:
i - The index of the attribute in the list (starting at 0).
Returns:
The attribute value as a string, or null if the index is out of range.
See Also:
getLength(), getValue(java.lang.String)

getType

public java.lang.String getType(java.lang.String name)
Return the type of an attribute in the list (by name).

The return value is the same as the return value for getType(int).

If the attribute name has a namespace prefix in the document, the application must include the prefix here.

Specified by:
getType in interface AttributeList
Parameters:
name - The name of the attribute.
Returns:
The attribute type as a string, or null if no such attribute exists.
See Also:
getType(int)

getValue

public java.lang.String getValue(java.lang.String name)
Return the value of an attribute in the list (by name).

The return value is the same as the return value for getValue(int).

If the attribute name has a namespace prefix in the document, the application must include the prefix here.

Specified by:
getValue in interface AttributeList
Parameters:
i - The index of the attribute in the list.
Returns:
The attribute value as a string, or null if no such attribute exists.
See Also:
getValue(int)

XML for Java EA2