| java.lang.Object
 net.sf.saxon.xom.NodeWrapper
All known Subclasses: net.sf.saxon.xom.DocumentWrapper,
| NodeWrapper | | public class NodeWrapper implements NodeInfo,VirtualNode,SiblingCountingNode(Code) | | 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
XOM nodes.
author:
Michael H. Kay
author:
Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM) |
| Method Summary | |
| public Value | atomize()
Get the typed value. | | public int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in
document order. | | public void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
| | public String | generateId()
Get a character string that uniquely identifies this node. | | public String | getAttributeValue(int fingerprint)
| | public String | getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a
relative URI contained in the node. | | public Configuration | getConfiguration()
| | 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 resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. | | public String | getDisplayName()
Get the display name of this node. | | public int | getDocumentNumber()
Get the document number of the document containing this node. | | public DocumentInfo | getDocumentRoot()
Get the root node, if it is a document node. | | public int | getFingerprint()
Get fingerprint. | | public int | getLineNumber()
| | public String | getLocalPart()
Get the local part of the name of this node. | | public int | getNameCode()
Get name code. | | public NamePool | getNamePool()
| | public int | getNodeKind()
Return the type of node. | | public NodeInfo | getParent()
| | public String | getPrefix()
Get the prefix of the name of the node. | | public NodeInfo | getRoot()
| | public int | getSiblingPosition()
| | public String | getStringValue()
Return the string value of the node. | | public CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. | | public String | getSystemId()
Get the System ID for the node.
the System Identifier of the entity in the source documentcontaining the node, or null if not known. | | public int | getTypeAnnotation()
Get the type annotation of this node, if any. | | public SequenceIterator | getTypedValue()
| | public String | getURI()
Get the URI part of the name of this node. | | public Object | getUnderlyingNode()
| | public boolean | hasChildNodes()
Determine whether the node has any children. | | public boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node. | | public AxisIterator | iterateAxis(byte axisNumber)
| | public AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
| | final protected NodeWrapper | makeWrapper(Node node, DocumentWrapper docWrapper)
Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface. | | final protected NodeWrapper | makeWrapper(Node node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface. | | public void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. | | public void | setSystemId(String uri)
|
| index | | protected int index(Code) | | |
| nodeKind | | protected short nodeKind(Code) | | |
| NodeWrapper | | protected NodeWrapper(Node node, NodeWrapper parent, int index)(Code) | | This constructor is protected: nodes should be created using the wrap
factory method on the DocumentWrapper class
Parameters:
node - The XOM node to be wrapped
Parameters:
parent - The NodeWrapper that wraps the parent of this node
Parameters:
index - Position of this node among its siblings |
| atomize | | public Value atomize()(Code) | | Get the typed value. The result of this method will always be consistent
with the method
net.sf.saxon.om.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.
the typed value. If requireSingleton is set to true, the resultwill always be an AtomicValue. In other cases it may be a Valuerepresenting a sequence whose items are atomic values.
since:
8.5 |
| compareOrder | | public int compareOrder(NodeInfo other)(Code) | | 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 thisnode -1 if this node precedes the other node, +1 if it follows theother node, or 0 if they are the same node. (In this case,isSameNode() will always return true, and the two nodes willproduce the same result for generateId()) |
| copy | | public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException(Code) | | Copy this node to a given outputter (deep copy)
|
| generateId | | public String generateId()(Code) | | Get a character string that uniquely identifies this node. Note:
a.isSameNode(b) if and only if generateId(a)==generateId(b)
a string that uniquely identifies this node, across all documents |
| getAttributeValue | | public String getAttributeValue(int fingerprint)(Code) | | Get the value of a given attribute of this node
Parameters:
fingerprint - The fingerprint of the attribute name the attribute value if it exists or null if not |
| getBaseURI | | public String getBaseURI()(Code) | | Get the Base URI for the node, that is, the URI used for resolving a
relative URI contained in the node.
|
| getDeclaredNamespaces | | public int[] getDeclaredNamespaces(int[] buffer)(Code) | | 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 resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. An array of integers representing the namespace declarations and undeclarations present onthis element. For a node other than an element, return null. Otherwise, the returned array is asequence of namespace codes, whose meaning may be interpreted by reference to the name pool. Thetop 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()(Code) | | Get the display name of this node. For elements and attributes this is
[prefix:]localname. For unnamed nodes, it is an empty string.
The display name of this node. For a node with no name, return anempty string. |
| getDocumentNumber | | public int getDocumentNumber()(Code) | | Get the document number of the document containing this node. For a
free-standing orphan node, just return the hashcode.
|
| getDocumentRoot | | public DocumentInfo getDocumentRoot()(Code) | | Get the root node, if it is a document node.
the DocumentInfo representing the containing document. |
| getFingerprint | | public int getFingerprint()(Code) | | 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()(Code) | | Get line number
the line number of the node in its original source document; or-1 if not available |
| getLocalPart | | public String getLocalPart()(Code) | | Get the local part of the name of this node. This is the name after the
":" if any.
the local part of the name. For an unnamed node, returns "". |
| getNameCode | | public int getNameCode()(Code) | | 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: net.sf.saxon.om.NamePool.allocate
See Also: allocate |
| getNamePool | | public NamePool getNamePool()(Code) | | Get the name pool for this node
the NamePool |
| getNodeKind | | public int getNodeKind()(Code) | | Return the type of node.
one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc. |
| getParent | | public NodeInfo getParent()(Code) | | Get the NodeInfo object representing the parent of this node
|
| getPrefix | | public String getPrefix()(Code) | | Get the prefix of the name of the node. This is defined only for elements and attributes.
If the node has no prefix, or for other kinds of node, return a zero-length string.
The prefix of the name of the node. |
| getRoot | | public NodeInfo getRoot()(Code) | | Get the root node of the tree containing this node
the NodeInfo representing the top-level ancestor of this node.This will not necessarily be a document node |
| getSiblingPosition | | public int getSiblingPosition()(Code) | | Get the index position of this node among its siblings (starting from 0)
|
| getStringValue | | public String getStringValue()(Code) | | 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.
the string value of the node |
| getStringValueCS | | public CharSequence getStringValueCS()(Code) | | Get the value of the item as a CharSequence. This is in some cases more efficient than
the version of the method that returns a String.
|
| getSystemId | | public String getSystemId()(Code) | | Get the System ID for the node.
the System Identifier of the entity in the source documentcontaining the node, or null if not known. Note this is not thesame as the base URI: the base URI can be modified by xml:base,but the system ID cannot. |
| getTypeAnnotation | | public int getTypeAnnotation()(Code) | | Get the type annotation of this node, if any. Returns -1 for kinds of
nodes that have no annotation, and for elements annotated as untyped, and
attributes annotated as untypedAtomic.
-1 (there is no type annotation) the type annotation of the node.
See Also: net.sf.saxon.type.Type |
| getURI | | public String getURI()(Code) | | 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.
The URI of the namespace of this node. For an unnamed node, orfor a node with an empty prefix, return an empty string. |
| getUnderlyingNode | | public Object getUnderlyingNode()(Code) | | Get the underlying XOM node, to implement the VirtualNode interface
|
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
|
| isSameNodeInfo | | public boolean isSameNodeInfo(NodeInfo other)(Code) | | Determine whether this is the same node as another node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
true if this Node object and the supplied Node object representthe same node in the tree. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber)(Code) | | Return an iteration over the nodes reached by the given axis from this
node
Parameters:
axisNumber - the axis to be used a SequenceIterator that scans the nodes reached by the axis inturn. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)(Code) | | Return an iteration over the nodes reached by the given axis from this
node
Parameters:
axisNumber - the axis to be used
Parameters:
nodeTest - A pattern to be matched by the returned nodes a SequenceIterator that scans the nodes reached by the axis inturn. |
| makeWrapper | | final protected NodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper)(Code) | | Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface.
Parameters:
node - The XOM node
Parameters:
docWrapper - The wrapper for the Document containing this node The new wrapper for the supplied node |
| makeWrapper | | final protected NodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper, NodeWrapper parent, int index)(Code) | | Factory method to wrap a XOM node with a wrapper that implements the
Saxon NodeInfo interface.
Parameters:
node - The XOM node
Parameters:
docWrapper - The wrapper for the Document containing this node
Parameters:
parent - The wrapper for the parent of the XOM node
Parameters:
index - The position of this node relative to its siblings The new wrapper for the supplied node |
| sendNamespaceDeclarations | | public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors) throws XPathException(Code) | | Output all namespace nodes associated with this element. Does nothing if
the node is not an element.
Parameters:
out - The relevant outputter
Parameters:
includeAncestors - True if namespaces declared on ancestor elements must be |
|
|