| java.lang.Object
 net.sf.saxon.om.VirtualCopy
All known Subclasses: net.sf.saxon.om.VirtualDocumentCopy,
| VirtualCopy | | public class VirtualCopy implements NodeInfo(Code) | | 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.
|
| 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.
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. | | public void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter
Parameters:
out - the Receiver to which the node should be copied
Parameters:
whichNamespaces - in the case of an element, controlswhich namespace nodes should be copied. | | public String | generateId()
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 alldocuments. | | 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.
the DocumentInfo representing the containing document. | | 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()
Get the kind of node. | | public NodeInfo | getParent()
| | public String | getPrefix()
Get the prefix of the name of the node. | | public NodeInfo | getRoot()
| | 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()
Get the typed value of the item
the typed value of the item. | | public String | getURI()
Get the URI part of the name of this node. | | 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)
| | public static VirtualCopy | makeVirtualCopy(NodeInfo original, NodeInfo root)
| | public void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. | | public void | setDocumentNumber(int documentNumber)
| | public void | setSystemId(String systemId)
Set the system identifier for this Source. |
| documentNumber | | protected int documentNumber(Code) | | |
| atomize | | public Value atomize() throws XPathException(Code) | | Get the typed value. The result of this method will always be consistent with the method
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 result will always be anAtomicValue. In other cases it may be a Value representing a sequence whose items are atomicvalues.
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
Parameters:
out - the Receiver to which the node should be copied
Parameters:
whichNamespaces - in the case of an element, controlswhich namespace nodes should be copied. Values are NO_NAMESPACES,LOCAL_NAMESPACES, ALL_NAMESPACES
Parameters:
copyAnnotations - indicates whether the type annotationsof element and attribute nodes should be copied
Parameters:
locationId - Identifies the location of the instructionthat requested this copy. Pass zero if no other information is available
throws:
net.sf.saxon.trans.XPathException - |
| 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 alldocuments. (Changed in Saxon 7.5. Previously this method returnedan id that was unique within the current document, and the callingcode prepended a document id). |
| 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. This will be the same as the System ID unless xml:base has been used.
the base URI of 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, returnan empty 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. If thisnode is part of a tree that does not have a document node as itsroot, return null. |
| 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.
an integer fingerprint; two nodes with the same fingerprint havethe same expanded QName |
| 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 "". Unlike the DOMinterface, this returns the full name in the case of a non-namespaced name. |
| 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.
an integer name code, which may be used to obtain the actual nodename from the name pool
See Also: NamePool.allocate
See Also: allocate
See Also: NamePool.getFingerprint
See Also: getFingerprint |
| getNamePool | | public NamePool getNamePool()(Code) | | Get the NamePool that holds the namecode for this node
the namepool |
| getNodeKind | | public int getNodeKind()(Code) | | Get the kind of node. This will be a value such as Type.ELEMENT or Type.ATTRIBUTE
an integer identifying the kind of node. These integer values are thesame as those used in the DOM
See Also: net.sf.saxon.type.Type |
| getParent | | public NodeInfo getParent()(Code) | | Get the NodeInfo object representing the parent of this node
the parent of this node; null if this node has no parent |
| 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 |
| 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, butthe 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.
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,or for a node with an empty prefix, return an emptystring. |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
True if the node has one or more children |
| isSameNodeInfo | | public boolean isSameNodeInfo(NodeInfo other)(Code) | | 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.
Parameters:
other - the node to be compared with this node true if this NodeInfo object and the supplied NodeInfo object representthe same node in the tree. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber)(Code) | | Return an iteration over all the nodes reached by the given axis from this node
Parameters:
axisNumber - an integer identifying the axis; one of the constantsdefined in class net.sf.saxon.om.Axis an AxisIterator that scans the nodes reached by the axis inturn.
throws:
UnsupportedOperationException - if the namespace axis isrequested and this axis is not supported for this implementation.
See Also: Axis |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)(Code) | | Return an iteration over all the nodes reached by the given axis from this node
that match a given NodeTest
Parameters:
axisNumber - an integer identifying the axis; one of the constantsdefined in class net.sf.saxon.om.Axis
Parameters:
nodeTest - A pattern to be matched by the returned nodes; nodesthat do not match this pattern are not included in the result a NodeEnumeration that scans the nodes reached by the axis inturn.
throws:
UnsupportedOperationException - if the namespace axis isrequested and this axis is not supported for this implementation.
See Also: Axis |
| 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 |
| setDocumentNumber | | public void setDocumentNumber(int documentNumber)(Code) | | |
| setSystemId | | public void setSystemId(String systemId)(Code) | | 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.
Parameters:
systemId - The system identifier as a URL string. |
|
|