public class VirtualCopy extends java.lang.Object implements NodeInfo, javax.xml.transform.SourceLocator
?????? | ???? |
---|---|
protected class |
VirtualCopy.VirtualCopier
VirtualCopier implements the XPath axes as applied to a VirtualCopy node.
|
?????? | ????? |
---|---|
protected int |
documentNumber |
protected NodeInfo |
original |
protected VirtualCopy |
parent |
protected NodeInfo |
root |
protected java.lang.String |
systemId |
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
EMPTY_VALUE_ARRAY
??? | ?????? |
---|---|
protected |
VirtualCopy(NodeInfo base)
Protected constructor: create a virtual copy of a node
|
?????? | ????? |
---|---|
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(java.lang.Object other)
The equals() method compares nodes for identity.
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
java.lang.String |
getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
|
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.
|
int |
getColumnNumber()
Get column number
|
Configuration |
getConfiguration()
Get the configuration
|
int[] |
getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
int |
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
|
java.lang.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
|
java.lang.String |
getPrefix()
Get the prefix of the name of the node.
|
java.lang.String |
getPublicId()
Return the public identifier for the current document event.
|
NodeInfo |
getRoot()
Get the root node of the tree containing this node
|
java.lang.String |
getStringValue()
Return the string value of the node.
|
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
java.lang.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
|
java.lang.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(int documentNumber)
Set the unique document number of the virtual document.
|
void |
setSystemId(java.lang.String systemId)
Set the system identifier for this Source.
|
protected VirtualCopy |
wrap(NodeInfo node)
Wrap a node in a VirtualCopy.
|
protected java.lang.String systemId
protected int 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 void setDocumentNumber(int 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
???? NodeInfo
Type
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
???? NodeInfo
other
- the node to be compared with this nodepublic boolean equals(java.lang.Object other)
equals
???? NodeInfo
equals
??? java.lang.Object
other
- the node to be compared with this nodepublic int hashCode()
public java.lang.String getSystemId()
getSystemId
???? javax.xml.transform.Source
getSystemId
???? javax.xml.transform.SourceLocator
getSystemId
???? NodeInfo
public java.lang.String getBaseURI()
getBaseURI
???? NodeInfo
public int getLineNumber()
getLineNumber
???? javax.xml.transform.SourceLocator
getLineNumber
???? NodeInfo
public int getColumnNumber()
getColumnNumber
???? javax.xml.transform.SourceLocator
getColumnNumber
???? NodeInfo
public int compareOrder(NodeInfo other)
compareOrder
???? NodeInfo
other
- The other node, whose position is to be compared with this
nodepublic java.lang.String getStringValue()
getStringValue
???? Item
getStringValue
???? NodeInfo
getStringValue
???? ValueRepresentation
Item.getStringValueCS()
public java.lang.CharSequence getStringValueCS()
getStringValueCS
???? Item
getStringValueCS
???? ValueRepresentation
Item.getStringValue()
public int getNameCode()
getNameCode
???? NodeInfo
allocate
,
getFingerprint
public int getFingerprint()
getFingerprint
???? NodeInfo
public java.lang.String getLocalPart()
getLocalPart
???? NodeInfo
public java.lang.String getURI()
public java.lang.String getPrefix()
public java.lang.String getDisplayName()
getDisplayName
???? NodeInfo
public Configuration getConfiguration()
getConfiguration
???? NodeInfo
public NamePool getNamePool()
getNamePool
???? NodeInfo
public int getTypeAnnotation()
getTypeAnnotation
???? NodeInfo
Type
public NodeInfo getParent()
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
???? NodeInfo
axisNumber
- an integer identifying the axis; one of the constants
defined in class net.sf.saxon.om.Axisjava.lang.UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
???? NodeInfo
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 resultjava.lang.UnsupportedOperationException
- if the namespace axis is
requested and this axis is not supported for this implementation.Axis
public java.lang.String getAttributeValue(int fingerprint)
getAttributeValue
???? NodeInfo
fingerprint
- The fingerprint of the attribute namepublic NodeInfo getRoot()
public DocumentInfo getDocumentRoot()
getDocumentRoot
???? NodeInfo
public boolean hasChildNodes()
hasChildNodes
???? NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
???? NodeInfo
buffer
- a buffer, to which will be appended
a string that uniquely identifies this node, across all
documents.public int getDocumentNumber()
getDocumentNumber
???? NodeInfo
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
copy
???? NodeInfo
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 availableXPathException
public int[] getDeclaredNamespaces(int[] buffer)
getDeclaredNamespaces
???? NodeInfo
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.For a node other than an element, the method returns null.
public void setSystemId(java.lang.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
???? javax.xml.transform.Source
systemId
- The system identifier as a URL string.public SequenceIterator getTypedValue() throws XPathException
getTypedValue
???? Item
XPathException
- where no typed value is available, e.g. for
an element with complex contentpublic Value atomize() throws XPathException
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.atomize
???? NodeInfo
XPathException
public boolean isId()
public boolean isIdref()
public boolean isNilled()
public java.lang.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
???? javax.xml.transform.SourceLocator
getSystemId()
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 tree