public class VirtualCopy extends Object implements NodeInfo, SourceLocator
| Modifier and Type | Class and Description |
|---|---|
protected class |
VirtualCopy.VirtualCopier
VirtualCopier implements the XPath axes as applied to a VirtualCopy node.
|
| Modifier and Type | Field and Description |
|---|---|
protected long |
documentNumber |
protected NodeInfo |
original |
protected VirtualCopy |
parent |
protected NodeInfo |
root |
protected String |
systemId |
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES| Modifier | Constructor and Description |
|---|---|
protected |
VirtualCopy(NodeInfo base)
Protected constructor: create a virtual copy of a node
|
| Modifier and Type | Method and Description |
|---|---|
AtomicSequence |
atomize()
Get the typed value.
|
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
int |
comparePosition(NodeInfo other)
Determine the relative position of this node and another node, in document order,
distinguishing whether the first node is a preceding, following, descendant, ancestor,
or the same node as the second.
|
void |
copy(Receiver out,
int copyOptions,
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(String uri,
String local)
Get the string 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
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] 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
|
SchemaType |
getSchemaType()
Get the type annotation of this node, if any.
|
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.
|
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()
|
Item |
head()
To implement
Sequence, this method returns the item itself |
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.
|
SequenceIterator |
iterate()
To implement
Sequence, this method returns a singleton iterator
that delivers this item in the form of a sequence |
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.
|
protected String systemId
protected long documentNumber
protected NodeInfo original
protected VirtualCopy parent
protected NodeInfo root
protected VirtualCopy(NodeInfo base)
base - the node to be copiedpublic static VirtualCopy makeVirtualCopy(NodeInfo original, NodeInfo root)
original - the node to be copiedroot - the root of the tree containing the node to be copiedprotected VirtualCopy wrap(NodeInfo node)
node - the node to be wrappedpublic SequenceIterator iterate()
Sequence, this method returns a singleton iterator
that delivers this item in the form of a sequencepublic void setDocumentNumber(long documentNumber)
documentNumber - the document number to be allocated. This can be obtained from the
DocumentNumberAllocator which is accessible from the Configuration using
Configuration.getDocumentNumberAllocator()public int getNodeKind()
getNodeKind in interface NodeInfoTypepublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoother - the node to be compared with this nodepublic boolean equals(Object other)
equals in interface NodeInfoequals in class Objectother - the node to be compared with this nodepublic int hashCode()
hashCode in interface NodeInfohashCode in class Objectpublic String getSystemId()
getSystemId in interface SourcegetSystemId in interface SourceLocatorgetSystemId in interface NodeInfopublic String getBaseURI()
getBaseURI in interface NodeInfopublic int getLineNumber()
getLineNumber in interface SourceLocatorgetLineNumber in interface NodeInfopublic int getColumnNumber()
getColumnNumber in interface SourceLocatorgetColumnNumber in interface NodeInfopublic int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this
nodepublic int comparePosition(NodeInfo other)
comparePosition in interface NodeInfoother - The other node, whose position is to be compared with this
nodeAxisInfo.PRECEDING if this node is on the preceding axis of the other node;
AxisInfo.FOLLOWING if it is on the following axis; AxisInfo.ANCESTOR if the first node is an
ancestor of the second; AxisInfo.DESCENDANT if the first is a descendant of the second;
AxisInfo.SELF if they are the same node.UnsupportedOperationException - if either node is an attribute or namespacepublic String getStringValue()
getStringValue in interface ItemgetStringValue in interface NodeInfoItem.getStringValueCS()public CharSequence getStringValueCS()
getStringValueCS in interface ItemItem.getStringValue()public int getNameCode()
getNameCode in interface NodeInfoallocate,
getFingerprintpublic int getFingerprint()
getFingerprint in interface NodeInfopublic String getLocalPart()
getLocalPart in interface NodeInfopublic String getURI()
public String getPrefix()
public String getDisplayName()
getDisplayName in interface NodeInfopublic Configuration getConfiguration()
getConfiguration in interface NodeInfopublic NamePool getNamePool()
getNamePool in interface NodeInfopublic int getTypeAnnotation()
getTypeAnnotation in interface NodeInfoTypepublic SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType in interface NodeInfopublic NodeInfo getParent()
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis in interface NodeInfoaxisNumber - an integer identifying the axis; one of the constants
defined in class net.sf.saxon.om.AxisUnsupportedOperationException - if the namespace axis is
requested and this axis is not supported for this implementation.AxisInfopublic AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis in interface NodeInfoaxisNumber - 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 resultUnsupportedOperationException - if the namespace axis is
requested and this axis is not supported for this implementation.AxisInfopublic String getAttributeValue(String uri, String local)
getAttributeValue in interface NodeInfouri - 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.public NodeInfo getRoot()
public DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfopublic boolean hasChildNodes()
hasChildNodes in interface NodeInfopublic void generateId(FastStringBuffer buffer)
generateId in interface NodeInfobuffer - a buffer, to which will be appended
a string that uniquely identifies this node, across all
documents.public long getDocumentNumber()
getDocumentNumber in interface NodeInfopublic void copy(Receiver out, int copyOptions, int locationId) throws XPathException
copy in interface NodeInfoout - the Receiver to which the node should be copiedcopyOptions - a selection of the options defined in CopyOptionslocationId - Identifies the location of the instructionXPathException - if any downstream error occurspublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces in interface NodeInfobuffer - 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.For a node other than an element, the method returns null.
public void setSystemId(String systemId)
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.
setSystemId in interface SourcesystemId - The system identifier as a URL string.public AtomicSequence atomize() throws XPathException
atomize in interface NodeInfoXPathException - if the node has no typed value, for example if
it is an element node with element-only contentpublic boolean isId()
public boolean isIdref()
public boolean isNilled()
public String getPublicId()
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.
getPublicId in interface SourceLocatorgetSystemId()protected VirtualCopy.VirtualCopier makeCopier(AxisIterator axis, VirtualCopy newParent, NodeInfo root)
axis - the axis to be navigatednewParent - the parent of the nodes in the new virtual tree (may be null)root - the root of the virtual treeCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.