net.sf.saxon.tree.wrapper

Class AbstractNodeWrapper

java.lang.Object

net.sf.saxon.tree.wrapper.AbstractNodeWrapper

All Implemented Interfaces:

Source, PullEvent, Item, NodeInfo, Sequence, VirtualNode

Direct Known Subclasses:

AxiomLeafNodeWrapper, AxiomParentNodeWrapper, DOM4JNodeWrapper, DOMNodeWrapper, JDOM2NodeWrapper, JDOMNodeWrapper, XOMNodeWrapper

public abstract class AbstractNodeWrapper
extends Object
implements NodeInfo, VirtualNode

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

Author:

Michael H. Kay

Field Summary

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

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
AbstractNodeWrapper()

Method Summary

Methods

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value.
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, int locationId) Copy this node to a given outputter (deep copy)
boolean	equals(Object other) The equals() method compares nodes for identity.
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 declarations and undeclarations defined on this element.
String	getDisplayName() Get the display name of this node.
long	getDocumentNumber() Get the document number of the document containing this node.
int	getFingerprint() Get fingerprint.
int	getLineNumber() Get line number
int	getNameCode() Get name code.
NamePool	getNamePool() Get the name pool for this node
Object	getRealNode() Get the node underlying this virtual node.
NodeInfo	getRoot() Get the root node - always a document node with this tree implementation
SchemaType	getSchemaType() Get the type annotation of this node, if any.
String	getStringValue() Return the string value of the node.
String	getSystemId() Get the System ID for the node.
int	getTypeAnnotation() Get the type annotation
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
protected abstract AxisIterator	iterateAttributes(NodeTest nodeTest) Return an iterator over the attributes of this element node.
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.
protected abstract AxisIterator	iterateChildren(NodeTest nodeTest) Return an iterator over the children of this node.
protected abstract AxisIterator	iterateDescendants(NodeTest nodeTest, boolean includeSelf) Return an iterator over the descendants of this node.
protected abstract AxisIterator	iterateSiblings(NodeTest nodeTest, boolean forwards) Return an iterator over the siblings of this node.
void	setSystemId(String uri) Set the system ID.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.tree.wrapper.VirtualNode

getUnderlyingNode

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

compareOrder, generateId, getDocumentRoot, getLocalPart, getNodeKind, getParent, getPrefix, getURI

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

getStringValueCS

Constructor Detail

AbstractNodeWrapper

public AbstractNodeWrapper()

Method Detail

head

public final 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

getRealNode

public final 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.

getConfiguration

public Configuration getConfiguration()

Get the configuration. The implementation of this method assumes that the tree is rooted at a document node, and that the document node holds a reference to the Configuration. If this is not the case, the method must be overridden in a subclass.

Specified by:

getConfiguration in interface NodeInfo

Returns:

the Configuration

getNamePool

public NamePool getNamePool()

Get the name pool for this node

Specified by:

getNamePool in interface NodeInfo

Returns:

the NamePool

atomize

public AtomicSequence atomize()

Get the typed value.

Specified by:

atomize in interface NodeInfo

Returns:

the typed value. This will either be a single AtomicValue or a value whose items are atomic values.

Since:

8.5 - signature changed in 9.5

getTypeAnnotation

public int getTypeAnnotation()

Get the type annotation

Specified by:

getTypeAnnotation in interface NodeInfo

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

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 NodeInfo

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)

Set the system ID. Required because NodeInfo implements the JAXP Source interface

Specified by:

setSystemId in interface Source

Parameters:

uri - the system ID.

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, taking into account xml:base attributes if present

getLineNumber

public int getLineNumber()

Get line number

Specified by:

getLineNumber in interface NodeInfo

Returns:

the line number of the node in its original source document; or -1 if not available. Always returns -1 in this implementation.

getColumnNumber

public int getColumnNumber()

Get column number

Specified by:

getColumnNumber in interface NodeInfo

Returns:

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

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

getNameCode

public int getNameCode()

Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with &0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.

Specified by:

getNameCode in interface NodeInfo

Returns:

an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.

See Also:

allocate

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.

Specified by:

getFingerprint in interface NodeInfo

Returns:

an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.

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.

getAttributeValue

public String getAttributeValue(String uri,
                       String local)

Get the string value of a given attribute of this node.

The default implementation is suitable for nodes other than elements.

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

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.

This superclass provides implementations of the ancestor, ancestor-or-self, following, namespace, parent, preceding, self, and preceding-or-ancestor axes. The other axes are implemented by calling methods iterateAttributes(), iterateChildren(), iterateDescendants(), and iterateSiblings(), which must be provided in a subclass.

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

iterateAttributes

protected abstract AxisIterator iterateAttributes(NodeTest nodeTest)

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

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 abstract AxisIterator iterateChildren(NodeTest nodeTest)

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

Parameters:

nodeTest - a test that the returned attributes must satisfy

Returns:

an iterator over the child nodes, in document order.

iterateSiblings

protected abstract AxisIterator iterateSiblings(NodeTest nodeTest,
                           boolean forwards)

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.

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 abstract AxisIterator iterateDescendants(NodeTest nodeTest,
                              boolean includeSelf)

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.

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.

getDeclaredNamespaces

public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)

Get all namespace declarations and undeclarations defined on this element.

This method is intended primarily for internal use. User applications needing information about the namespace context of a node should use iterateAxis(Axis.NAMESPACE). (However, not all implementations support the namespace axis, whereas all implementations are required to support this method.)

This implementation of the method is suitable for all nodes other than elements; it returns an empty array.

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.

getRoot

public NodeInfo getRoot()

Get the root node - always a document node with this tree implementation

Specified by:

getRoot in interface NodeInfo

Returns:

the NodeInfo representing the containing document

hasChildNodes

public boolean hasChildNodes()

Determine whether the node has any children. This implementation calls iterateAxis, so the subclass implementation of iterateAxis must avoid calling this method.

Specified by:

hasChildNodes in interface NodeInfo

Returns:

True if the node has one or more children

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

Returns:

the document number of the document containing this node

copy

public void copy(Receiver out,
        int copyOptions,
        int 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-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information

Throws:

XPathException - if any downstream error occurs

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. This implementation always returns false

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. This implementation always returns false

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. This implementation always returns false