AbstractVirtualNode

java.lang.Object
- net.sf.saxon.tree.wrapper.AbstractVirtualNode

All Implemented Interfaces:

Source, PullEvent, Item, NodeInfo, Sequence, VirtualNode

Direct Known Subclasses:

SpaceStrippedNode, TypeStrippedNode
```
public abstract class AbstractVirtualNode
extends Object
implements VirtualNode
```
AbstractVirtualNode is an abstract superclass for VirtualNode implementations in which the underlying node is itself a Saxon NodeInfo.

Field Summary

Fields
Modifier and Type Field and Description

protected AbstractVirtualNode docWrapper

protected NodeInfo node

protected AbstractVirtualNode parent
- Fields inherited from interface net.sf.saxon.om.NodeInfo
  ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Fields
Modifier and Type	Field and Description
`protected AbstractVirtualNode`	`docWrapper`
`protected NodeInfo`	`node`
`protected AbstractVirtualNode`	`parent`

Constructor Summary

Constructors
Constructor and Description

AbstractVirtualNode()

Constructors
Constructor and Description
`AbstractVirtualNode()`

Method Summary

Methods
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.
`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 (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 name pool for this node
`int`	`getNodeKind()` Return the type of node.
`String`	`getPrefix()` Get the prefix of the name of the node.
`Object`	`getRealNode()` Get the node underlying this virtual node.
`NodeInfo`	`getRoot()` Get the root node - always a document node with this tree implementation
`SchemaType`	`getSchemaType()` Get the type annotation
`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
`NodeInfo`	`getUnderlyingNode()` Get the underlying node, to implement the VirtualNode interface
`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()
`NodeInfo`	`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, NodeTest nodeTest)` Return an iteration over the nodes reached by the given axis from this node
`void`	`setSystemId(String uri)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.NodeInfo
copy, getParent, iterateAxis

- Field Detail
  - node
```
protected NodeInfo node
```
  - parent
```
protected AbstractVirtualNode parent
```
  - docWrapper
```
protected AbstractVirtualNode docWrapper
```
- Constructor Detail
  - AbstractVirtualNode
```
public AbstractVirtualNode()
```
- Method Detail
  - head
```
public NodeInfo head()
```
    To implement Sequence, this method returns the item itself
    
    Specified by:
    
    head in interface Item
    
    Specified by:
    
    head in interface Sequence
    
    Returns:
    this item
  - iterate
```
public SequenceIterator iterate()
```
    To implement Sequence, this method returns a singleton iterator that delivers this item in the form of a sequence
    
    Specified by:
    
    iterate in interface Sequence
    
    Returns:
    a singleton iterator that returns this item
  - getUnderlyingNode
```
public NodeInfo getUnderlyingNode()
```
    Get the underlying node, to implement the VirtualNode interface
    
    Specified by:
    
    getUnderlyingNode in interface VirtualNode
    
    Returns:
    The underlying node.
  - getRealNode
```
public Object getRealNode()
```
    Get the node underlying this virtual node. If this is a VirtualNode the method will automatically drill down through several layers of wrapping.
    
    Specified by:
    
    getRealNode in interface VirtualNode
    
    Returns:
    The underlying node.
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the configuration
    
    Specified by:
    
    getConfiguration in interface NodeInfo
    
    Returns:
    the Configuration
  - getNamePool
```
public NamePool getNamePool()
```
    Get the name pool for this node
    
    Specified by:
    
    getNamePool in interface NodeInfo
    
    Returns:
    the NamePool
  - getNodeKind
```
public int getNodeKind()
```
    Return the type of node.
    
    Specified by:
    
    getNodeKind in interface NodeInfo
    
    Returns:
    one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
    See Also:
    Type
  - atomize
```
public AtomicSequence atomize()
                       throws XPathException
```
    Get the typed value.
    
    Specified by:
    
    atomize in interface NodeInfo
    
    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
  - getTypeAnnotation
