AxiomAttributeWrapper

java.lang.Object
- net.sf.saxon.option.axiom.AxiomAttributeWrapper

All Implemented Interfaces:

Source, SourceLocator, PullEvent, Location, Item, NodeInfo, Sequence, SiblingCountingNode, VirtualNode, Locator
```
public class AxiomAttributeWrapper
extends Object
implements NodeInfo, VirtualNode, SiblingCountingNode
```
A node in the XML parse tree representing an XML element, character content, or attribute.

This is the implementation of the NodeInfo interface used as a wrapper for Axiom nodes.

Note that in Axiom, an OMAttribute is not an OMNode. Therefore, we need a separate class AttributeWrapper for attribute nodes.

Author:

Michael H. Kay

Field Summary

Fields
Modifier and Type Field and Description

protected int index

protected org.apache.axiom.om.OMAttribute node
- Fields inherited from interface net.sf.saxon.om.NodeInfo
  ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields
Modifier and Type	Field and Description
`protected int`	`index`
`protected org.apache.axiom.om.OMAttribute`	`node`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node, AxiomParentNodeWrapper parent, int index)` This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class

Method Summary

Methods
Modifier and Type	Method and Description
`AtomicSequence`	`atomize()` Get the typed value.
`int`	`compareOrder(NodeInfo other)` Determine the relative position of this node and another node, in document order.
`int`	`comparePosition(NodeInfo other)` Determine the relative position of this node and another node, in document order, distinguishing whether the first node is a preceding, following, descendant, ancestor, or the same node as the second.
`void`	`copy(Receiver out, int copyOptions, Location locationId)` Copy this node to a given outputter (deep copy)
`boolean`	`equals(Object other)` The equals() method compares nodes for identity.
`void`	`generateId(FastStringBuffer buffer)` Get a character string that uniquely identifies this node.
`String`	`getAttributeValue(String uri, String local)` Get the string value of a given attribute of this node
`String`	`getBaseURI()` Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
`int`	`getColumnNumber()` Get column number
`Configuration`	`getConfiguration()` Get the configuration
`NamespaceBinding[]`	`getDeclaredNamespaces(NamespaceBinding[] buffer)` Get all namespace undeclarations and undeclarations defined on this element.
`String`	`getDisplayName()` Get the display name of this node.
`int`	`getFingerprint()` Get fingerprint.
`int`	`getLineNumber()` Get line number
`String`	`getLocalPart()` Get the local part of the name of this node.
`NamePool`	`getNamePool()` Get the name pool for this node
`int`	`getNodeKind()` Return the type of node.
`NodeInfo`	`getParent()` Get the NodeInfo object representing the parent of this node
`String`	`getPrefix()` Get the prefix of the name of the node.
`String`	`getPublicId()` Get the Public ID of the entity containing the node.
`Object`	`getRealNode()` Get the node underlying this virtual node.
`NodeInfo`	`getRoot()` Get the root node of the tree containing this node
`SchemaType`	`getSchemaType()` Get the type annotation of this node, if any.
`int`	`getSiblingPosition()` Get the index position of this node among its siblings (starting from 0)
`String`	`getStringValue()` Return the string value of the node.
`CharSequence`	`getStringValueCS()` Get the value of the item as a CharSequence.
`String`	`getSystemId()` Get the System ID for the node.
`TreeInfo`	`getTreeInfo()` Get information about the tree to which this NodeInfo belongs
`Object`	`getUnderlyingNode()` Get the underlying Axiom node, to implement the VirtualNode interface
`String`	`getURI()` Get the URI part of the name of this node.
`boolean`	`hasChildNodes()` Determine whether the node has any children.
`int`	`hashCode()` The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()
`NodeInfo`	`head()` To implement `Sequence`, this method returns the item itself
`boolean`	`isId()` Determine whether this node has the is-id property
`boolean`	`isIdref()` Determine whether this node has the is-idref property
`boolean`	`isNilled()` Determine whether the node has the is-nilled property
`boolean`	`isSameNodeInfo(NodeInfo other)` Determine whether this is the same node as another node.
`SequenceIterator`	`iterate()` To implement `Sequence`, this method returns a singleton iterator that delivers this item in the form of a sequence
`AxisIterator`	`iterateAxis(byte axisNumber)` Return an iteration over the nodes reached by the given axis from this node
`AxisIterator`	`iterateAxis(byte axisNumber, NodeTest nodeTest)` Return an iteration over the nodes reached by the given axis from this node
`Location`	`saveLocation()` Get an immutable copy of this Location object.
`void`	`setSystemId(String uri)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - node
```
protected org.apache.axiom.om.OMAttribute node
```
  - index
