UnconstructedParent

java.lang.Object
- com.saxonica.pull.UnconstructedParent

All Implemented Interfaces:

Source, SourceLocator, PullEvent, ContextOriginator, Location, Item, NodeInfo, Sequence, Locator

Direct Known Subclasses:

UnconstructedDocument, UnconstructedElement
```
public abstract class UnconstructedParent
extends Object
implements NodeInfo, ContextOriginator
```
This class represents a virtual element node, the result of an element constructor that (in general) hasn't been fully evaluated. This is similar to a Closure, except that it is a NodeInfo rather than a Value. The object is capable of materializing the element if it is actually needed, but the aim is to avoid materializing the element wherever possible, at any rate not until its parent element is constructed so that this element can be built in-situ rather than being built as a standalone element and then later copied.
This class is not currently used for elements that require schema validation.

Field Summary

Fields
Modifier and Type Field and Description

protected ParentNodeConstructor instruction

protected NodeInfo node

protected XPathContextMajor savedXPathContext
- 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 ParentNodeConstructor`	`instruction`
`protected NodeInfo`	`node`
`protected XPathContextMajor`	`savedXPathContext`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UnconstructedParent(ParentNodeConstructor instruction, XPathContext context)` Create an UnconstructedParent node

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.
`void`	`copy(Receiver out, int copyOptions, Location 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.
`ParentNodeConstructor`	`getInstruction()` Get the instruction responsible for creating this element or document node
`int`	`getLineNumber()` Get line number
`NamePool`	`getNamePool()` Get the NamePool that holds the namecode for this node
`NodeInfo`	`getParent()` Get the NodeInfo object representing the parent of this node
`String`	`getPublicId()` Get the Public ID of the entity containing the node.
`PullProvider`	`getPuller()` Get a PullProvider that delivers the stream of events corresponding to the tree rooted at this virtual node
`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 (that is, the document URI of the containing document node).
`TreeInfo`	`getTreeInfo()` Get information about the tree to which this NodeInfo belongs
`XPathContext`	`getXPathContext()` Get the saved XPath dynamic context
`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)` 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
`Location`	`saveLocation()` Get an immutable copy of this Location object.
`void`	`setSystemId(String systemId)` Set the system identifier for this Source.

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
getDisplayName, getLocalPart, getNodeKind, getPrefix, getURI

- Field Detail
  - instruction
```
protected ParentNodeConstructor instruction
```
  - savedXPathContext
```
protected XPathContextMajor savedXPathContext
```
  - node
```
protected NodeInfo node
```
- Constructor Detail
  - UnconstructedParent
```
protected UnconstructedParent(ParentNodeConstructor instruction,
                   XPathContext context)
```
    Create an UnconstructedParent node
    
    Parameters:
    instruction - the instruction responsible for creating this element or document node
    context - the XPath dynamic context
- Method Detail
  - getTreeInfo
```
public TreeInfo getTreeInfo()
```
    Get information about the tree to which this NodeInfo belongs
    
    Specified by:
    
    getTreeInfo in interface NodeInfo
    
    Returns:
    the TreeInfo
    Since:
    
    9.7
  - 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
  - getXPathContext
```
public XPathContext getXPathContext()
```
    Get the saved XPath dynamic context
    
    Returns:
    the saved context
  - getInstruction
```
public ParentNodeConstructor getInstruction()
```
    Get the instruction responsible for creating this element or document node
    
    Returns:
    the relevant instruction
  - getPuller
```
public PullProvider getPuller()
```
    Get a PullProvider that delivers the stream of events corresponding to the tree rooted at this virtual node
    
    Returns:
    the PullProvider for the events in the virtual tree
  - isSameNodeInfo
```
public boolean isSameNodeInfo(NodeInfo other)
```
    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.
    
    Specified by:
    
    isSameNodeInfo in interface NodeInfo
    
    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.
  - 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 (that is, the document URI of the containing document node).
    
    Specified by:
    
    getSystemId in interface Source
    
    Specified by:
    
    getSystemId in interface SourceLocator
    
    Specified by:
    
    getSystemId in interface Location
    
    Specified by:
    
    getSystemId in interface NodeInfo
    
    Specified by:
    
    getSystemId in interface Locator
    
    Returns:
    the System Identifier of 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.
  - getPublicId