```
public int getTypeAnnotation()
```
    Get the type annotation
    
    Specified by:
    
    getTypeAnnotation in interface NodeInfo
    
    Returns:
    the type annotation of the base node
  - getSchemaType
```
public SchemaType getSchemaType()
```
    Get the type annotation
    
    Specified by:
    
    getSchemaType in interface NodeInfo
    
    Returns:
    the type annotation of the base node
  - isSameNodeInfo
```
public boolean isSameNodeInfo(NodeInfo other)
```
    Determine whether this is the same node as another node.
    Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
    
    Specified by:
    
    isSameNodeInfo in interface NodeInfo
    
    Parameters:
    other - the node to be compared with this node
    
    Returns:
    true if this Node object and the supplied Node object represent the same node in the tree.
  - equals
```
public boolean equals(Object other)
```
    The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().
    
    Specified by:
    
    equals in interface NodeInfo
    
    Overrides:
    
    equals in class Object
    
    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.
  - 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()
    
    Specified by:
    
    hashCode in interface NodeInfo
    
    Overrides:
    
    hashCode in class Object
    
    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.
  - getSystemId
```
public String getSystemId()
```
    Get the System ID for the node.
    
    Specified by:
    
    getSystemId in interface Source
    
    Specified by:
    
    getSystemId in interface NodeInfo
    
    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.
  - setSystemId
```
public void setSystemId(String uri)
```
    Specified by:
    
    setSystemId in interface Source
  - getBaseURI
```
public String getBaseURI()
```
    Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. In the JDOM model, base URIs are held only an the document level. We don't currently take any account of xml:base attributes.
    
    Specified by:
    
    getBaseURI in interface NodeInfo
    
    Returns:
    the base URI of the node. This may be null if the base URI is unknown, including the case where the node has no parent.
  - getLineNumber
```
public int getLineNumber()
```
    Get line number
    
    Specified by:
    
    getLineNumber in interface NodeInfo
    
    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:
    
    getColumnNumber in interface NodeInfo
    
    Returns:
    the column number of the node in its original source document; or -1 if not available
  - 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:
    
    compareOrder in interface NodeInfo
    
    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())
  - comparePosition
```
public 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.
    The other node must always be in the same tree; the effect of calling this method when the two nodes are in different trees is undefined. If either node is a namespace or attribute node, the method should throw UnsupportedOperationException.
    
    Specified by:
    
    comparePosition in interface NodeInfo
    
    Parameters:
    other - The other node, whose position is to be compared with this node
    
    Returns:
    AxisInfo.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.
    
    Throws:
    
    UnsupportedOperationException - if either node is an attribute or namespace
    Since:
    
    9.5
  - getStringValue
```
public final 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:
    
    getStringValue in interface Item
    
    Specified by:
    
    getStringValue in interface NodeInfo
    
    Returns:
    the string value of the node
    See Also:
    Item.getStringValueCS()
  - getStringValueCS
```
public 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:
    
    getStringValueCS in interface Item
    
    Returns:
    the string value of the item
    See Also:
    Item.getStringValue()
  - getNameCode
```
public int getNameCode()
```
    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.
    
    Specified by:
    
    getNameCode in interface NodeInfo
    
    Returns:
    an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
    See Also:
    allocate
  - 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. A fingerprint of -1 should be returned for a node with no name.
    
    Specified by:
    
    getFingerprint in interface NodeInfo
    
    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.
  - getLocalPart
```
public String getLocalPart()
```
    Get the local part of the name of this node. This is the name after the ":" if any.
    
    Specified by:
    
    getLocalPart in interface NodeInfo
    
    Returns:
    the local part of the name. For an unnamed node, returns null, except for un unnamed namespace node, which returns "".
  - getURI
```
public 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.
    
    Specified by:
    
    getURI in interface NodeInfo
    
    Returns:
    The URI of the namespace of this node. For an unnamed node, return null. For a node with an empty prefix, return an empty string.
  - getPrefix
