net.sf.saxon.option.dom4j

Class NodeWrapper

public class NodeWrapper extends Object implements NodeInfo, VirtualNode, SiblingCountingNode

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

Author: Michael H. Kay

Field Summary
protected DocumentWrapperdocWrapper
protected intindex
protected Objectnode
protected shortnodeKind
Constructor Summary
protected NodeWrapper(Object node, NodeWrapper parent, int index)
This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class
Method Summary
Valueatomize()
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (deep copy)
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
intgetColumnNumber()
Get column number
ConfigurationgetConfiguration()
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
StringgetDisplayName()
Get the display name of this node.
longgetDocumentNumber()
Get the document number of the document containing this node.
DocumentInfogetDocumentRoot()
Get the root (document) node
intgetFingerprint()
Get fingerprint.
intgetLineNumber()
Get line number
StringgetLocalPart()
Get the local part of the name of this node.
intgetNameCode()
Get name code.
NamePoolgetNamePool()
Get the name pool for this node
intgetNodeKind()
Return the type of node.
NodeInfogetParent()
Get the NodeInfo object representing the parent of this node
StringgetPrefix()
Get the prefix part of the name of this node.
ObjectgetRealNode()
Get the node underlying this virtual node.
NodeInfogetRoot()
Get the root node - always a document node with this tree implementation
intgetSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
StringgetStringValue()
Return the string value of the node.
CharSequencegetStringValueCS()
StringgetSystemId()
Get the System ID for the node.
intgetTypeAnnotation()
Get the type annotation
SequenceIteratorgetTypedValue()
Get the typed value of the item
ObjectgetUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface
StringgetURI()
Get the URI part of the name of this node.
booleanhasChildNodes()
Determine whether the node has any children.
booleanisId()
Determine whether this node has the is-id property
booleanisIdref()
Determine whether this node has the is-idref property
booleanisNilled()
Determine whether the node has the is-nilled property
booleanisSameNode(NodeInfo other)
Determine whether this is the same node as another node.
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
AxisIteratoriterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node
AxisIteratoriterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node
protected NodeWrappermakeWrapper(Object node, DocumentWrapper docWrapper)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface.
protected NodeWrappermakeWrapper(Object node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface.
voidoutputNamespaceNodes(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element.
voidsetSystemId(String uri)

Field Detail

docWrapper

protected DocumentWrapper docWrapper

index

protected int index

node

protected Object node

nodeKind

protected short nodeKind

Constructor Detail

NodeWrapper

protected NodeWrapper(Object node, NodeWrapper parent, int index)
This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class

Parameters: node The DOM4J node to be wrapped parent The NodeWrapper that wraps the parent of this node index Position of this node among its siblings

Method Detail

atomize

public Value atomize()

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

copy

public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (deep copy)

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)

Parameters: buffer a Buffer to contain a string that uniquely identifies this node, across all documents

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

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. In the DOM4J model, base URIs are held only an the document level. We don't currently take any account of xml:base attributes.

getColumnNumber

public int getColumnNumber()
Get column number

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

getConfiguration

public Configuration getConfiguration()

getDeclaredNamespaces

public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.

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.

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.

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

getDocumentNumber

public long getDocumentNumber()
Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node

Returns: the DocumentInfo representing the containing document

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.

getLineNumber

public int getLineNumber()
Get line number

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

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 "".

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.

See Also: allocate

getNamePool

public NamePool getNamePool()
Get the name pool for this node

Returns: the NamePool

getNodeKind

public int getNodeKind()
Return the type of node.

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

getParent

public NodeInfo getParent()
Get the NodeInfo object representing the parent of this node

getPrefix

public String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any. (Note, this method isn't required as part of the NodeInfo interface.)

Returns: the prefix part of the name. For an unnamed node, return an empty string.

getRealNode

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

Returns: The underlying node.

getRoot

public NodeInfo getRoot()
Get the root node - always a document node with this tree implementation

Returns: the NodeInfo representing the containing document

getSiblingPosition

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

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.

Returns: the string value of the node

getStringValueCS

public CharSequence getStringValueCS()

getSystemId

public String getSystemId()
Get the System ID for the node.

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.

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation

Returns: UNTYPED or UNTYPED_ATOMIC

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of the item

getUnderlyingNode

public Object getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface

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, return null. For a node with an empty prefix, return an empty string.

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()

isId

public boolean isId()
Determine whether this node has the is-id property

Returns: true if the node is an ID. For DOM4J, this always returns false, because no information about attribute types is available.

isIdref

public boolean isIdref()
Determine whether this node has the is-idref property

Returns: true if the node is an IDREF or IDREFS element or attribute. For DOM4J, this always returns false, because no information about attribute types is available.

isNilled

public boolean isNilled()
Determine whether the node has the is-nilled property

Returns: true if the node has the is-nilled property. For DOM4J, this always returns false

isSameNode

public boolean isSameNode(NodeInfo other)
Determine whether this is the same node as another node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)

Parameters: other the node to be compared with

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

isSameNodeInfo

public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node. Note: a.isSameNodeInfo(b) if and only if generateId(a)==generateId(b). This method has the same semantics as isSameNode() in DOM Level 3, but works on Saxon NodeInfo objects rather than DOM Node objects.

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.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node

Parameters: axisNumber the axis to be used

Returns: a SequenceIterator that scans the nodes reached by the axis in turn.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node

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.

makeWrapper

protected NodeWrapper makeWrapper(Object node, DocumentWrapper docWrapper)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface.

Parameters: node The DOM4J node docWrapper The wrapper for the Document containing this node

Returns: The new wrapper for the supplied node

makeWrapper

protected NodeWrapper makeWrapper(Object node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface.

Parameters: node The DOM4J node docWrapper The wrapper for the Document containing this node parent The wrapper for the parent of the DOM4J node index The position of this node relative to its siblings

Returns: The new wrapper for the supplied node

outputNamespaceNodes

public void outputNamespaceNodes(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. Does nothing if the node is not an element.

Parameters: out The relevant outputter includeAncestors True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree

setSystemId

public void setSystemId(String uri)