net.sf.saxon.option.jdom
public class NodeWrapper extends Object implements NodeInfo, VirtualNode, SiblingCountingNode
This is the implementation of the NodeInfo interface used as a wrapper for JDOM nodes.
Field Summary | |
---|---|
protected DocumentWrapper | docWrapper |
protected int | index |
protected Object | node |
protected short | nodeKind |
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 | |
---|---|
Value | atomize()
Get the typed value. |
int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (deep copy) |
boolean | equals(Object other)
The equals() method compares nodes for identity. |
void | generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
String | getAttributeValue(int fingerprint)
Get the 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 |
int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations 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. |
DocumentInfo | getDocumentRoot()
Get the root (document) node |
int | getFingerprint()
Get fingerprint. |
int | getLineNumber()
Get line number |
String | getLocalPart()
Get the local part of the name of this node. |
int | getNameCode()
Get name code. |
NamePool | getNamePool()
Get the name pool for this node |
int | getNodeKind()
Return the type of node. |
NodeInfo | getParent()
Get the NodeInfo object representing the parent of this node |
String | getPrefix()
Get the prefix part of the name of 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 |
int | getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
In the case of a text node that maps to several adjacent siblings in the JDOM,
the numbering actually refers to the position of the underlying JDOM nodes;
thus the sibling position for the text node is that of the first JDOM node
to which it relates, and the numbering of subsequent XPath nodes is not necessarily
consecutive. |
String | getStringValue()
Return the string value of the node. |
CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. |
String | getSystemId()
Get the System ID for the node. |
int | getTypeAnnotation()
Get the type annotation |
SequenceIterator | getTypedValue()
Get the typed value of the item |
Object | getUnderlyingNode()
Get the underlying JDOM 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(NodeInfo other)
Determine whether this is the same node as another 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 NodeWrapper | makeWrapper(Object node, DocumentWrapper docWrapper)
Factory method to wrap a JDOM node with a wrapper that implements the Saxon
NodeInfo interface. |
protected NodeWrapper | makeWrapper(Object node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
Factory method to wrap a JDOM node with a wrapper that implements the Saxon
NodeInfo interface. |
void | setSystemId(String uri) |
Parameters: node The JDOM node to be wrapped parent The NodeWrapper that wraps the parent of this node index Position of this node among its siblings
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
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())
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.
Parameters: buffer a Buffer to contain a string that uniquely identifies this node, across all documents
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists, or null if not
Returns: the column number of the node in its original source document; or -1 if not available
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.
Returns: The display name of this node. For a node with no name, return an empty string.
Returns: the DocumentInfo representing the containing document
Returns: the line number of the node in its original source document; or -1 if not available. Always returns -1 in this implementation.
Returns: the local part of the name. For an unnamed node, returns "".
See Also: allocate
Returns: the NamePool
Returns: one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
Returns: the prefix part of the name. For an unnamed node, return an empty string.
Returns: The underlying node.
Returns: the NodeInfo representing the containing document
Returns: the string value of 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.
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.
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.
Returns: true if the node is an ID
Returns: true if the node is an IDREF or IDREFS element or attribute
Returns: true if the node has the is-nilled property
Returns: true if this Node object and the supplied Node object represent the same node in the tree.
Parameters: axisNumber the axis to be used
Returns: a SequenceIterator that scans the nodes reached by the axis in turn.
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.
Parameters: node The JDOM node docWrapper The wrapper for the Document containing this node
Returns: The new wrapper for the supplied node
Parameters: node The JDOM node docWrapper The wrapper for the Document containing this node parent The wrapper for the parent of the JDOM node index The position of this node relative to its siblings
Returns: The new wrapper for the supplied node