net.sf.saxon.om
public class VirtualCopy extends Object implements NodeInfo, SourceLocator
Nested Class Summary | |
---|---|
protected class | VirtualCopy.VirtualCopier
VirtualCopier implements the XPath axes as applied to a VirtualCopy node. |
Field Summary | |
---|---|
protected long | documentNumber |
protected NodeInfo | original |
protected VirtualCopy | parent |
protected NodeInfo | root |
protected String | systemId |
Constructor Summary | |
---|---|
protected | VirtualCopy(NodeInfo base)
Protected constructor: create a virtual copy of a node |
Method Summary | |
---|---|
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
|
boolean | equals(Object other)
The equals() method compares nodes for identity. |
void | generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
String | getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
|
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 |
int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
String | getDisplayName()
Get the display name of this node. |
long | getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo | getDocumentRoot()
Get the root node, if it is a document node.
|
int | getFingerprint()
Get fingerprint. |
int | getLineNumber()
Get line number
|
String | getLocalPart()
Get the local part of the name of this node. |
int | getNameCode()
Get name code. |
NamePool | getNamePool()
Get the NamePool that holds the namecode for this node
|
int | getNodeKind()
Get the kind of node. |
NodeInfo | getParent()
Get the NodeInfo object representing the parent of this node
|
String | getPrefix()
Get the prefix of the name of the node. |
String | getPublicId()
Return the public identifier for the current document event.
|
NodeInfo | getRoot()
Get the root node of the tree containing this node
|
String | getStringValue()
Return the string value of the node. |
CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. |
String | getSystemId()
Get the System ID for the node.
|
int | getTypeAnnotation()
Get the type annotation of this node, if any.
|
SequenceIterator | getTypedValue()
Get the typed value of the item
|
String | getURI()
Get the URI part of the name of this node. |
boolean | hasChildNodes()
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 property
|
boolean | isIdref()
Determine whether this node has the is-idref property
|
boolean | isNilled()
Determine whether the node has the is-nilled property
|
boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
AxisIterator | iterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node
|
AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over all the nodes reached by the given axis from this node
that match a given NodeTest
|
protected VirtualCopy.VirtualCopier | makeCopier(AxisIterator axis, VirtualCopy newParent, NodeInfo root)
Create an iterator that makes and returns virtual copies of nodes on the original tree |
static VirtualCopy | makeVirtualCopy(NodeInfo original, NodeInfo root)
Public factory method: create a virtual copy of a node |
void | setDocumentNumber(long documentNumber)
Set the unique document number of the virtual document. |
void | setSystemId(String systemId)
Set the system identifier for this Source.
|
protected VirtualCopy | wrap(NodeInfo node)
Wrap a node in a VirtualCopy.
|
Parameters: base the node to be copied
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.
Since: 8.5
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())
Parameters: out the Receiver to which the node should be copied whichNamespaces in the case of an element, controls which namespace nodes should be copied. Values are NO_NAMESPACES, LOCAL_NAMESPACES, ALL_NAMESPACES copyAnnotations indicates whether the type annotations of element and attribute nodes should be copied locationId Identifies the location of the instruction that requested this copy. Pass zero if no other information is available
Throws: net.sf.saxon.trans.XPathException
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.
Parameters: buffer a buffer, to which will be appended a string that uniquely identifies this node, across all documents.
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists or null if not
Returns: the base URI of the node
Returns: the column number of the node in its original source document; or -1 if not available
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.
Returns: The display name of this node. For a node with no name, return an empty string.
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.
Returns: an integer fingerprint; two nodes with the same fingerprint have the same expanded QName
Returns: the line number of the node in its original source document; or -1 if not available
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.
Returns: an integer name code, which may be used to obtain the actual node name from the name pool
See Also: allocate
getFingerprint
Returns: the namepool
Returns: an integer identifying the kind of node. These integer values are the same as those used in the DOM
See Also: Type
Returns: the parent of this node; null if this node has no parent
Returns: The prefix of the name of the node.
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.
Returns: A string containing the public identifier, or null if none is available.
See Also: VirtualCopy
Returns: the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
Returns: the string value of the node
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.
Returns: the type annotation of the node.
See Also: Type
Returns: the typed value of the item. In general this will be a sequence
Throws: net.sf.saxon.trans.XPathException where no typed value is available, e.g. for an element with complex content
Returns: The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.
Returns: True if the node has one or more children
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.
Returns: true if the node is an ID
Returns: true if the node is an IDREF or IDREFS element or attribute
Returns: true if the node has the is-nilled property
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.
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: Axis
Parameters: axisNumber an integer identifying the axis; one of the constants defined in class net.sf.saxon.om.Axis nodeTest 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: UnsupportedOperationException if the namespace axis is requested and this axis is not supported for this implementation.
See Also: Axis
Parameters: axis the axis to be navigated newParent the parent of the nodes in the new virtual tree (may be null) root the root of the virtual tree
Returns: the iterator that does the copying
Parameters: original the node to be copied root the root of the tree containing 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.
Parameters: documentNumber the document number to be allocated. This can be obtained from the DocumentNumberAllocator which is accessible from the Configuration using getDocumentNumberAllocator
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.
Parameters: systemId The system identifier as a URL string.
Parameters: node the node to be wrapped