net.sf.saxon.option.xom

Class XOMNodeWrapper

java.lang.Object

net.sf.saxon.tree.wrapper.AbstractNodeWrapper

net.sf.saxon.option.xom.XOMNodeWrapper

All Implemented Interfaces:

Iterable<NodeInfo>, Source, SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, NodeInfo, Sequence<NodeInfo>, SteppingNode<XOMNodeWrapper>, SiblingCountingNode, VirtualNode, Locator

Direct Known Subclasses:

XOMDocumentWrapper

public class XOMNodeWrapper
extends AbstractNodeWrapper
implements SiblingCountingNode, SteppingNode<XOMNodeWrapper>

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 XOM nodes.

Author:

Michael H. Kay, Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM)

Field Summary

Fields

Modifier and Type	Field and Description
protected XOMDocumentWrapper	docWrapper
protected int	index
protected nu.xom.Node	node
protected short	nodeKind

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

treeInfo

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor and Description
XOMNodeWrapper(nu.xom.Node node, XOMNodeWrapper parent, int index) This constructor is protected: nodes should be created using the wrap factory method on the XOMDocumentWrapper class

Method Summary

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.
boolean	equals(Object other) Determine whether this is the same node as another node.
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.
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.
XOMNodeWrapper	getFirstChild() Get the first child of this node
String	getLocalPart() Get the local part of the name of this node.
NamePool	getNamePool() Get the name pool for this node
XOMNodeWrapper	getNextSibling() Get the next sibling of this node
int	getNodeKind() Return the type of node.
XOMNodeWrapper	getParent() Get the NodeInfo object representing the parent of this node
String	getPrefix() Get the prefix of the name of the node.
XOMNodeWrapper	getPreviousSibling() Get the previous sibling of this node
NodeInfo	getRoot() Get the root node of the tree containing this node
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.
XOMNodeWrapper	getSuccessorElement(XOMNodeWrapper anchor, String uri, String local) Find the next matching element in document order; that is, the first child element with the required name if there is one; otherwise the next sibling element if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.
String	getSystemId() Get the System ID for the node.
nu.xom.Node	getUnderlyingNode() Get the underlying XOM 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()
boolean	isId() Determine whether this node has the is-id property
boolean	isIdref() Determine whether this node has the is-idref property
protected AxisIterator	iterateAttributes(NodeTest nodeTest) Return an iterator over the attributes of this element node.
protected AxisIterator	iterateChildren(NodeTest nodeTest) Return an iterator over the children of this node.
protected AxisIterator	iterateDescendants(NodeTest nodeTest, boolean includeSelf) Return an iterator over the descendants of this node.
protected AxisIterator	iterateSiblings(NodeTest nodeTest, boolean forwards) Return an iterator over the siblings of this node.
protected XOMNodeWrapper	makeWrapper(nu.xom.Node node, XOMDocumentWrapper docWrapper) Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.
protected XOMNodeWrapper	makeWrapper(nu.xom.Node node, XOMDocumentWrapper docWrapper, XOMNodeWrapper parent, int index) Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.

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

getColumnNumber, getFingerprint, getLineNumber, getRealNode, getTreeInfo, hasFingerprint, iterateAxis, iterateAxis, saveLocation, 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

copy, getColumnNumber, getFingerprint, getGenre, getLineNumber, getPublicId, getSchemaType, getTreeInfo, hasFingerprint, isNilled, isSameNodeInfo, isStreamed, iterateAxis, iterateAxis, toShortString

Methods inherited from interface javax.xml.transform.Source

setSystemId

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

getLength, head, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

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

asIterable, effectiveBooleanValue, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sf.saxon.expr.parser.Location

saveLocation

Field Detail

node

protected nu.xom.Node node

nodeKind

protected short nodeKind

docWrapper

protected XOMDocumentWrapper docWrapper

index

protected int index

Constructor Detail

XOMNodeWrapper

XOMNodeWrapper(nu.xom.Node node,
               XOMNodeWrapper parent,
               int index)

This constructor is protected: nodes should be created using the wrap factory method on the XOMDocumentWrapper class

Parameters:

node - The XOM node to be wrapped

parent - The XOMNodeWrapper that wraps the parent of this node

index - Position of this node among its siblings

Method Detail

makeWrapper

protected final XOMNodeWrapper makeWrapper(nu.xom.Node node,
                                           XOMDocumentWrapper docWrapper)

Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.

Parameters:

node - The XOM node

docWrapper - The wrapper for the Document containing this node

Returns:

The new wrapper for the supplied node

makeWrapper