```
protected int index
```
- Constructor Detail
  - AxiomAttributeWrapper
```
protected AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node,
                     AxiomParentNodeWrapper parent,
                     int index)
```
    This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class
    
    Parameters:
    node - The Axiom attribute node to be wrapped
    parent - The NodeWrapper that wraps the parent of this attribute node
    index - Position of this node among its siblings
- Method Detail
  - getTreeInfo
```
public TreeInfo getTreeInfo()
```
    Get information about the tree to which this NodeInfo belongs
    
    Specified by:
    
    getTreeInfo in interface NodeInfo
    
    Returns:
    the TreeInfo
    Since:
    
    9.7
  - head
```
public NodeInfo head()
```
    To implement Sequence, this method returns the item itself
    
    Specified by:
    
    head in interface Item
    
    Specified by:
    
    head in interface Sequence
    
    Returns:
    this item
  - iterate
```
public SequenceIterator iterate()
```
    To implement Sequence, this method returns a singleton iterator that delivers this item in the form of a sequence
    
    Specified by:
    
    iterate in interface Sequence
    
    Returns:
    a singleton iterator that returns this item
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the configuration
    
    Specified by:
    
    getConfiguration in interface NodeInfo
    
    Returns:
    the Configuration to which the tree belongs
  - getUnderlyingNode
```
public Object getUnderlyingNode()
```
    Get the underlying Axiom node, to implement the VirtualNode interface
    
    Specified by:
    
    getUnderlyingNode in interface VirtualNode
    
    Returns:
    The underlying node.
  - getRealNode
```
public Object getRealNode()
```
    Get the node underlying this virtual node. If this is a VirtualNode the method will automatically drill down through several layers of wrapping.
    
    Specified by:
    
    getRealNode in interface VirtualNode
    
    Returns:
    The underlying node.
  - getNamePool
```
public NamePool getNamePool()
```
    Get the name pool for this node
    
    Returns:
    the NamePool
  - getNodeKind
```
public int getNodeKind()
```
    Return the type of node.
    
    Specified by:
    
    getNodeKind in interface NodeInfo
    
    Returns:
    one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
    See Also:
    Type
  - atomize
```
public AtomicSequence atomize()
```
    Get the typed value.
    
    Specified by:
    
    atomize in interface Item
    
    Specified by:
    
    atomize in interface NodeInfo
    
    Returns:
    the typed value. If requireSingleton is set to true, the result will always be an AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic values.
    Since:
    
    8.5 (signature changed in 9.5)
  - getSchemaType
```
public SchemaType getSchemaType()
```
    Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.
    
    Types derived from a DTD are not reflected in the result of this method.
    
    Specified by:
    
    getSchemaType in interface NodeInfo
    
    Returns:
    For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.
    Since:
    
    9.4
  - isSameNodeInfo
```
public boolean isSameNodeInfo(NodeInfo other)
```
    Determine whether this is the same node as another node.
    Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
    
    Specified by:
    
    isSameNodeInfo in interface NodeInfo
    
    Parameters:
    other - the node to be compared with this node
    
    Returns:
    true if this Node object and the supplied Node object represent the same node in the tree.
  - equals
```
public boolean equals(Object other)
```
    The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().
    
    Specified by:
    
    equals in interface NodeInfo
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - the node to be compared with this node
    
    Returns:
    true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
    Since:
    
    8.7 Previously, the effect of the equals() method was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason. The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.
  - hashCode
```
public int hashCode()
```
    The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()
    
    Specified by:
    
    hashCode in interface NodeInfo
    
    Overrides:
    
    hashCode in class Object
    
    Since:
    
    8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics.
  - getSystemId
```
public String getSystemId()
```
    Get the System ID for the node.
    
    Specified by:
    
    getSystemId in interface Source
    
    Specified by:
    
    getSystemId in interface SourceLocator
    
    Specified by:
    
    getSystemId in interface Location
    
    Specified by:
    
    getSystemId in interface NodeInfo
    
    Specified by:
    
    getSystemId in interface Locator
    
    Returns:
    the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.
  - setSystemId
```
public void setSystemId(String uri)
```
    Specified by:
    
    setSystemId in interface Source
  - getPublicId
```
public String getPublicId()
```
    Get the Public ID of the entity containing the node.
    
    Specified by:
    
    getPublicId in interface SourceLocator
    
    Specified by:
    
    getPublicId in interface Location
    
    Specified by:
    
    getPublicId in interface NodeInfo
    
    Specified by:
    
    getPublicId in interface Locator
    
    Returns:
    null (always)
    Since:
    
    9.7
  - getBaseURI
