net.sf.saxon.pull

Class UnconstructedParent

public abstract class UnconstructedParent extends Object implements NodeInfo

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
NodeInfonode
Constructor Summary
UnconstructedParent(ParentNodeConstructor instruction, XPathContext context)
Method Summary
Valueatomize()
Get the typed value.
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
voidconstruct()
Method to construct the node when this is required.
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter
booleanequals(Object other)
The equals() method compares nodes for identity.
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
ConfigurationgetConfiguration()
Get the configuration
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
StringgetDisplayName()
Get the display name of this node.
intgetDocumentNumber()
Get the document number of the document containing this node.
DocumentInfogetDocumentRoot()
Get the root node, if it is a document node.
intgetFingerprint()
Get fingerprint.
ParentNodeConstructorgetInstruction()
intgetLineNumber()
Get line number
StringgetLocalPart()
Get the local part of the name of this node.
NamePoolgetNamePool()
Get the NamePool that holds the namecode for this node
NodeInfogetParent()
Get the NodeInfo object representing the parent of this node
StringgetPrefix()
Get the prefix of the name of the node.
PullProvidergetPuller()
NodeInfogetRoot()
Get the root node of the tree containing this node
StringgetStringValue()
Return the string value of the node.
CharSequencegetStringValueCS()
Get the value of the item as a CharSequence.
StringgetSystemId()
Get the System ID for the node.
intgetTypeAnnotation()
Get the type annotation of this node, if any.
SequenceIteratorgetTypedValue()
Get the typed value of the item
StringgetURI()
Get the URI part of the name of this node.
XPathContextgetXPathContext()
booleanhasChildNodes()
Determine whether the node has any children.
inthashCode()
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()
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
AxisIteratoriterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node
AxisIteratoriterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over all the nodes reached by the given axis from this node that match a given NodeTest
voidsendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace declarations associated with this element.
voidsetSystemId(String systemId)
Set the system identifier for this Source.
voidtryToConstruct()
Method to construct the node when this is required.

Field Detail

node

NodeInfo node

Constructor Detail

UnconstructedParent

public UnconstructedParent(ParentNodeConstructor instruction, XPathContext context)

Method Detail

atomize

public Value atomize()
Get the typed value. The result of this method will always be consistent with the method 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.

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.

Since: 8.5

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.

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())

construct

void construct()
Method to construct the node when this is required.

Throws: XPathException if any failure occurs

copy

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 whichNamespaces in the case of an element, controls which namespace nodes should be copied. Values are UnconstructedParent, UnconstructedParent, UnconstructedParent copyAnnotations indicates whether the type annotations of element and attribute nodes should be copied locationId If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier

Throws: net.sf.saxon.trans.XPathException

equals

public boolean equals(Object other)
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().

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.

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)

Parameters: buffer a buffer, into which will be placed a string that uniquely identifies this node, across all documents.

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

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.

Returns: the base URI of the node

getConfiguration

public Configuration getConfiguration()
Get the configuration

getDeclaredNamespaces

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 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.

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.

Returns: The display name of this node. For a node with no name, return an empty string.

getDocumentNumber

public int getDocumentNumber()
Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root node, if it is a document node.

Returns: the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, return null.

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.

Returns: an integer fingerprint; two nodes with the same fingerprint have the same expanded QName

getInstruction

public ParentNodeConstructor getInstruction()

getLineNumber

public int getLineNumber()
Get line number

Returns: the line number of the node in its original source document; or -1 if not available

getLocalPart

public String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.

Returns: the local part of the name. For an unnamed node, returns "". Unlike the DOM interface, this returns the full name in the case of a non-namespaced name.

getNamePool

public NamePool getNamePool()
Get the NamePool that holds the namecode for this node

Returns: the namepool

getParent

public NodeInfo getParent()
Get the NodeInfo object representing the parent of this node

Returns: the parent of this node; null if this node has no parent

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.

Returns: The prefix of the name of the node.

getPuller

public PullProvider getPuller()

getRoot

public NodeInfo getRoot()
Get the root node of the tree containing this node

Returns: the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node

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.

Returns: the string value of the node

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.

getSystemId

public String getSystemId()
Get the System ID for the node.

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.

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any. Returns -1 for kinds of nodes that have no annotation

Returns: the type annotation of the node.

See Also: Type

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of the item

Returns: the typed value of the item. In general this will be a sequence

Throws: net.sf.saxon.trans.XPathException where no typed value is available, e.g. for an element with complex content

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.

Returns: The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.

getXPathContext

public XPathContext getXPathContext()

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()

Returns: True if the node has one or more children

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()

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.

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.

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.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)
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 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: Axis

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

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: Axis

sendNamespaceDeclarations

public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace declarations associated with this element. Does nothing if the node is not an element.

Parameters: out The relevant Receiver includeAncestors True if namespaces declared on ancestor elements must be output; false if it is known that these are

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.

Parameters: systemId The system identifier as a URL string.

tryToConstruct

void tryToConstruct()
Method to construct the node when this is required.

Note that this may throw an UncheckedXPathException. This is because many of the methods on the NodeInfo class are exception-free; we can't throw an XPathException on these interfaces, but may need to in this case because lazy computation of expressions may throw errors.

Throws: UncheckedXPathException