net.sf.saxon.tree.tiny

Class GraftedElement

java.lang.Object

net.sf.saxon.tree.tiny.TinyNodeImpl

net.sf.saxon.tree.tiny.TinyParentNodeImpl

net.sf.saxon.tree.tiny.TinyElementImpl

net.sf.saxon.tree.tiny.GraftedElement

All Implemented Interfaces:

java.lang.Iterable<NodeInfo>, javax.xml.transform.Source, javax.xml.transform.SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, NodeInfo, Sequence<NodeInfo>, org.xml.sax.Locator

public class GraftedElement
extends TinyElementImpl

This class represents an element node in a TinyTree that is actually a reference to an element node held elsewhere. Some properties of the node come from the containing TinyTree (for example, document number, base URI, etc) while others are actually properties of the external node. Notably, the parent and siblings of the node are found in the containing tree, while the children and descendants (and attributes) are found in the external tree.

Field Summary

Fields inherited from class net.sf.saxon.tree.tiny.TinyNodeImpl

NODE_LETTER, nodeNr, parent, tree

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Constructor and Description
GraftedElement(TinyTree tree, int nodeNr, NodeInfo externalNode, boolean copyNamespaces) Created a grafted element node

Method Summary

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value.
void	copy(Receiver receiver, int copyOptions, Location location) Copy this node to a given receiver
java.lang.String	getAttributeValue(int fp) Get the value of the attribute with a given fingerprint.
java.lang.String	getAttributeValue(java.lang.String uri, java.lang.String local) Get the string value of a given attribute of this node
NamespaceBinding[]	getDeclaredNamespaces(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.
NodeInfo	getExternalNode()
java.lang.String	getStringValue() Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
java.lang.CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
boolean	hasChildNodes() Determine if the node has children.
boolean	hasDefaultNamespace()
AxisIterator	iterateAxis(byte axisNumber) Return an iterator over all the nodes reached by the given axis from this node
AxisIterator	iterateAxis(byte axisNumber, NodeTest nodeTest) Return an iterator over the nodes reached by the given axis from this node

Methods inherited from class net.sf.saxon.tree.tiny.TinyElementImpl

checkNotNamespaceSensitiveElement, getBaseURI, getDeclaredNamespaces, getNodeKind, getSchemaType, getURIForPrefix, hasUniformNamespaces, isId, isIdref

Methods inherited from class net.sf.saxon.tree.tiny.TinyParentNodeImpl

getStringValueCS

Methods inherited from class net.sf.saxon.tree.tiny.TinyNodeImpl

compareOrder, equals, generateId, getColumnNumber, getConfiguration, getDisplayName, getFingerprint, getGenre, getLineNumber, getLocalPart, getNamePool, getNodeNumber, getParent, getPrefix, getRoot, getSequenceNumber, getSystemId, getTree, getTreeInfo, getURI, hasFingerprint, hashCode, head, isAncestorOrSelf, isNilled, isSameNodeInfo, isStreamed, iterate, saveLocation, setParentNode, setSystemId

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

getPublicId, toShortString

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

getLength, itemAt, iterator, reduce, subsequence, toGroundedValue

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

asIterable, effectiveBooleanValue, materialize

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

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GraftedElement

public GraftedElement(TinyTree tree,
                      int nodeNr,
                      NodeInfo externalNode,
                      boolean copyNamespaces)

Created a grafted element node

Parameters:

tree - the host tree that is to contain a reference to an external node

nodeNr - the node number at which the external reference is to appear

externalNode - the external node, in some other tree

copyNamespaces - indicates whether namespaces in the external tree are retained in the virtual copy.

Method Detail

getExternalNode

public NodeInfo getExternalNode()

hasChildNodes

public boolean hasChildNodes()

Description copied from class: TinyParentNodeImpl

Determine if the node has children.

Specified by:

hasChildNodes in interface NodeInfo

Overrides:

hasChildNodes in class TinyParentNodeImpl

Returns:

true if this node has any attributes, false otherwise.

getStringValueCS

public java.lang.CharSequence getStringValueCS()

Description copied from class: TinyParentNodeImpl

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 GroundedValue<NodeInfo>

Specified by:

getStringValueCS in interface Item<NodeInfo>

Overrides:

getStringValueCS in class TinyParentNodeImpl

Returns:

the string value of the item

See Also:

Item.getStringValue()

getStringValue

public java.lang.String getStringValue()

Description copied from class: TinyParentNodeImpl

Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Specified by:

getStringValue in interface GroundedValue<NodeInfo>

Specified by:

getStringValue in interface Item<NodeInfo>

Specified by:

getStringValue in interface NodeInfo

Overrides:

getStringValue in class TinyParentNodeImpl

Returns:

the accumulated character content of the element, including descendant elements.

See Also:

Item.getStringValueCS()

atomize

public AtomicSequence atomize()
                       throws XPathException

Description copied from class: TinyElementImpl

Get the typed value.

Specified by:

atomize in interface Item<NodeInfo>

Specified by:

atomize in interface NodeInfo

Overrides:

atomize in class TinyElementImpl

Returns:

the typed value. It will 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

copy

public void copy(Receiver receiver,
                 int copyOptions,
                 Location location)
          throws XPathException

Description copied from class: TinyElementImpl

Copy this node to a given receiver

Specified by:

copy in interface NodeInfo

Overrides:

copy in class TinyElementImpl

Parameters:

receiver - the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.

copyOptions - determines handling of namespaces, etc

location - location information associated with the event

Throws:

XPathException - if any downstream error occurs

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)

Description copied from class: TinyNodeImpl

Return an iterator over all the nodes reached by the given axis from this node

Specified by:

iterateAxis in interface NodeInfo

Overrides:

iterateAxis in class TinyNodeImpl

Parameters:

axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT

Returns:

a AxisIteratorImpl that scans the nodes reached by the axis in turn.

See Also:

AxisInfo

iterateAxis

public AxisIterator iterateAxis(byte axisNumber,
                                NodeTest nodeTest)

Description copied from class: TinyNodeImpl

Return an iterator over the nodes reached by the given axis from this node

Specified by:

iterateAxis in interface NodeInfo

Overrides:

iterateAxis in class TinyNodeImpl

Parameters:

axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT

nodeTest - A pattern to be matched by the returned nodes.

Returns:

a AxisIteratorImpl that scans the nodes reached by the axis in turn.

See Also:

AxisInfo

getAttributeValue

public java.lang.String getAttributeValue(int fp)

Get the value of the attribute with a given fingerprint.

Overrides:

getAttributeValue in class TinyElementImpl

Parameters:

fp - the fingerprint of the required attribute

Returns:

the string value of the attribute if present, or null if absent

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String uri,
                                          java.lang.String local)

Description copied from class: TinyElementImpl

Get the string value of a given attribute of this node

Specified by:

getAttributeValue in interface NodeInfo

Overrides:

getAttributeValue in class TinyElementImpl

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.

hasDefaultNamespace

public boolean hasDefaultNamespace()

getDeclaredNamespaces

public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)

Description copied from class: TinyElementImpl

Get all namespace undeclarations and undeclarations defined on this element.

Specified by:

getDeclaredNamespaces in interface NodeInfo

Overrides:

getDeclaredNamespaces in class TinyElementImpl

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 objects 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 binding objects (essentially prefix/uri pairs) If the URI is null, 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 null.