```
public String getBaseURI()
```
    Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
    
    Specified by:
    
    getBaseURI in interface NodeInfo
    
    Returns:
    the base URI of the node. This may be null if the base URI is unknown, including the case where the node has no parent.
  - getLineNumber
```
public int getLineNumber()
```
    Get line number
    
    Specified by:
    
    getLineNumber in interface SourceLocator
    
    Specified by:
    
    getLineNumber in interface Location
    
    Specified by:
    
    getLineNumber in interface NodeInfo
    
    Specified by:
    
    getLineNumber in interface Locator
    
    Returns:
    the line number of the node in its original source document; or -1 if not available
  - getColumnNumber
```
public int getColumnNumber()
```
    Get column number
    
    Specified by:
    
    getColumnNumber in interface SourceLocator
    
    Specified by:
    
    getColumnNumber in interface Location
    
    Specified by:
    
    getColumnNumber in interface NodeInfo
    
    Specified by:
    
    getColumnNumber in interface Locator
    
    Returns:
    the column number of the node in its original source document; or -1 if not available
  - saveLocation
```
public Location saveLocation()
```
    Get an immutable copy of this Location object. By default Location objects may be mutable, so they should not be saved for later use. The result of this operation holds the same location information, but in an immutable form.
    
    Specified by:
    
    saveLocation in interface Location
  - compareOrder
```
public int compareOrder(NodeInfo other)
```
    Determine the relative position of this node and another node, in document order. The other node will always be in the same document.
    
    Specified by:
    
    compareOrder in interface NodeInfo
    
    Parameters:
    other - The other node, whose position is to be compared with this node
    
    Returns:
    -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
  - comparePosition
```
public int comparePosition(NodeInfo other)
```
    Determine the relative position of this node and another node, in document order, distinguishing whether the first node is a preceding, following, descendant, ancestor, or the same node as the second.
    The other node must always be in the same tree; the effect of calling this method when the two nodes are in different trees is undefined. If either node is a namespace or attribute node, the method should throw UnsupportedOperationException.
    
    Specified by:
    
    comparePosition in interface NodeInfo
    
    Parameters:
    other - The other node, whose position is to be compared with this node
    
    Returns:
    AxisInfo.PRECEDING if this node is on the preceding axis of the other node; AxisInfo.FOLLOWING if it is on the following axis; AxisInfo.ANCESTOR if the first node is an ancestor of the second; AxisInfo.DESCENDANT if the first is a descendant of the second; AxisInfo.SELF if they are the same node.
    
    Throws:
    
    UnsupportedOperationException - if either node is an attribute or namespace
    Since:
    
    9.5
  - getStringValue
```
public String getStringValue()
```
    Return the string value of the node. The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.
    
    Specified by:
    
    getStringValue in interface Item
    
    Specified by:
    
    getStringValue in interface NodeInfo
    
    Returns:
    the string value of the node
    See Also:
    Item.getStringValueCS()
  - getStringValueCS
```
public CharSequence getStringValueCS()
```
    Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.
    
    Specified by:
    
    getStringValueCS in interface Item
    
    Returns:
    the string value of the item
    See Also:
    Item.getStringValue()
  - getFingerprint
```
public int getFingerprint()
```
    Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. A fingerprint of -1 should be returned for a node with no name.
  - getLocalPart
```
public String getLocalPart()
```
    Get the local part of the name of this node. This is the name after the ":" if any.
    
    Specified by:
    
    getLocalPart in interface NodeInfo
    
    Returns:
    the local part of the name. For an unnamed node, returns "".
  - getPrefix
```
public String getPrefix()
```
    Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string.
    
    Specified by:
    
    getPrefix in interface NodeInfo
    
    Returns:
    The prefix of the name of the node.
  - getURI
```
public String getURI()
```
    Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.
    
    Specified by:
    
    getURI in interface NodeInfo
    
    Returns:
    The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.
  - getDisplayName
```
public String getDisplayName()
```
    Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.
    
    Specified by:
    
    getDisplayName in interface NodeInfo
    
    Returns:
    The display name of this node. For a node with no name, return an empty string.
  - getParent
```
public NodeInfo getParent()
```
    Get the NodeInfo object representing the parent of this node
    
    Specified by:
    
    getParent in interface NodeInfo
    
    Returns:
    the parent of this node; null if this node has no parent
  - getSiblingPosition
```
public int getSiblingPosition()
```
    Get the index position of this node among its siblings (starting from 0)
    
    Specified by:
    
    getSiblingPosition in interface SiblingCountingNode
    
    Returns:
    0 for the first child, 1 for the second child, etc.
  - iterateAxis
