Package net.sf.saxon.om
Class VirtualCopy
java.lang.Object
net.sf.saxon.om.VirtualCopy
- All Implemented Interfaces:
Source
,Item
,NodeInfo
,ValueRepresentation
- Direct Known Subclasses:
VirtualDocumentCopy
This class represents a node that is a virtual copy of another node: that is, it behaves as a node that's the
same as another node, but has different identity. It is implemented by means of a reference to the node of which
it is a copy, but methods that are sensitive to node identity return a different result.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected int
protected NodeInfo
protected VirtualCopy
protected NodeInfo
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
Constructors -
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 outputterboolean
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 nodeGet the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.Get the configurationint[]
getDeclaredNamespaces
(int[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.int
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 NamePool that holds the namecode for this nodeint
Get the kind of node.Get the NodeInfo object representing the parent of this nodeGet the prefix of the name of the node.getRoot()
Get the root node of the tree containing this nodeReturn 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 annotation of this node, if any.Get the typed value of the itemgetURI()
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
isSameNodeInfo
(NodeInfo other) Determine whether this is the same node as another node.iterateAxis
(byte axisNumber) Return an iteration over all the nodes reached by the given axis from this nodeiterateAxis
(byte axisNumber, NodeTest nodeTest) Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTeststatic VirtualCopy
makeVirtualCopy
(NodeInfo original, NodeInfo root) void
sendNamespaceDeclarations
(Receiver out, boolean includeAncestors) Output all namespace nodes associated with this element.void
setDocumentNumber
(int documentNumber) void
setSystemId
(String systemId) Set the system identifier for this Source.
-
Field Details
-
baseURI
-
documentNumber
protected int documentNumber -
original
-
parent
-
root
-
-
Constructor Details
-
VirtualCopy
-
-
Method Details
-
makeVirtualCopy
-
setDocumentNumber
public void setDocumentNumber(int documentNumber) -
getNodeKind
public int getNodeKind()Get the kind of node. This will be a value such as Type.ELEMENT or Type.ATTRIBUTE- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- an integer identifying the kind of node. These integer values are the same as those used in the DOM
- See Also:
-
isSameNodeInfo
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.- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- 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.
-
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.
-
getBaseURI
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. This will be the same as the System ID unless xml:base has been used.- Specified by:
getBaseURI
in interfaceNodeInfo
- Returns:
- the base URI of the node
-
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
-
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
- Specified by:
getStringValue
in interfaceNodeInfo
- Specified by:
getStringValue
in interfaceValueRepresentation
- 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
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- 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
- 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
-
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 "". Unlike the DOM interface, this returns the full name in the case of a non-namespaced name.
-
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. -
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. -
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.
-
getConfiguration
Get the configuration- Specified by:
getConfiguration
in interfaceNodeInfo
- Returns:
- the Configuration
-
getNamePool
Get the NamePool that holds the namecode for this node- Specified by:
getNamePool
in interfaceNodeInfo
- Returns:
- the namepool
-
getTypeAnnotation
public int getTypeAnnotation()Get the type annotation of this node, if any.- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Returns:
- the type annotation of the node.
- See Also:
-
getParent
Get the NodeInfo object representing the parent of this node -
iterateAxis
Return an iteration over all the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- an integer identifying the axis; one of the constants defined in class net.sf.saxon.om.Axis- Returns:
- an AxisIterator that scans the nodes reached by the axis in turn.
- Throws:
UnsupportedOperationException
- if the namespace axis is requested and this axis is not supported for this implementation.- See Also:
-
iterateAxis
Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- an integer identifying the axis; one of the constants defined in class net.sf.saxon.om.AxisnodeTest
- A pattern to be matched by the returned nodes; nodes that do not match this pattern are not included in the result- Returns:
- a NodeEnumeration that scans the nodes reached by the axis in turn.
- Throws:
UnsupportedOperationException
- if the namespace axis is requested and this axis is not supported for this implementation.- 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
-
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. If this node is part of a tree that does not have a document node as its root, return null.
-
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 which will be appended a string that uniquely identifies this node, across all documents.
-
getDocumentNumber
public int 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
-
copy
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException Copy this node to a given outputter- Specified by:
copy
in interfaceNodeInfo
- Parameters:
out
- the Receiver to which the node should be copiedwhichNamespaces
- in the case of an element, controls which namespace nodes should be copied. Values are NO_NAMESPACES, LOCAL_NAMESPACES, ALL_NAMESPACEScopyAnnotations
- indicates whether the type annotations of element and attribute nodes should be copiedlocationId
- Identifies the location of the instruction that requested this copy. Pass zero if no other information is available- Throws:
XPathException
-
sendNamespaceDeclarations
Output all namespace nodes associated with this element. Does nothing if the node is not an element.- Specified by:
sendNamespaceDeclarations
in interfaceNodeInfo
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor- Throws:
XPathException
-
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer) 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.
-
setSystemId
Set the system identifier for this Source.The system identifier is optional if the source does not get its data from a URL, but it may still be useful to provide one. The application can use a system identifier, for example, to resolve relative URIs and to include in error messages and warnings.
- Specified by:
setSystemId
in interfaceSource
- Parameters:
systemId
- The system identifier as a URL string.
-
getTypedValue
Get the typed value of the item- Specified by:
getTypedValue
in interfaceItem
- Returns:
- the typed value of the item. In general this will be a sequence
- Throws:
XPathException
- where no typed value is available, e.g. for an element with complex content
-
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.- Specified by:
atomize
in interfaceNodeInfo
- 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.
- Throws:
XPathException
- Since:
- 8.5
-