Package net.sf.saxon.option.xom
Class NodeWrapper
java.lang.Object
net.sf.saxon.option.xom.NodeWrapper
- All Implemented Interfaces:
Source
,PullEvent
,Item<NodeInfo>
,NodeInfo
,ValueRepresentation<NodeInfo>
,SiblingCountingNode
,VirtualNode
- Direct Known Subclasses:
DocumentWrapper
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, Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DocumentWrapper
protected int
protected nu.xom.Node
protected short
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
NodeWrapper
(nu.xom.Node node, NodeWrapper parent, int index) This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Get the typed value.int
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
Copy this node to a given outputter (deep copy)void
delete()
Delete this node (that is, detach it from its parent)boolean
The equals() method compares nodes for identity.void
generateId
(FastStringBuffer buffer) Get a character string that uniquely identifies this node.getAttributeValue
(int fingerprint) Get the value of a given attribute of this nodegetAttributeValue
(String uri, String local) Get the string value of a given attribute of this nodeGet the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.int
Get column numberGet the configurationgetDeclaredNamespaces
(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.long
Get the document number of the document containing this node.Get the root node, if it is a document node.int
Get fingerprint.int
Get line numberGet the local part of the name of this node.int
Get name code.Get the name pool for this nodeint
Return the type of node.Get the NodeInfo object representing the parent of this nodeGet the prefix of the name of the node.Get the node underlying this virtual node.getRoot()
Get the root node of the tree containing this nodeGet the type annotation of this node, if any.int
Get the index position of this node among its siblings (starting from 0)Return the string value of the node.Get the value of the item as a CharSequence.Get the System ID for the node.int
Get the type annotationGet the typed value of the itemGet the underlying XOM node, to implement the VirtualNode interfacegetURI()
Get the URI part of the name of this node.boolean
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 propertyboolean
isIdref()
Determine whether this node has the is-idref propertyboolean
isNilled()
Determine whether the node has the is-nilled propertyboolean
isSameNodeInfo
(NodeInfo other) Determine whether this is the same node as another node.iterateAxis
(byte axisNumber) Return an iteration over the nodes reached by the given axis from this nodeiterateAxis
(byte axisNumber, NodeTest nodeTest) Return an iteration over the nodes reached by the given axis from this nodeprotected final NodeWrapper
makeWrapper
(nu.xom.Node node, DocumentWrapper docWrapper) Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.protected final NodeWrapper
makeWrapper
(nu.xom.Node node, DocumentWrapper docWrapper, NodeWrapper parent, int index) Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.void
setSystemId
(String uri)
-
Field Details
-
node
protected nu.xom.Node node -
nodeKind
protected short nodeKind -
docWrapper
-
index
protected int index
-
-
Constructor Details
-
NodeWrapper
This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class- Parameters:
node
- The XOM node to be wrappedparent
- The NodeWrapper that wraps the parent of this nodeindex
- Position of this node among its siblings
-
-
Method Details
-
makeWrapper
Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.- Parameters:
node
- The XOM nodedocWrapper
- The wrapper for the Document containing this node- Returns:
- The new wrapper for the supplied node
-
makeWrapper
protected final NodeWrapper makeWrapper(nu.xom.Node node, DocumentWrapper docWrapper, NodeWrapper parent, int index) Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.- Parameters:
node
- The XOM nodedocWrapper
- The wrapper for the Document containing this nodeparent
- The wrapper for the parent of the XOM nodeindex
- The position of this node relative to its siblings- Returns:
- The new wrapper for the supplied node
-
getConfiguration
Get the configuration- Specified by:
getConfiguration
in interfaceNodeInfo
- Returns:
- the Configuration
-
getUnderlyingNode
Get the underlying XOM node, to implement the VirtualNode interface- Specified by:
getUnderlyingNode
in interfaceVirtualNode
- Returns:
- The underlying node.
-
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 interfaceVirtualNode
- Returns:
- The underlying node.
-
getNamePool
Get the name pool for this node- Specified by:
getNamePool
in interfaceNodeInfo
- Returns:
- the NamePool
-
getNodeKind
public int getNodeKind()Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
- See Also:
-
getTypedValue
Get the typed value of the item- Specified by:
getTypedValue
in interfaceItem<NodeInfo>
- Returns:
- an iterator over the items in the typed value of the node or atomic value. The items returned by this iterator will always be atomic values.
-
atomize
Get the typed value. The result of this method will always be consistent with the methodItem.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. -
getTypeAnnotation
public int getTypeAnnotation()Get the type annotation- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Returns:
- the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the
bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated
as untypedAtomic for the purposes of obtaining the typed value).
For elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).
-
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 interfaceNodeInfo
- 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
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 interfaceNodeInfo
- 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
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().- Specified by:
equals
in interfaceNodeInfo
- Overrides:
equals
in classObject
- 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 interfaceNodeInfo
- Overrides:
hashCode
in classObject
- 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
Get the System ID for the node.- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- 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
- Specified by:
setSystemId
in interfaceSource
-
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 interfaceNodeInfo
- Returns:
- the base URI of the node. This may be null if the base URI is unknown, including the case where the node has no parent.
-
getLineNumber
public int getLineNumber()Get line number- Specified by:
getLineNumber
in interfaceNodeInfo
- Returns:
- the line number of the node in its original source document; or -1 if not available
-
getColumnNumber
public int getColumnNumber()Get column number- Specified by:
getColumnNumber
in interfaceNodeInfo
- Returns:
- the column number of the node in its original source document; or -1 if not available
-
compareOrder
Determine the relative position of this node and another node, in document order. The other node will always be in the same document.- Specified by:
compareOrder
in interfaceNodeInfo
- 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())
-
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 interfaceItem<NodeInfo>
- Specified by:
getStringValue
in interfaceNodeInfo
- Specified by:
getStringValue
in interfaceValueRepresentation<NodeInfo>
- Returns:
- the string value of the node
- See Also:
-
getStringValueCS
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.- Specified by:
getStringValueCS
in interfaceItem<NodeInfo>
- Specified by:
getStringValueCS
in interfaceValueRepresentation<NodeInfo>
- Returns:
- the string value of the item
- See Also:
-
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 invalid input: '&'0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.- Specified by:
getNameCode
in interfaceNodeInfo
- Returns:
- an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
- See Also:
-
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.- Specified by:
getFingerprint
in interfaceNodeInfo
- Returns:
- an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
-
getLocalPart
Get the local part of the name of this node. This is the name after the ":" if any.- Specified by:
getLocalPart
in interfaceNodeInfo
- Returns:
- the local part of the name. For an unnamed node, returns "".
-
getPrefix
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. -
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. -
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 interfaceNodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getParent
Get the NodeInfo object representing the parent of this node -
getSiblingPosition
public int getSiblingPosition()Get the index position of this node among its siblings (starting from 0)- Specified by:
getSiblingPosition
in interfaceSiblingCountingNode
- Returns:
- 0 for the first child, 1 for the second child, etc.
-
iterateAxis
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be used- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
iterateAxis
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodes- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
getAttributeValue
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
getAttributeValue
Get the string value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespacelocal
- 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
-
getRoot
Get the root node of the tree containing this node -
getDocumentRoot
Get the root node, if it is a document node.- Specified by:
getDocumentRoot
in interfaceNodeInfo
- Returns:
- the DocumentInfo representing the containing document.
-
hasChildNodes
public boolean hasChildNodes()Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()- Specified by:
hasChildNodes
in interfaceNodeInfo
- Returns:
- True if the node has one or more children
-
generateId
Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- a buffer to contain a string that uniquely identifies this node, across all documents
-
getDocumentNumber
public long getDocumentNumber()Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Returns:
- the document number of the document containing this node
-
copy
Copy this node to a given outputter (deep copy)- Specified by:
copy
in interfaceNodeInfo
- 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 inCopyOptions
locationId
- If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information- Throws:
XPathException
- if any downstream error occurs
-
getDeclaredNamespaces
Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- 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.
-
isId
public boolean isId()Determine whether this node has the is-id property -
isIdref
public boolean isIdref()Determine whether this node has the is-idref property -
isNilled
public boolean isNilled()Determine whether the node has the is-nilled property -
delete
Delete this node (that is, detach it from its parent)- Throws:
XPathException
-