Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
org.xml.sax

Interface Attributes

java.lang.Object
|
+--org.xml.sax.Attributes


public interface Attributes

Interface for a list of XML attributes.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This interface allows access to a list of attributes in three different ways:

  1. by attribute index;
  2. by Namespace-qualified name; or
  3. by qualified (prefixed) name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default). Because SAX2 conforms to the "Namespaces in XML" specification, it does not give namespace declaration attributes a namespace URI. Some other W3C specifications are in conflict with that, expecting these declarations to be in a namespace. Handler code may need to resolve that conflict.

If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the http://xml.org/sax/features/namespaces feature is false, access by Namespace-qualified names may not be available.

This interface replaces the now-deprecated SAX1 org.xml.sax.AttributeList AttributeList interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below).

The order of attributes in the list is unspecified, and will vary from implementation to implementation.

Since:Author:See Also:

Method Summary

intgetIndex(java.lang.String uri, java.lang.String localName)

Look up the index of an attribute by Namespace name.
intgetIndex(java.lang.String qName)

Look up the index of an attribute by XML 1.0 qualified name.
intgetLength()

Return the number of attributes in the list.
java.lang.StringgetLocalName(int index)

Look up an attribute's local name by index.
java.lang.StringgetQName(int index)

Look up an attribute's XML 1.0 qualified name by index.
java.lang.StringgetType(int index)

Look up an attribute's type by index.
java.lang.StringgetType(java.lang.String uri, java.lang.String localName)

Look up an attribute's type by Namespace name.
java.lang.StringgetType(java.lang.String qName)

Look up an attribute's type by XML 1.0 qualified name.
java.lang.StringgetURI(int index)

Look up an attribute's Namespace URI by index.
java.lang.StringgetValue(int index)

Look up an attribute's value by index.
java.lang.StringgetValue(java.lang.String uri, java.lang.String localName)

Look up an attribute's value by Namespace name.
java.lang.StringgetValue(java.lang.String qName)

Look up an attribute's value by XML 1.0 qualified name.

Method Details

getIndex

public int getIndex(java.lang.String qName)

Look up the index of an attribute by XML 1.0 qualified name.

Parameters:

Returns:


getIndex

public int getIndex(java.lang.String uri, java.lang.String localName)

Look up the index of an attribute by Namespace name.

Parameters:

Returns:


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:

See Also:


getLocalName

public String getLocalName(int index)

Look up an attribute's local name by index.

Parameters:

Returns:

See Also:


getQName

public String getQName(int index)

Look up an attribute's XML 1.0 qualified name by index.

Parameters:

Returns:

See Also:


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:

Returns:

See Also:


getType

public String getType(java.lang.String qName)

Look up an attribute's type by XML 1.0 qualified name.

See #getType(int) getType(int) for a description of the possible types.

Parameters:

Returns:


getType

public String getType(java.lang.String uri, java.lang.String localName)

Look up an attribute's type by Namespace name.

See #getType(int) getType(int) for a description of the possible types.

Parameters:

Returns:


getURI

public String getURI(int index)

Look up an attribute's Namespace URI by index.

Parameters:

Returns:

See Also:


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:

Returns:

See Also:


getValue

public String getValue(java.lang.String qName)

Look up an attribute's value by XML 1.0 qualified name.

See #getValue(int) getValue(int) for a description of the possible values.

Parameters:

Returns:


getValue

public String getValue(java.lang.String uri, java.lang.String localName)

Look up an attribute's value by Namespace name.

See #getValue(int) getValue(int) for a description of the possible values.

Parameters:

Returns: