Package net.sf.saxon.tree.util

Class AttributeCollectionImpl

java.lang.Object
net.sf.saxon.tree.util.AttributeCollectionImpl
All Implemented Interfaces:
Attributes
public class AttributeCollectionImpl extends Object implements Attributes
AttributeCollectionImpl is an implementation of the SAX2 interface Attributes.

As well as providing the information required by the SAX2 interface, an AttributeCollection can hold type information (as needed to support the JAXP 1.3 ValidatorHandler interface), and location information for debugging. The location information is used in the case of attributes on a result tree to identify the location in the query or stylesheet from which they were generated.

  • Constructor Details

    • AttributeCollectionImpl

      public AttributeCollectionImpl(Configuration config, int initialSize)

  • Method Details

    • addAttribute

      public void addAttribute(NodeName nodeName, SimpleType type, String value, Location locationId, int properties)
      Add an attribute to an attribute list. The parameters correspond to the parameters of the Outputter.attribute(NodeName, SimpleType, String, Location, int) method. There is no check that the name of the attribute is distinct from other attributes already in the collection: this check must be made by the caller.
      Parameters:
      nodeName - Object representing the attribute name.
      type - The attribute type
      value - The attribute value (must not be null)
      locationId - Identifies the attribute location.
      properties - Attribute properties

    • setAttribute

      public void setAttribute(int index, NodeName nodeName, SimpleType type, String value, Location locationId, int properties)
      Set (overwrite) an attribute in the attribute list. The parameters correspond to the parameters of the Outputter.attribute(NodeName, SimpleType, String, Location, int) method.
      Parameters:
      index - Identifies the entry to be replaced. Must be in range (nasty things happen if not)
      nodeName - representing the attribute name.
      type - The attribute type code
      value - The attribute value (must not be null)
      locationId - Identifies the attribtue location.
      properties - Attribute properties

    • getLength

      public int getLength()
      Return the number of attributes in the list.
      Specified by:
      getLength in interface Attributes
      Returns:
      The number of attributes that have been created in this attribute collection. This is the number of slots used in the list, including any slots allocated to attributes that have since been deleted. Such slots are not reused, to preserve attribute identity.

    • getTypeAnnotation

      public SimpleType getTypeAnnotation(int index)
      Get the type of an attribute (by position).
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The type annotation

    • getLocation

      public Location getLocation(int index)
      Get the location of an attribute (by position)
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The location of the attribute. This can be used to obtain the actual system identifier and line number of the relevant location

    • getProperties

      public int getProperties(int index)
      Get the properties of an attribute (by position)
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The properties of the attribute. This is a set of bit-settings defined in class ReceiverOption. The most interesting of these is ReceiverOption.DEFAULTED_VALUE, which indicates an attribute that was added to an element as a result of schema validation.

    • getQName

      public String getQName(int index)
      Get the lexical QName of an attribute (by position).
      Specified by:
      getQName in interface Attributes
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The lexical QName of the attribute as a string, or null if there is no attribute at that position.

    • getLocalName

      public String getLocalName(int index)
      Get the local name of an attribute (by position).
      Specified by:
      getLocalName in interface Attributes
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The local name of the attribute as a string, or null if there is no attribute at that position.

    • getURI

      public String getURI(int index)
      Get the namespace URI of an attribute (by position).
      Specified by:
      getURI in interface Attributes
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The local name of the attribute as a string, or null if there is no attribute at that position.

    • getType

      public String getType(int index)
      Get the type of an attribute (by position). This is a SAX2 method, so it gets the type name as a DTD attribute type, mapped from the schema type code.
      Specified by:
      getType in interface Attributes
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The attribute type as a string ("NMTOKEN" for an enumeration, and "CDATA" if no declaration was read), or null if there is no attribute at that position.

    • getType

      public String getType(String uri, String localname)
      Get the type of an attribute (by name).
      Specified by:
      getType in interface Attributes
      Parameters:
      uri - The namespace uri of the attribute.
      localname - The local name of the attribute.
      Returns:
      The index position of the attribute

    • getValue

      public String getValue(int index)
      Get the value of an attribute (by position).
      Specified by:
      getValue in interface Attributes
      Parameters:
      index - The position of the attribute in the list.
      Returns:
      The attribute value as a string, or null if there is no attribute at that position.

    • getValue

      public String getValue(String uri, String localname)
      Get the value of an attribute (by name).
      Specified by:
      getValue in interface Attributes
      Parameters:
      uri - The namespace uri of the attribute.
      localname - The local name of the attribute.
      Returns:
      The index position of the attribute

    • getIndex

      public int getIndex(String qname)
      Get the index of an attribute, from its lexical QName
      Specified by:
      getIndex in interface Attributes
      Parameters:
      qname - The lexical QName of the attribute. The prefix must match.
      Returns:
      The index position of the attribute

    • getIndex

      public int getIndex(String uri, String localname)
      Get the index of an attribute (by name).
      Specified by:
      getIndex in interface Attributes
      Parameters:
      uri - The namespace uri of the attribute.
      localname - The local name of the attribute.
      Returns:
      The index position of the attribute, or -1 if absent

    • getType

      public String getType(String name)
      Get the type of an attribute (by lexical QName).
      Specified by:
      getType in interface Attributes
      Parameters:
      name - The lexical QName of the attribute.
      Returns:
      The attribute type as a string (e.g. "NMTOKEN", or "CDATA" if no declaration was read).

    • getValue

      public String getValue(String name)
      Get the value of an attribute (by lexnical QName).
      Specified by:
      getValue in interface Attributes
      Parameters:
      name - The attribute name (a lexical QName). The prefix must match the prefix originally used. This method is defined in SAX, but is not recommended except where the prefix is null.

    • setTypeAnnotation

      public void setTypeAnnotation(int index, SimpleType type)
      Set the type annotation of an attribute
      Parameters:
      index - the index position of the attribute node
      type - the new type for the attribute

    • setAttribute

      public void setAttribute(AttributeInfo attribute)
      Add an attribute to the collection, replacing any existing attribute with the same name
      Parameters:
      attribute - the attribute to be added to the collection