```
public 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.
    
    Specified by:
    
    getPrefix in interface NodeInfo
    
    Returns:
    The prefix of the name of the node.
  - getDisplayName
```
public 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:
    
    getDisplayName in interface NodeInfo
    
    Returns:
    The display name of this node. For a node with no name, return an empty string.
  - iterateAxis
```
public AxisIterator iterateAxis(byte axisNumber,
                       NodeTest nodeTest)
```
    Return an iteration over the nodes reached by the given axis from this node
    
    Specified by:
    
    iterateAxis in interface NodeInfo
    
    Parameters:
    axisNumber - the axis to be used
    nodeTest - A pattern to be matched by the returned nodes
    
    Returns:
    a SequenceIterator that scans the nodes reached by the axis in turn.
    See Also:
    AxisInfo
  - getAttributeValue
```
public String getAttributeValue(String uri,
                       String local)
```
    Get the string value of a given attribute of this node
    
    Specified by:
    
    getAttributeValue in interface NodeInfo
    
    Parameters:
    uri - the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespace
    local - 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.
    Since:
    
    9.4
  - getRoot
```
public NodeInfo getRoot()
```
    Get the root node - always a document node with this tree implementation
    
    Specified by:
    
    getRoot in interface NodeInfo
    
    Returns:
    the NodeInfo representing the containing document
  - getDocumentRoot
```
public DocumentInfo getDocumentRoot()
```
    Get the root (document) node
    
    Specified by:
    
    getDocumentRoot in interface NodeInfo
    
    Returns:
    the DocumentInfo representing the containing document
  - 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:
    
    hasChildNodes in interface NodeInfo
    
    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:
    
    generateId in interface NodeInfo
    
    Parameters:
    buffer - a buffer, into which will be placed a string that uniquely identifies this node, within this document. The calling code prepends information to make the result unique across all documents.
  - getDocumentNumber
```
public long getDocumentNumber()
```
    Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.
    
    Specified by:
    
    getDocumentNumber in interface NodeInfo
    
    Returns:
    the document number of the document containing this node
  - getDeclaredNamespaces
```
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
```
    Get all namespace undeclarations and undeclarations defined on this element.
    
    Specified by:
    
    getDeclaredNamespaces in interface NodeInfo
    
    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.
  - isId
```
public boolean isId()
```
    Determine whether this node has the is-id property
    
    Specified by:
    
    isId in interface NodeInfo
    
    Returns:
    true if the node is an ID
  - isIdref
```
public boolean isIdref()
```
    Determine whether this node has the is-idref property
    
    Specified by:
    
    isIdref in interface NodeInfo
    
    Returns:
    true if the node is an IDREF or IDREFS element or attribute
  - isNilled
```
public boolean isNilled()
```
    Determine whether the node has the is-nilled property
    
    Specified by:
    
    isNilled in interface NodeInfo
    
    Returns:
    true if the node has the is-nilled property

Class AbstractVirtualNode

Field Summary

Fields inherited from interface net.sf.saxon.om.NodeInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.saxon.om.NodeInfo

Field Detail

node

parent

docWrapper

Constructor Detail

AbstractVirtualNode

Method Detail

head

iterate

getUnderlyingNode

getRealNode

getConfiguration

getNamePool

getNodeKind

atomize

getTypeAnnotation

getSchemaType

isSameNodeInfo

equals

hashCode

getSystemId

setSystemId

getBaseURI

getLineNumber

getColumnNumber

compareOrder

comparePosition

getStringValue

getStringValueCS

getNameCode

getFingerprint

getLocalPart

getURI

getPrefix

getDisplayName

iterateAxis

getAttributeValue

getRoot

getDocumentRoot

hasChildNodes

generateId

getDocumentNumber

getDeclaredNamespaces

isId

isIdref

isNilled