net.sf.saxon.tree.wrapper

Class AbstractNodeWrapper

java.lang.Object

net.sf.saxon.tree.wrapper.AbstractNodeWrapper

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, Location, Item, NodeInfo, Sequence, VirtualNode, org.xml.sax.Locator

Direct Known Subclasses:

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

public abstract class AbstractNodeWrapper
extends java.lang.Object
implements NodeInfo, VirtualNode

A node in the XML parse tree representing an XML element, character content, or attribute.

This implementation of the NodeInfo interface contains common code used by many "wrapper" implementations for external data models.

Author:

Michael H. Kay

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeInfo	treeInfo

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

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, Location locationId) Copy this node to a given outputter (deep copy)
boolean	equals(java.lang.Object other) The equals() method compares nodes for identity.
java.lang.String	getAttributeValue(java.lang.String uri, java.lang.String local) Get the string value of a given attribute of this node.
java.lang.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.
java.lang.String	getDisplayName() Get the display name of this node.
int	getFingerprint() Get the fingerprint of the node
int	getLineNumber() Get line number
NamePool	getNamePool() Get the name pool for this node
java.lang.String	getPublicId() Get the Public ID of the entity containing the node.
java.lang.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.
java.lang.String	getStringValue() Return the string value of the node.
java.lang.String	getSystemId() Get the System ID for the node.
TreeInfo	getTreeInfo() Get information about the tree to which this NodeInfo belongs
boolean	hasChildNodes() Determine whether the node has any children.
boolean	hasFingerprint() Test whether a fingerprint is available for the node name
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.
boolean	isStreamed() Ask whether this is a node in a streamed document
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.
Location	saveLocation() Get an immutable copy of this Location object.
void	setSystemId(java.lang.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, getLocalPart, getNodeKind, getParent, getPrefix, getURI

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

getStringValueCS

Field Detail

treeInfo

protected TreeInfo treeInfo

Constructor Detail

AbstractNodeWrapper

public AbstractNodeWrapper()

Method Detail

getTreeInfo

public TreeInfo getTreeInfo()

Description copied from interface: NodeInfo

Get information about the tree to which this NodeInfo belongs

Specified by:

getTreeInfo in interface NodeInfo

Returns:

the TreeInfo

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 java.lang.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 to which the tree belongs

getNamePool

public NamePool getNamePool()

Get the name pool for this node

Returns:

the NamePool

atomize

public AtomicSequence atomize()

Get the typed value.

Specified by:

atomize in interface Item

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

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(java.lang.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 java.lang.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 java.lang.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 java.lang.String getSystemId()

Get the System ID for the node.

Specified by:

getSystemId in interface javax.xml.transform.Source

Specified by:

getSystemId in interface javax.xml.transform.SourceLocator

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface NodeInfo

Specified by:

getSystemId in interface org.xml.sax.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(java.lang.String uri)

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

Specified by:

setSystemId in interface javax.xml.transform.Source

Parameters:

uri - the system ID.

getPublicId

public java.lang.String getPublicId()

Get the Public ID of the entity containing the node.

Specified by:

getPublicId in interface javax.xml.transform.SourceLocator

Specified by:

getPublicId in interface Location

Specified by:

getPublicId in interface NodeInfo

Specified by:

getPublicId in interface org.xml.sax.Locator

Returns:

null (always)

Since:

9.7

getBaseURI

public java.lang.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 javax.xml.transform.SourceLocator

Specified by:

getLineNumber in interface Location

Specified by:

getLineNumber in interface NodeInfo

Specified by:

getLineNumber in interface org.xml.sax.Locator

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 javax.xml.transform.SourceLocator

Specified by:

getColumnNumber in interface Location

Specified by:

getColumnNumber in interface NodeInfo

Specified by:

getColumnNumber in interface org.xml.sax.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

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:

java.lang.UnsupportedOperationException - if either node is an attribute or namespace

Since:

9.5

getStringValue

public java.lang.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()

getDisplayName

public java.lang.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 java.lang.String getAttributeValue(java.lang.String uri,
                                          java.lang.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

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

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

isStreamed

public boolean isStreamed()

Ask whether this is a node in a streamed document

Specified by:

isStreamed in interface NodeInfo

Returns:

true if the node is in a document being processed using streaming

getFingerprint

public int getFingerprint()

Get the fingerprint of the node

Specified by:

getFingerprint in interface NodeInfo

Returns:

the node's fingerprint, or -1 for an unnamed node

Throws:

java.lang.UnsupportedOperationException - if this method is called for a node where hasFingerprint() returns false;

hasFingerprint

public boolean hasFingerprint()

Test whether a fingerprint is available for the node name

Specified by:

hasFingerprint in interface NodeInfo

Returns:

true if the implementation of this node provides fingerprints.