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:

Source, SourceLocator, net.sf.saxon.expr.parser.Location, net.sf.saxon.om.Item, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>, net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.wrapper.VirtualNode, Locator

Direct Known Subclasses:

XOMDocumentWrapper

public class XOMNodeWrapper
extends net.sf.saxon.tree.wrapper.AbstractNodeWrapper
implements net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.util.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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.om.AtomicSequence	atomize() Get the typed value.
int	compareOrder(net.sf.saxon.om.NodeInfo other) Determine the relative position of this node and another node, in document order.
int	comparePosition(net.sf.saxon.om.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(net.sf.saxon.event.Receiver out, int copyOptions, net.sf.saxon.expr.parser.Location locationId) Copy this node to a given outputter (deep copy)
boolean	equals(Object other) The equals() method compares nodes for identity.
void	generateId(net.sf.saxon.tree.util.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
net.sf.saxon.Configuration	getConfiguration() Get the configuration
net.sf.saxon.om.NamespaceBinding[]	getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.
String	getDisplayName() Get the display name of this node.
XOMNodeWrapper	getFirstChild()
int	getLineNumber() Get line number
String	getLocalPart() Get the local part of the name of this node.
net.sf.saxon.om.NamePool	getNamePool() Get the name pool for this node
XOMNodeWrapper	getNextSibling()
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()
net.sf.saxon.om.NodeInfo	getRoot() Get the root node of the tree containing this node
net.sf.saxon.type.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.
XOMNodeWrapper	getSuccessorElement(XOMNodeWrapper anchor, String uri, String local)
String	getSystemId() Get the System ID for the node.
Object	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
boolean	isNilled() Determine whether the node has the is-nilled property
boolean	isSameNodeInfo(net.sf.saxon.om.NodeInfo other) Determine whether this is the same node as another node.
net.sf.saxon.om.SequenceIterator	iterate() To implement Sequence, this method returns a singleton iterator that delivers this item in the form of a sequence
protected net.sf.saxon.tree.iter.AxisIterator	iterateAttributes(net.sf.saxon.pattern.NodeTest nodeTest)
protected net.sf.saxon.tree.iter.AxisIterator	iterateChildren(net.sf.saxon.pattern.NodeTest nodeTest)
protected net.sf.saxon.tree.iter.AxisIterator	iterateDescendants(net.sf.saxon.pattern.NodeTest nodeTest, boolean includeSelf)
protected net.sf.saxon.tree.iter.AxisIterator	iterateSiblings(net.sf.saxon.pattern.NodeTest nodeTest, boolean forwards)
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

getFingerprint, getPublicId, getRealNode, getTreeInfo, hasFingerprint, head, isStreamed, 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

getFingerprint, getPublicId, getTreeInfo, hasFingerprint, isStreamed, 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.expr.parser.Location

saveLocation

Field Detail

node

protected nu.xom.Node node

nodeKind

protected short nodeKind

docWrapper

protected XOMDocumentWrapper docWrapper

index

protected int index

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

iterate

public net.sf.saxon.om.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 net.sf.saxon.om.Sequence

Overrides:

iterate in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Returns:

a singleton iterator that returns this item

getConfiguration

public net.sf.saxon.Configuration getConfiguration()

Get the configuration

Specified by:

getConfiguration in interface net.sf.saxon.om.NodeInfo

Overrides:

getConfiguration in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

getUnderlyingNode

public Object getUnderlyingNode()

Get the underlying XOM node, to implement the VirtualNode interface

Specified by:

getUnderlyingNode in interface net.sf.saxon.tree.wrapper.VirtualNode

getNamePool

public net.sf.saxon.om.NamePool getNamePool()

Get the name pool for this node

Overrides:

getNamePool in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Returns:

the NamePool

getNodeKind

public int getNodeKind()

Return the type of node.

Specified by:

getNodeKind in interface net.sf.saxon.om.NodeInfo

Returns:

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

atomize

public net.sf.saxon.om.AtomicSequence atomize()

Get the typed value.

Specified by:

atomize in interface net.sf.saxon.om.Item

Specified by:

atomize in interface net.sf.saxon.om.NodeInfo

Overrides:

atomize in class net.sf.saxon.tree.wrapper.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

getSchemaType

public net.sf.saxon.type.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 net.sf.saxon.om.NodeInfo

Overrides:

getSchemaType in class net.sf.saxon.tree.wrapper.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

isSameNodeInfo

public boolean isSameNodeInfo(net.sf.saxon.om.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 net.sf.saxon.om.NodeInfo

Overrides:

isSameNodeInfo in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.om.NodeInfo

Overrides:

equals in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.om.NodeInfo

Overrides:

hashCode in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.expr.parser.Location

Specified by:

getSystemId in interface net.sf.saxon.om.NodeInfo

Specified by:

getSystemId in interface Locator

Overrides:

getSystemId in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.om.NodeInfo

Overrides:

getBaseURI in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

getLineNumber

public int getLineNumber()

Get line number

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface net.sf.saxon.expr.parser.Location

Specified by:

getLineNumber in interface net.sf.saxon.om.NodeInfo

Specified by:

getLineNumber in interface Locator

Overrides:

getLineNumber in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.expr.parser.Location

Specified by:

getColumnNumber in interface net.sf.saxon.om.NodeInfo

Specified by:

getColumnNumber in interface Locator

Overrides:

getColumnNumber in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Returns:

the column number of the node in its original source document; or -1 if not available

compareOrder

public int compareOrder(net.sf.saxon.om.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 net.sf.saxon.om.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(net.sf.saxon.om.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 net.sf.saxon.om.NodeInfo

Overrides:

comparePosition in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.om.Item

Specified by:

getStringValue in interface net.sf.saxon.om.NodeInfo

Overrides:

getStringValue in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Returns:

the string value of the node

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 net.sf.saxon.om.Item

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 net.sf.saxon.om.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 net.sf.saxon.om.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 net.sf.saxon.om.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 net.sf.saxon.om.NodeInfo

Overrides:

getDisplayName in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.om.NodeInfo

Specified by:

getParent in interface net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>

getNextSibling

public XOMNodeWrapper getNextSibling()

Specified by:

getNextSibling in interface net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>

getPreviousSibling

public XOMNodeWrapper getPreviousSibling()

Specified by:

getPreviousSibling in interface net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>

getFirstChild

public XOMNodeWrapper getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>

getSuccessorElement

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

Specified by:

getSuccessorElement in interface net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>

getSiblingPosition

public int getSiblingPosition()

Get the index position of this node among its siblings (starting from 0)

Specified by:

getSiblingPosition in interface net.sf.saxon.tree.wrapper.SiblingCountingNode

iterateAttributes

protected net.sf.saxon.tree.iter.AxisIterator iterateAttributes(net.sf.saxon.pattern.NodeTest nodeTest)

Specified by:

iterateAttributes in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

iterateChildren

protected net.sf.saxon.tree.iter.AxisIterator iterateChildren(net.sf.saxon.pattern.NodeTest nodeTest)

Specified by:

iterateChildren in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

iterateSiblings

protected net.sf.saxon.tree.iter.AxisIterator iterateSiblings(net.sf.saxon.pattern.NodeTest nodeTest,
                                                              boolean forwards)

Specified by:

iterateSiblings in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

iterateDescendants

protected net.sf.saxon.tree.iter.AxisIterator iterateDescendants(net.sf.saxon.pattern.NodeTest nodeTest,
                                                                 boolean includeSelf)

Specified by:

iterateDescendants in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

getAttributeValue

public String getAttributeValue(String uri,
                                String local)

Get the string value of a given attribute of this node

Specified by:

getAttributeValue in interface net.sf.saxon.om.NodeInfo

Overrides:

getAttributeValue in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.om.NodeInfo getRoot()

Get the root node of the tree containing this node

Specified by:

getRoot in interface net.sf.saxon.om.NodeInfo

Overrides:

getRoot in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

generateId

public void generateId(net.sf.saxon.tree.util.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 net.sf.saxon.om.NodeInfo

Parameters:

buffer - a buffer to contain a string that uniquely identifies this node, across all documents

copy

public void copy(net.sf.saxon.event.Receiver out,
                 int copyOptions,
                 net.sf.saxon.expr.parser.Location locationId)
          throws net.sf.saxon.trans.XPathException

Copy this node to a given outputter (deep copy)

Specified by:

copy in interface net.sf.saxon.om.NodeInfo

Overrides:

copy in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Throws:

net.sf.saxon.trans.XPathException

getDeclaredNamespaces

public net.sf.saxon.om.NamespaceBinding[] getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] buffer)

Get all namespace undeclarations and undeclarations defined on this element.

Specified by:

getDeclaredNamespaces in interface net.sf.saxon.om.NodeInfo

Overrides:

getDeclaredNamespaces in class net.sf.saxon.tree.wrapper.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 net.sf.saxon.om.NodeInfo

Overrides:

isId in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.om.NodeInfo

Overrides:

isIdref in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

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 net.sf.saxon.om.NodeInfo

Overrides:

isNilled in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

Returns:

true if the node has the is-nilled property