public class NodeWrapper extends java.lang.Object implements NodeInfo, VirtualNode, SiblingCountingNode
This is the implementation of the NodeInfo interface used as a wrapper for DOM4J nodes.
?????? | ????? |
---|---|
protected DocumentWrapper |
docWrapper |
protected int |
index |
protected java.lang.Object |
node |
protected short |
nodeKind |
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
??? | ?????? |
---|---|
protected |
NodeWrapper(java.lang.Object node,
NodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the wrap
factory method on the DocumentWrapper class
|
?????? | ????? |
---|---|
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)
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
java.lang.String |
getAttributeValue(int fingerprint)
Get the 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 used to build the tree containing this node.
|
int[] |
getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
int |
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
|
java.lang.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
|
java.lang.String |
getPrefix()
Get the prefix part of the name of this 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)
|
java.lang.String |
getStringValue()
Return the string value of the node.
|
java.lang.CharSequence |
getStringValueCS()
Get the string value of the item as a CharSequence.
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
int |
getTypeAnnotation()
Get the type annotation
|
SequenceIterator |
getTypedValue()
Get the typed value of the item
|
java.lang.Object |
getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface
|
java.lang.String |
getURI()
Get the URI part of the name of this node.
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
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 |
isSameNode(NodeInfo other)
Determine whether this is the same node as another node.
|
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(java.lang.Object node,
DocumentWrapper docWrapper)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon
NodeInfo interface.
|
protected NodeWrapper |
makeWrapper(java.lang.Object node,
DocumentWrapper docWrapper,
NodeWrapper parent,
int index)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon
NodeInfo interface.
|
void |
outputNamespaceNodes(Receiver out,
boolean includeAncestors)
Output all namespace nodes associated with this element.
|
void |
setSystemId(java.lang.String uri) |
protected java.lang.Object node
protected short nodeKind
protected DocumentWrapper docWrapper
protected int index
protected NodeWrapper(java.lang.Object node, NodeWrapper parent, int index)
node
- The DOM4J node to be wrappedparent
- The NodeWrapper that wraps the parent of this nodeindex
- Position of this node among its siblingsprotected NodeWrapper makeWrapper(java.lang.Object node, DocumentWrapper docWrapper)
node
- The DOM4J nodedocWrapper
- The wrapper for the Document containing this nodeprotected NodeWrapper makeWrapper(java.lang.Object node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
node
- The DOM4J nodedocWrapper
- The wrapper for the Document containing this nodeparent
- The wrapper for the parent of the DOM4J nodeindex
- The position of this node relative to its siblingspublic java.lang.Object getUnderlyingNode()
getUnderlyingNode
???? VirtualNode
public NamePool getNamePool()
getNamePool
???? NodeInfo
public int getNodeKind()
getNodeKind
???? NodeInfo
Type
public SequenceIterator getTypedValue()
getTypedValue
???? Item
public Value atomize()
NodeInfo
Item.getTypedValue()
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.public int getTypeAnnotation()
getTypeAnnotation
???? NodeInfo
public boolean isSameNode(NodeInfo other)
other
- the node to be compared withpublic java.lang.String getSystemId()
getSystemId
???? javax.xml.transform.Source
getSystemId
???? NodeInfo
public void setSystemId(java.lang.String uri)
setSystemId
???? javax.xml.transform.Source
public java.lang.String getBaseURI()
getBaseURI
???? NodeInfo
public int getLineNumber()
getLineNumber
???? NodeInfo
public int getColumnNumber()
getColumnNumber
???? NodeInfo
public int compareOrder(NodeInfo other)
compareOrder
???? NodeInfo
other
- The other node, whose position is to be compared with this nodepublic java.lang.String getStringValue()
getStringValue
???? Item
getStringValue
???? NodeInfo
getStringValue
???? ValueRepresentation
Item.getStringValueCS()
public java.lang.CharSequence getStringValueCS()
Item
X.getStringValueCS().toString()
returns a string that is equal to
X.getStringValue()
.
Note that two CharSequence values of different types should not be compared using equals(), and for the same reason they should not be used as a key in a hash table.
If the calling code can handle any CharSequence, this method should
be used. If the caller requires a string, the Item.getStringValue()
method is preferred.
getStringValueCS
???? Item
getStringValueCS
???? ValueRepresentation
Item.getStringValue()
public int getNameCode()
getNameCode
???? NodeInfo
allocate
public int getFingerprint()
getFingerprint
???? NodeInfo
public java.lang.String getLocalPart()
getLocalPart
???? NodeInfo
public java.lang.String getPrefix()
public java.lang.String getURI()
public java.lang.String getDisplayName()
getDisplayName
???? NodeInfo
public NodeInfo getParent()
public int getSiblingPosition()
getSiblingPosition
???? SiblingCountingNode
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
???? NodeInfo
axisNumber
- the axis to be usedAxis
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
???? NodeInfo
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodesAxis
public java.lang.String getAttributeValue(int fingerprint)
getAttributeValue
???? NodeInfo
fingerprint
- The fingerprint of the attribute namepublic NodeInfo getRoot()
public DocumentInfo getDocumentRoot()
getDocumentRoot
???? NodeInfo
public boolean hasChildNodes()
hasChildNodes
???? NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
???? NodeInfo
buffer
- a Buffer to contain a string that uniquely identifies this node, across all
documentspublic int getDocumentNumber()
getDocumentNumber
???? NodeInfo
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
copy
???? NodeInfo
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.whichNamespaces
- in the case of an element, controls
which namespace nodes should be copied. Values are NodeInfo.NO_NAMESPACES
,
NodeInfo.LOCAL_NAMESPACES
, NodeInfo.ALL_NAMESPACES
copyAnnotations
- indicates whether the type annotations
of element and attribute nodes should be copiedlocationId
- If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
for the original node is to be copied; in this case the Receiver must be
a LocationCopierXPathException
public void outputNamespaceNodes(Receiver out, boolean includeAncestors) throws XPathException
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor elements must
be output; false if it is known that these are already on the result treeXPathException
public boolean isId()
public boolean isIdref()
public boolean isNilled()
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
???? NodeInfo
other
- the node to be compared with this nodepublic Configuration getConfiguration()
NodeInfo
getConfiguration
???? NodeInfo
public int[] getDeclaredNamespaces(int[] buffer)
getDeclaredNamespaces
???? NodeInfo
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.For a node other than an element, the method returns null.