Class VirtualCopy
- java.lang.Object
-
- net.sf.saxon.tree.wrapper.VirtualCopy
-
- All Implemented Interfaces:
javax.xml.transform.Source,javax.xml.transform.SourceLocator,GroundedValue,Item,NodeInfo,Sequence,Location,org.xml.sax.Locator
- Direct Known Subclasses:
SnapshotNode,VirtualUntypedCopy
public class VirtualCopy extends java.lang.Object implements NodeInfo
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. Moreover, this class can create a virtual copy of a subtree, so that the parent of the virtual copy is null rather than being a virtual copy of the parent of the original. This means that none of the axes when applied to the virtual copy is allowed to stray outside the subtree. The virtual copy 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classVirtualCopy.VirtualCopierVirtualCopier implements the XPath axes as applied to a VirtualCopy node.
-
Field Summary
Fields Modifier and Type Field Description protected NodeInfooriginalprotected VirtualCopyparentprotected NodeInforootprotected java.util.function.Supplier<java.lang.String>systemIdSupplierprotected VirtualTreeInfotree-
Fields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedVirtualCopy(NodeInfo base, NodeInfo root)Protected constructor: create a virtual copy of a node
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AtomicSequenceatomize()Get the typed value.intcompareOrder(NodeInfo other)Determine the relative position of this node and another node, in document order.voidcopy(Receiver out, int copyOptions, Location locationId)Copy this node to a given outputterbooleanequals(java.lang.Object other)Determine whether this is the same node as another node.voidgenerateId(FastStringBuffer buffer)Get a character string that uniquely identifies this node.NamespaceMapgetAllNamespaces()Get all the namespace bindings that are in-scope for this element.java.lang.StringgetAttributeValue(java.lang.String uri, java.lang.String local)Get the string value of a given attribute of this nodejava.lang.StringgetBaseURI()Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.intgetColumnNumber()Get column numberConfigurationgetConfiguration()Get the configurationNamespaceBinding[]getDeclaredNamespaces(NamespaceBinding[] buffer)Get all namespace declarations and undeclarations defined on this element.java.lang.StringgetDisplayName()Get the display name of this node.intgetFingerprint()Get fingerprint.intgetLineNumber()Get line numberjava.lang.StringgetLocalPart()Get the local part of the name of this node.intgetNodeKind()Get the kind of node.NodeInfogetOriginalNode()Get the original (wrapped) nodeNodeInfogetParent()Get the NodeInfo object representing the parent of this nodejava.lang.StringgetPrefix()Get the prefix of the name of the node.java.lang.StringgetPublicId()Return the public identifier for the current document event.NodeInfogetRoot()Get the root node of the tree containing this nodeSchemaTypegetSchemaType()Get the type annotation of this node, if any.java.lang.StringgetStringValue()Return the string value of the node.java.lang.CharSequencegetStringValueCS()Get the value of the item as a CharSequence.java.lang.StringgetSystemId()Get the System ID for the node.VirtualTreeInfogetTreeInfo()Get information about the tree to which this NodeInfo belongsjava.lang.StringgetURI()Get the URI part of the name of this node.booleanhasChildNodes()Determine whether the node has any children.booleanhasFingerprint()Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool.inthashCode()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()booleanisId()Determine whether this node has the is-id propertybooleanisIdref()Determine whether this node has the is-idref propertyprotected booleanisIncludedInCopy(NodeInfo sourceNode)Ask whether a node in the source tree is within the scope of this virtual copybooleanisNilled()Determine whether the node has the is-nilled propertyAxisIteratoriterateAxis(int axisNumber, java.util.function.Predicate<? super NodeInfo> nodeTest)Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTestprotected VirtualCopy.VirtualCopiermakeCopier(AxisIterator axis, VirtualCopy newParent, boolean testInclusion)Create an iterator that makes and returns virtual copies of nodes on the original treestatic VirtualCopymakeVirtualCopy(NodeInfo original)Public factory method: create a parentless virtual tree as a copy of an existing nodeLocationsaveLocation()Get an immutable copy of this Location object.voidsetDropNamespaces(boolean drop)Say that namespaces in the virtual tree should not be copied from the underlying tree.voidsetSystemId(java.lang.String systemId)Set the system identifier for this Source.protected VirtualCopywrap(NodeInfo node)Wrap a node within an existing VirtualCopy.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
attributes, children, children, getGenre, isSameNodeInfo, isStreamed, iterateAxis, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Field Detail
-
systemIdSupplier
protected java.util.function.Supplier<java.lang.String> systemIdSupplier
-
original
protected NodeInfo original
-
parent
protected VirtualCopy parent
-
root
protected NodeInfo root
-
tree
protected VirtualTreeInfo tree
-
-
Method Detail
-
makeVirtualCopy
public static VirtualCopy makeVirtualCopy(NodeInfo original)
Public factory method: create a parentless virtual tree as a copy of an existing node- Parameters:
original- the node to be copied- Returns:
- the virtual copy. If the original was already a virtual copy, this will be a virtual copy of the real underlying node.
-
wrap
protected VirtualCopy wrap(NodeInfo node)
Wrap a node within an existing VirtualCopy.- Parameters:
node- the node to be wrapped- Returns:
- a virtual copy of the node
-
getOriginalNode
public NodeInfo getOriginalNode()
Get the original (wrapped) node- Returns:
- the node of which this one is a virtual copy
-
getTreeInfo
public VirtualTreeInfo getTreeInfo()
Get information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfoin interfaceNodeInfo- Returns:
- the TreeInfo
- Since:
- 9.7
-
setDropNamespaces
public void setDropNamespaces(boolean drop)
Say that namespaces in the virtual tree should not be copied from the underlying tree. The semantics follow the rules for xsl:copy-of with copy-namespaces="no": that is, the only namespaces that are retained are those explicitly used in element or attribute nodes.- Parameters:
drop- true if namespaces are to be dropped
-
getAllNamespaces
public NamespaceMap getAllNamespaces()
Description copied from interface:NodeInfoGet all the namespace bindings that are in-scope for this element.For an element return all the prefix-to-uri bindings that are in scope. This may include a binding to the default namespace (represented by a prefix of ""). The map does NOT include the implicit binding of the XML namespace. It will never include "undeclarations" - that is, the namespace URI will never be empty; the effect of an undeclaration is to remove a binding from the in-scope namespaces, not to add anything.
For a node other than an element, returns null.
- Specified by:
getAllNamespacesin interfaceNodeInfo- Returns:
- the in-scope namespaces for an element, or null for any other kind of node.
-
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. The fingerprint contains no information about the namespace prefix. For a name in the null namespace, the fingerprint is the same as the name code.- Specified by:
getFingerprintin 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.
- Throws:
java.lang.UnsupportedOperationException- if this kind of node does not hold namepool fingerprints (specifically, ifhasFingerprint()returns false).- Since:
- 8.4 (moved into FingerprintedNode at some stage; then back into NodeInfo at 9.8).
-
hasFingerprint
public boolean hasFingerprint()
Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool. If the answer is true, then thegetFingerprint()method must return the fingerprint of the node. If the answer is false, then thegetFingerprint()method should throw anUnsupportedOperationException. In the case of unnamed nodes such as text nodes, the result can be either true (in which case getFingerprint() should return -1) or false (in which case getFingerprint may throw an exception).- Specified by:
hasFingerprintin interfaceNodeInfo- Returns:
- true if the implementation of this node provides fingerprints.
- Since:
- 9.8; previously Saxon relied on using
FingerprintedNodeas a marker interface.
-
getNodeKind
public int getNodeKind()
Get the kind of node. This will be a value such as Type.ELEMENT or Type.ATTRIBUTE- Specified by:
getNodeKindin interfaceNodeInfo- Returns:
- an integer identifying the kind of node. These integer values are the same as those used in the DOM
- See Also:
Type
-
equals
public boolean equals(java.lang.Object other)
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.
-
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()
-
getSystemId
public java.lang.String getSystemId()
Get the System ID for the node.- Specified by:
getSystemIdin interfaceLocation- Specified by:
getSystemIdin interfaceorg.xml.sax.Locator- Specified by:
getSystemIdin interfaceNodeInfo- Specified by:
getSystemIdin interfacejavax.xml.transform.Source- Specified by:
getSystemIdin interfacejavax.xml.transform.SourceLocator- 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
public 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. This will be the same as the System ID unless xml:base has been used.- Specified by:
getBaseURIin interfaceNodeInfo- Returns:
- the base URI of the node
-
getLineNumber
public int getLineNumber()
Get line number- Specified by:
getLineNumberin interfaceLocation- Specified by:
getLineNumberin interfaceorg.xml.sax.Locator- Specified by:
getLineNumberin interfaceNodeInfo- Specified by:
getLineNumberin interfacejavax.xml.transform.SourceLocator- 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:
getColumnNumberin interfaceLocation- Specified by:
getColumnNumberin interfaceorg.xml.sax.Locator- Specified by:
getColumnNumberin interfaceNodeInfo- Specified by:
getColumnNumberin interfacejavax.xml.transform.SourceLocator- Returns:
- the column number of the node in its original source document; or -1 if not available
-
saveLocation
public Location saveLocation()
Get an immutable copy of this Location object. By default Location objects may be mutable, so they should not be saved for later use. The result of this operation holds the same location information, but in an immutable form.- Specified by:
saveLocationin interfaceLocation- Returns:
- an immutable copy (which may be the original object, if it is already immutable)
-
compareOrder
public int compareOrder(NodeInfo other)
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:
compareOrderin 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
public java.lang.String 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:
getStringValuein interfaceGroundedValue- Specified by:
getStringValuein interfaceItem- Specified by:
getStringValuein interfaceNodeInfo- Returns:
- the string value of the node
- See Also:
Item.getStringValueCS()
-
getStringValueCS
public java.lang.CharSequence 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:
getStringValueCSin interfaceGroundedValue- Specified by:
getStringValueCSin interfaceItem- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
getLocalPart
public java.lang.String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.- Specified by:
getLocalPartin 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
public java.lang.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.
-
getPrefix
public java.lang.String 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
public java.lang.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:
getDisplayNamein interfaceNodeInfo- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getConfiguration
public Configuration getConfiguration()
Get the configuration- Specified by:
getConfigurationin interfaceNodeInfo- Returns:
- the Configuration to which the tree belongs. The default implementation invokes
getTreeInfo().getConfiguration().
-
getSchemaType
public SchemaType 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:
getSchemaTypein 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
-
getParent
public NodeInfo getParent()
Get the NodeInfo object representing the parent of this node
-
iterateAxis
public AxisIterator iterateAxis(int axisNumber, java.util.function.Predicate<? super NodeInfo> nodeTest)
Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest- Specified by:
iterateAxisin 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:
- an AxisIterator that scans the nodes reached by the axis in turn.
- Throws:
java.lang.UnsupportedOperationException- if the namespace axis is requested and this axis is not supported for this implementation.- See Also:
AxisInfo
-
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)Get the string value of a given attribute of this node- Specified by:
getAttributeValuein 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.
-
getRoot
public NodeInfo getRoot()
Get the root node of the tree containing this node
-
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:
hasChildNodesin interfaceNodeInfo- Returns:
- True if the node has one or more children
-
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)- Specified by:
generateIdin interfaceNodeInfo- Parameters:
buffer- a buffer, to which will be appended a string that uniquely identifies this node, across all documents.
-
copy
public void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
Copy this node to a given outputter- Specified by:
copyin interfaceNodeInfo- Parameters:
out- the Receiver to which the node should be copiedcopyOptions- a selection of the options defined inCopyOptionslocationId- Identifies the location of the instruction- Throws:
XPathException- if any downstream error occurs
-
getDeclaredNamespaces
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace declarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespacesin 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 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 NamespaceBinding objects.
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 null.
For a VirtualCopy, the method needs to return all namespaces that are in scope for this element, because the virtual copy is assumed to contain copies of all the in-scope namespaces of the original.
-
setSystemId
public void setSystemId(java.lang.String systemId)
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:
setSystemIdin interfacejavax.xml.transform.Source- Parameters:
systemId- The system identifier as a URL string.
-
atomize
public AtomicSequence atomize() throws XPathException
Get the typed value.- Specified by:
atomizein interfaceItem- Specified by:
atomizein 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- if the node has no typed value, for example if it is an element node with element-only content- Since:
- 8.5
-
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
-
getPublicId
public java.lang.String getPublicId()
Return the public identifier for the current document event.The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
- Specified by:
getPublicIdin interfaceLocation- Specified by:
getPublicIdin interfaceorg.xml.sax.Locator- Specified by:
getPublicIdin interfaceNodeInfo- Specified by:
getPublicIdin interfacejavax.xml.transform.SourceLocator- Returns:
- A string containing the public identifier, or null if none is available.
- See Also:
getSystemId()
-
isIncludedInCopy
protected boolean isIncludedInCopy(NodeInfo sourceNode)
Ask whether a node in the source tree is within the scope of this virtual copy- Parameters:
sourceNode- the node being tested- Returns:
- true if the node is within the scope of the subtree
-
makeCopier
protected VirtualCopy.VirtualCopier makeCopier(AxisIterator axis, VirtualCopy newParent, boolean testInclusion)
Create an iterator that makes and returns virtual copies of nodes on the original tree- Parameters:
axis- the axis to be navigatednewParent- the parent of the nodes in the new virtual tree (may be null)testInclusion- if true, it is necessary to test whether nodes found in the source tree are included in the copy. If false, this test is unnecessary.- Returns:
- the iterator that does the copying
-
-