```
public String getPublicId()
```
    Get the Public ID of the entity containing the node.
    
    Specified by:
    
    getPublicId in interface SourceLocator
    
    Specified by:
    
    getPublicId in interface Location
    
    Specified by:
    
    getPublicId in interface NodeInfo
    
    Specified by:
    
    getPublicId in interface Locator
    
    Returns:
    null (always)
    Since:
    
    9.7
  - 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. This will be the same as the System ID unless xml:base has been used.
    
    Specified by:
    
    getBaseURI in interface NodeInfo
    
    Returns:
    the base URI of the node
  - getLineNumber
```
public int getLineNumber()
```
    Get line number
    
    Specified by:
    
    getLineNumber in interface SourceLocator
    
    Specified by:
    
    getLineNumber in interface Location
    
    Specified by:
    
    getLineNumber in interface NodeInfo
    
    Specified by:
    
    getLineNumber in interface Locator
    
    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 SourceLocator
    
    Specified by:
    
    getColumnNumber in interface Location
    
    Specified by:
    
    getColumnNumber in interface NodeInfo
    
    Specified by:
    
    getColumnNumber in interface Locator
    
    Returns:
    the column number of the node in its original source document; or -1 if not available
  - saveLocation
```
public Location saveLocation()
```
    Get an immutable copy of this Location object. By default Location objects may be mutable, so they should not be saved for later use. The result of this operation holds the same location information, but in an immutable form.
    
    Specified by:
    
    saveLocation in interface Location
  - 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 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()
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the configuration
    
    Specified by:
    
    getConfiguration in interface NodeInfo
    
    Returns:
    the Configuration to which the tree belongs
  - getNamePool
```
public NamePool getNamePool()
```
    Get the NamePool that holds the namecode for this node
    
    Returns:
    the namepool
  - getSchemaType
```
public SchemaType getSchemaType()
```
    Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.
    
    Types derived from a DTD are not reflected in the result of this method.
    
    Specified by:
    
    getSchemaType in interface NodeInfo
    
    Returns:
    For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.
    Since:
    
    9.4
  - getParent
```
public NodeInfo getParent()
```
    Get the NodeInfo object representing the parent of this node
    
    Specified by:
    
    getParent in interface NodeInfo
    
    Returns:
    the parent of this node; null if this node has no parent
  - iterateAxis
```
public AxisIterator iterateAxis(byte axisNumber)
```
    Return an iteration over all the nodes reached by the given axis from this node
    
    Specified by:
    
    iterateAxis in interface NodeInfo
    
    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:
    AxisInfo
  - iterateAxis
```
public 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
    
    Specified by:
    
    iterateAxis in interface NodeInfo
    
    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:
    a NodeEnumeration 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:
    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 of the tree containing this node
    
    Specified by:
    
    getRoot in interface NodeInfo
    
    Returns:
    the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
  - 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, across all documents.
  - copy
```
public void copy(Receiver out,
        int copyOptions,
        Location locationId)
          throws XPathException
```
    Copy this node to a given outputter
    
    Specified by:
    
    copy in interface NodeInfo
    
    Parameters:
    out - the Receiver to which the node should be copied
    copyOptions - a selection of the options defined in CopyOptions
    locationId - If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information
    
    Throws:
    
    XPathException - if any downstream error occurs
  - 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.
  - setSystemId
```
public void setSystemId(String systemId)
```
    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.
    
    Specified by:
    
    setSystemId in interface Source
    
    Parameters:
    systemId - The system identifier as a URL string.
  - 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()
  - atomize
```
public AtomicSequence atomize()
                       throws XPathException
```
    Get the typed value.
    
    Specified by:
    
    atomize in interface Item
    
    Specified by:
    
    atomize in interface NodeInfo
    
    Returns:
    the typed value.
    
    Throws:
    
    XPathException - if the node has no typed value, for example if it is an element node with element-only content
    Since:
    
    8.5
  - 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 UnconstructedParent

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

instruction

savedXPathContext

node

Constructor Detail

UnconstructedParent

Method Detail

getTreeInfo

head

iterate

getXPathContext

getInstruction

getPuller

isSameNodeInfo

equals

hashCode

getSystemId

getPublicId

getBaseURI

getLineNumber

getColumnNumber

saveLocation

compareOrder

comparePosition

getStringValue

getConfiguration

getNamePool

getSchemaType

getParent

iterateAxis

iterateAxis

getAttributeValue

getRoot

hasChildNodes

generateId

copy

getDeclaredNamespaces

setSystemId

getStringValueCS

atomize

isId

isIdref

isNilled