protected final XOMNodeWrapper makeWrapper(nu.xom.Node node,
                                           XOMDocumentWrapper docWrapper,
                                           XOMNodeWrapper parent,
                                           int index)

Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.

Parameters:

node - The XOM node

docWrapper - The wrapper for the Document containing this node

parent - The wrapper for the parent of the XOM node

index - The position of this node relative to its siblings

Returns:

The new wrapper for the supplied node

getConfiguration

public Configuration getConfiguration()

Get the configuration

Specified by:

getConfiguration in interface NodeInfo

Returns:

the Configuration to which the tree belongs. The default implementation invokes getTreeInfo().getConfiguration().

getUnderlyingNode

public nu.xom.Node getUnderlyingNode()

Get the underlying XOM node, to implement the VirtualNode interface

Specified by:

getUnderlyingNode in interface VirtualNode

Returns:

The underlying node.

getNamePool

public NamePool getNamePool()

Get the name pool for this node

Overrides:

getNamePool in class AbstractNodeWrapper

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<NodeInfo>

Specified by:

atomize in interface NodeInfo

Overrides:

atomize in class AbstractNodeWrapper

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

equals

public boolean equals(Object 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:

equals in interface NodeInfo

Overrides:

equals in class AbstractNodeWrapper

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.

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 AbstractNodeWrapper

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

Overrides:

getSystemId in class AbstractNodeWrapper

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.

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

Overrides:

getBaseURI in class AbstractNodeWrapper

Returns:

the base URI of the node, taking into account xml:base attributes if present

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

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 GroundedValue<NodeInfo>

Specified by:

getStringValue in interface Item<NodeInfo>

Specified by:

getStringValue in interface NodeInfo

Overrides:

getStringValue in class AbstractNodeWrapper

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 GroundedValue<NodeInfo>

Specified by:

getStringValueCS in interface Item<NodeInfo>

Returns:

the string value of the item

See Also:

Item.getStringValue()

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

Overrides:

getDisplayName in class AbstractNodeWrapper

Returns:

The display name of this node. For a node with no name, return an empty string.

getParent

public XOMNodeWrapper getParent()

Get the NodeInfo object representing the parent of this node

Specified by:

getParent in interface NodeInfo

Specified by:

getParent in interface SteppingNode<XOMNodeWrapper>

Returns:

the parent of this node; null if this node has no parent

getNextSibling

public XOMNodeWrapper getNextSibling()

Description copied from interface: SteppingNode

Get the next sibling of this node

Specified by:

getNextSibling in interface SteppingNode<XOMNodeWrapper>

Returns:

the next sibling if there is one, or null otherwise

getPreviousSibling

public XOMNodeWrapper getPreviousSibling()

Description copied from interface: SteppingNode

Get the previous sibling of this node

Specified by:

getPreviousSibling in interface SteppingNode<XOMNodeWrapper>

Returns:

the previous sibling if there is one, or null otherwise

getFirstChild

public XOMNodeWrapper getFirstChild()

Description copied from interface: SteppingNode

Get the first child of this node

Specified by:

getFirstChild in interface SteppingNode<XOMNodeWrapper>

Returns:

the first child if there is one, or null otherwise

getSuccessorElement

public XOMNodeWrapper getSuccessorElement(XOMNodeWrapper anchor,
                                          String uri,
                                          String local)

Description copied from interface: SteppingNode

Find the next matching element in document order; that is, the first child element with the required name if there is one; otherwise the next sibling element if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.

Specified by:

getSuccessorElement in interface SteppingNode<XOMNodeWrapper>

Parameters:

anchor - the root of the tree within which navigation is confined

uri - the required namespace URI, or null if any namespace is acceptable

local - the required local name, or null if any local name is acceptable

Returns:

the next element after this one in document order, with the given URI and local name if specified, or null if this is the last node in the document, or the last node within the subtree being navigated

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.

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.

iterateChildren

protected AxisIterator iterateChildren(NodeTest nodeTest)

Description copied from class: AbstractNodeWrapper

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

Specified by:

iterateChildren in class AbstractNodeWrapper

Parameters:

nodeTest - a test that the returned attributes must satisfy

Returns:

an iterator over the child nodes, in 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.

iterateDescendants

protected AxisIterator iterateDescendants(NodeTest nodeTest,
                                          boolean includeSelf)

Description copied from class: AbstractNodeWrapper

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

Overrides:

iterateDescendants in class AbstractNodeWrapper

Parameters:

nodeTest - a test that the returned descendants must satisfy

includeSelf - true if this node is to be included in the result

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

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

Overrides:

hasChildNodes in class AbstractNodeWrapper

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

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.

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