```
public AxisIterator iterateAxis(byte axisNumber)
```
    Return an iteration over the nodes reached by the given axis from this node
    
    Specified by:
    
    iterateAxis in interface NodeInfo
    
    Parameters:
    axisNumber - the axis to be used
    
    Returns:
    a SequenceIterator that scans the nodes reached by the axis in turn.
    See Also:
    AxisInfo
  - iterateAxis
```
public AxisIterator iterateAxis(byte axisNumber,
                       NodeTest nodeTest)
```
    Return an iteration over the nodes reached by the given axis from this node
    
    Specified by:
    
    iterateAxis in interface NodeInfo
    
    Parameters:
    axisNumber - the axis to be used
    nodeTest - A pattern to be matched by the returned nodes
    
    Returns:
    a SequenceIterator that scans the nodes reached by the axis in turn.
    See Also:
    AxisInfo
  - getAttributeValue
```
public String getAttributeValue(String uri,
                       String local)
```
    Get the string value of a given attribute of this node
    
    Specified by:
    
    getAttributeValue in interface NodeInfo
    
    Parameters:
    uri - the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespace
    local - the local part of the attribute name.
    
    Returns:
    the attribute value if it exists, or null if it does not exist. Always returns null if this node is not an element.
    Since:
    
    9.4
  - getRoot
```
public NodeInfo getRoot()
```
    Get the root node of the tree containing this node
    
    Specified by:
    
    getRoot in interface NodeInfo
    
    Returns:
    the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
  - hasChildNodes
```
public boolean hasChildNodes()
```
    Determine whether the node has any children.
    Note: the result is equivalent to
    getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
    
    Specified by:
    
    hasChildNodes in interface NodeInfo
    
    Returns:
    True if the node has one or more children
  - generateId
```
public void generateId(FastStringBuffer buffer)
```
    Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
    
    Specified by:
    
    generateId in interface NodeInfo
    
    Parameters:
    buffer - a buffer to contain a string that uniquely identifies this node, across all documents
  - copy
```
public void copy(Receiver out,
        int copyOptions,
        Location locationId)
          throws XPathException
```
    Copy this node to a given outputter (deep copy)
    
    Specified by:
    
    copy in interface NodeInfo
    
    Parameters:
    out - the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.
    copyOptions - a selection of the options defined in CopyOptions
    locationId - If non-null, identifies the location of the instruction that requested this copy. If zero, indicates that the location information is not available
    
    Throws:
    
    XPathException - if any downstream error occurs
  - getDeclaredNamespaces
```
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
```
    Get all namespace undeclarations and undeclarations defined on this element.
    
    Specified by:
    
    getDeclaredNamespaces in interface NodeInfo
    
    Parameters:
    buffer - If this is non-null, and the result array fits in this buffer, then the result may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.
    
    Returns:
    An array of integers representing the namespace declarations and undeclarations present on this element. For a node other than an element, return null. Otherwise, the returned array is a sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The top half word of each namespace code represents the prefix, the bottom half represents the URI. If the bottom half is zero, then this is a namespace undeclaration rather than a declaration. The XML namespace is never included in the list. If the supplied array is larger than required, then the first unused entry will be set to -1.
    
    For a node other than an element, the method returns null.
  - isId
```
public boolean isId()
```
    Determine whether this node has the is-id property
    
    Specified by:
    
    isId in interface NodeInfo
    
    Returns:
    true if the node is an ID
  - isIdref
```
public boolean isIdref()
```
    Determine whether this node has the is-idref property
    
    Specified by:
    
    isIdref in interface NodeInfo
    
    Returns:
    true if the node is an IDREF or IDREFS element or attribute
  - isNilled
```
public boolean isNilled()
```
    Determine whether the node has the is-nilled property
    
    Specified by:
    
    isNilled in interface NodeInfo
    
    Returns:
    true if the node has the is-nilled property

Class AxiomAttributeWrapper

Field Summary

Fields inherited from interface net.sf.saxon.om.NodeInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

node

index

Constructor Detail

AxiomAttributeWrapper

Method Detail

getTreeInfo

head

iterate

getConfiguration

getUnderlyingNode

getRealNode

getNamePool

getNodeKind

atomize

getSchemaType

isSameNodeInfo

equals

hashCode

getSystemId

setSystemId

getPublicId

getBaseURI

getLineNumber

getColumnNumber

saveLocation

compareOrder

comparePosition

getStringValue

getStringValueCS

getFingerprint

getLocalPart

getPrefix

getURI

getDisplayName

getParent

getSiblingPosition

iterateAxis

iterateAxis

getAttributeValue

getRoot

hasChildNodes

generateId

copy

getDeclaredNamespaces

isId

isIdref

isNilled