net.sf.saxon.option.axiom

Class AxiomElementNodeWrapper

java.lang.Object

net.sf.saxon.tree.wrapper.AbstractNodeWrapper

net.sf.saxon.option.axiom.AxiomParentNodeWrapper

net.sf.saxon.option.axiom.AxiomElementNodeWrapper

All Implemented Interfaces:

Source, PullEvent, Item, NodeInfo, Sequence, SiblingCountingNode, VirtualNode

public class AxiomElementNodeWrapper
extends AxiomParentNodeWrapper

A node in the XDM tree; specifically, a node that wraps an Axiom document node or element node. If the wrapped node is a document node,

Author:

Michael H. Kay

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.option.axiom.AxiomParentNodeWrapper

AxiomParentNodeWrapper.ChildWrappingIterator, AxiomParentNodeWrapper.DescendantWrappingIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected AxiomDocumentWrapper	docWrapper
protected int	index

Fields inherited from class net.sf.saxon.option.axiom.AxiomParentNodeWrapper

node

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AxiomElementNodeWrapper(org.apache.axiom.om.OMElement node, AxiomDocumentWrapper docWrapper, 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
int	compareOrder(NodeInfo other) Determine the relative position of this node and another node, in document order.
String	getAttributeValue(String uri, String local) Get the string value of a given attribute of this node
NamespaceBinding[]	getDeclaredNamespaces(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.
long	getDocumentNumber() Get the document number of the document containing this node.
DocumentInfo	getDocumentRoot() Get the root node, if it is a document node.
String	getLocalPart() Get the local part of the name of this node.
int	getNodeKind() Return the type of node.
AxiomParentNodeWrapper	getParent() Get the NodeInfo object representing the parent of this node
String	getPrefix() Get the prefix of the name of the 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)
int	getTypeAnnotation() Get the type annotation
String	getURI() Get the URI part of the name of this node.
protected AxisIterator	iterateAttributes(NodeTest nodeTest) Return an iterator over the attributes of this element node.
protected AxisIterator	iterateSiblings(NodeTest nodeTest, boolean forwards) Return an iterator over the siblings of this node.

Methods inherited from class net.sf.saxon.option.axiom.AxiomParentNodeWrapper

atomize, generateId, getStringValueCS, getUnderlyingNode, hasChildNodes, iterateChildren, iterateDescendants

Methods inherited from class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

comparePosition, copy, equals, getBaseURI, getColumnNumber, getConfiguration, getDisplayName, getFingerprint, getLineNumber, getNameCode, getNamePool, getRealNode, getStringValue, getSystemId, hashCode, head, isId, isIdref, isNilled, isSameNodeInfo, iterate, iterateAxis, iterateAxis, setSystemId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

comparePosition, copy, equals, getBaseURI, getColumnNumber, getConfiguration, getDisplayName, getFingerprint, getLineNumber, getNameCode, getNamePool, getStringValue, getSystemId, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from interface javax.xml.transform.Source

setSystemId

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.Sequence

iterate

Field Detail

docWrapper

protected AxiomDocumentWrapper docWrapper

index

protected int index

Constructor Detail

AxiomElementNodeWrapper

protected AxiomElementNodeWrapper(org.apache.axiom.om.OMElement node,
                       AxiomDocumentWrapper docWrapper,
                       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 node to be wrapped

docWrapper - The wrapper around the document node at the root of the tree

parent - The NodeWrapper that wraps the parent of this node

index - Position of this node among its siblings

Method Detail

getNodeKind

public int getNodeKind()

Return the type of node.

Returns:

one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.

See Also:

Type

getTypeAnnotation

public int getTypeAnnotation()

Get the type annotation

Specified by:

getTypeAnnotation in interface NodeInfo

Overrides:

getTypeAnnotation in class AbstractNodeWrapper

Returns:

the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated as untypedAtomic for the purposes of obtaining the typed value).

For elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).

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

Overrides:

getSchemaType in class AbstractNodeWrapper

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

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.

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())

getLocalPart

public String getLocalPart()

Get the local part of the name of this node. This is the name after the ":" if any.

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.

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.

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.

getParent

public AxiomParentNodeWrapper getParent()

Get the NodeInfo object representing the parent of this node

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)

Returns:

0 for the first child, 1 for the second child, etc.

iterateAttributes

protected AxisIterator iterateAttributes(NodeTest nodeTest)

Description copied from class: AbstractNodeWrapper

Return an iterator over the attributes of this element node. This method is only called after checking that the node is an element.

Specified by:

iterateAttributes in class AbstractNodeWrapper

Parameters:

nodeTest - a test that the returned attributes must satisfy

Returns:

an iterator over the attribute nodes. The order of the result, although arbitrary, must be consistent with document order.

iterateSiblings

protected AxisIterator iterateSiblings(NodeTest nodeTest,
                           boolean forwards)

Description copied from class: AbstractNodeWrapper

Return an iterator over the siblings of this node. This method is only called after checking that the node is an element, text, comment, or PI node.

Specified by:

iterateSiblings in class AbstractNodeWrapper

Parameters:

nodeTest - a test that the returned siblings must satisfy

forwards - true for following siblings, false for preceding siblings

Returns:

an iterator over the sibling nodes, in axis order.

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

Overrides:

getAttributeValue in class AbstractNodeWrapper

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

Overrides:

getRoot in class AbstractNodeWrapper

Returns:

the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node

getDocumentRoot

public DocumentInfo getDocumentRoot()

Get the root node, if it is a document node.

Returns:

the DocumentInfo representing the containing document.

getDocumentNumber

public long getDocumentNumber()

Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.

Specified by:

getDocumentNumber in interface NodeInfo

Overrides:

getDocumentNumber in class AbstractNodeWrapper

Returns:

the document number of the document containing this node

getDeclaredNamespaces

public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)

Get all namespace undeclarations and undeclarations defined on this element.

Specified by:

getDeclaredNamespaces in interface NodeInfo

Overrides:

getDeclaredNamespaces in class AbstractNodeWrapper

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.