net.sf.saxon.tree.tiny

Class TinyTextualElement.TinyTextualElementText

java.lang.Object

net.sf.saxon.tree.tiny.TinyTextualElement.TinyTextualElementText

All Implemented Interfaces:

javax.xml.transform.Source, javax.xml.transform.SourceLocator, ActiveSource, GroundedValue, Item, NodeInfo, Sequence, Location, org.xml.sax.Locator

Enclosing class:

TinyTextualElement

public static class TinyTextualElement.TinyTextualElementText
extends java.lang.Object
implements NodeInfo, javax.xml.transform.SourceLocator

Inner class representing the text node; this is created on demand

Constructor Summary

Constructors

Constructor and Description
TinyTextualElementText(TinyTextualElement element)

Method Summary

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.
void	copy(Receiver out, int copyOptions, Location locationId) Copy the node to a given Outputter
boolean	equals(java.lang.Object other) Determine whether this is the same node as another node
void	generateId(java.lang.StringBuilder buffer) Get a character string that uniquely identifies this node
NamespaceMap	getAllNamespaces() Get all the namespace bindings that are in-scope for this element.
java.lang.String	getAttributeValue(java.lang.String uri, java.lang.String local) Get the string value of a given attribute of this node
java.lang.String	getBaseURI() Get the base URI for the node.
int	getColumnNumber() Return the character position where the current document event ends.
NamespaceBinding[]	getDeclaredNamespaces(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.
java.lang.String	getDisplayName() Get the display name of this node.
int	getFingerprint() Get the fingerprint of the node, used for matching names
int	getLineNumber() Get line number
java.lang.String	getLocalPart() Get the local name of this node.
int	getNodeKind() Return the type of node.
NodeInfo	getParent() Find the parent node of this node.
java.lang.String	getPrefix() Get the prefix part of the name of this node.
NodeInfo	getRoot() Get the root node
SchemaType	getSchemaType() Get the type annotation of this node, if any.
java.lang.String	getSystemId() Get the system ID for the entity containing the node.
TreeInfo	getTreeInfo() Get information about the tree to which this NodeInfo belongs
UnicodeString	getUnicodeStringValue() Get the value of the item as a UnicodeString.
java.lang.String	getURI() Get the URI part of the name of this node.
boolean	hasChildNodes() Determine whether the node has any children.
boolean	hasFingerprint() Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool.
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()
AxisIterator	iterateAxis(int axisNumber) Return an enumeration over the nodes reached by the given axis from this node
AxisIterator	iterateAxis(int axisNumber, NodePredicate predicate) Return an enumeration over the nodes reached by the given axis from this node
Location	saveLocation() Get an immutable copy of this Location object.
void	setSystemId(java.lang.String systemId) Set the system ID for the entity containing the node.

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

asActiveSource, attributes, children, children, deliver, getConfiguration, getGenre, getPublicId, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString

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

getLength, getStringValue, head, itemAt, iterate, reduce, subsequence

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

asIterable, concatenate, containsNode, effectiveBooleanValue, materialize

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

makeRepeatable

Constructor Detail

TinyTextualElementText

public TinyTextualElementText(TinyTextualElement element)

Method Detail

hasFingerprint

public boolean hasFingerprint()

Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool. If the answer is true, then the getFingerprint() method must return the fingerprint of the node. If the answer is false, then the getFingerprint() method should throw an UnsupportedOperationException. In the case of unnamed nodes such as text nodes, the result can be either true (in which case getFingerprint() should return -1) or false (in which case getFingerprint may throw an exception).

Specified by:

hasFingerprint in interface NodeInfo

Returns:

true if the implementation of this node provides fingerprints.

Since:

9.8; previously Saxon relied on using FingerprintedNode as a marker interface.

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

setSystemId

public void setSystemId(java.lang.String systemId)

Set the system ID for the entity containing the node.

Specified by:

setSystemId in interface javax.xml.transform.Source

Specified by:

setSystemId in interface NodeInfo

getNodeKind

public final int getNodeKind()

Return the type of node.

Specified by:

getNodeKind in interface NodeInfo

Returns:

Type.TEXT (always)

See Also:

Type

getUnicodeStringValue

public UnicodeString getUnicodeStringValue()

Get the value of the item as a UnicodeString.

Specified by:

getUnicodeStringValue in interface GroundedValue

Specified by:

getUnicodeStringValue in interface Item

Returns:

the string value of the text node

equals

public boolean equals(java.lang.Object other)

Determine whether this is the same node as another node

Specified by:

equals in interface NodeInfo

Overrides:

equals in class java.lang.Object

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.

hashCode

public int hashCode()

Description copied from interface: NodeInfo

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 java.lang.Object

generateId

public void generateId(java.lang.StringBuilder buffer)

Get a character string that uniquely identifies this node

Specified by:

generateId in interface NodeInfo

Parameters:

buffer - a buffer which will be updated to hold a string that uniquely identifies this node, across all documents.

getSystemId

public java.lang.String getSystemId()

Get the system ID for the entity containing the node.

Specified by:

getSystemId in interface javax.xml.transform.Source

Specified by:

getSystemId in interface javax.xml.transform.SourceLocator

Specified by:

getSystemId in interface NodeInfo

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface org.xml.sax.Locator

Returns:

the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.

getBaseURI

public java.lang.String getBaseURI()

Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.

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.

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

getFingerprint

public int getFingerprint()

Get the fingerprint of the node, used for matching names

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.

getPrefix

public java.lang.String getPrefix()

Get the prefix part of the name of this node. This is the name before the ":" if any.

Specified by:

getPrefix in interface NodeInfo

Returns:

the prefix part of the name. For an unnamed node, return "".

getURI

public java.lang.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, or for an element or attribute in the default namespace, return an empty string.

getDisplayName

public java.lang.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.

getLocalPart

public java.lang.String getLocalPart()

Get the local name of this node.

Specified by:

getLocalPart in interface NodeInfo

Returns:

The local name of this node. For a node with no name, return "".

hasChildNodes

public boolean hasChildNodes()

Determine whether the node has any children.

Specified by:

hasChildNodes in interface NodeInfo

Returns:

true if this node has any attributes, false otherwise.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String uri,
                                          java.lang.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

getLineNumber

public int getLineNumber()

Get line number

Specified by:

getLineNumber in interface javax.xml.transform.SourceLocator

Specified by:

getLineNumber in interface NodeInfo

Specified by:

getLineNumber in interface Location

Specified by:

getLineNumber in interface org.xml.sax.Locator

Returns:

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

getColumnNumber

public int getColumnNumber()

Return the character position where the current document event ends.

Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup that triggered the event appears.

Specified by:

getColumnNumber in interface javax.xml.transform.SourceLocator

Specified by:

getColumnNumber in interface NodeInfo

Specified by:

getColumnNumber in interface Location

Specified by:

getColumnNumber in interface org.xml.sax.Locator

Returns:

The column number, or -1 if none is available.

See Also:

getLineNumber()

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

Returns:

an immutable copy (which may be the original object, if it is already immutable)

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

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.

getAllNamespaces

public NamespaceMap getAllNamespaces()

Get all the namespace bindings that are in-scope for this element.

For an element return all the prefix-to-uri bindings that are in scope. This may include a binding to the default namespace (represented by a prefix of ""). It will never include "undeclarations" - that is, the namespace URI will never be empty; the effect of an undeclaration is to remove a binding from the in-scope namespaces, not to add anything.

For a node other than an element, returns null.

Specified by:

getAllNamespaces in interface NodeInfo

Returns:

the in-scope namespaces for an element, or null for any other kind of node.

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

iterateAxis

public AxisIterator iterateAxis(int axisNumber)

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

Specified by:

iterateAxis in interface NodeInfo

Parameters:

axisNumber - the axis to be iterated over

Returns:

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

See Also:

AxisInfo

iterateAxis

public AxisIterator iterateAxis(int axisNumber,
                                NodePredicate predicate)

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

Specified by:

iterateAxis in interface NodeInfo

Parameters:

axisNumber - the axis to be iterated over

predicate - A pattern to be matched by the returned nodes

Returns:

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

See Also:

AxisInfo

getParent

public NodeInfo getParent()

Find the parent node of this node.

Specified by:

getParent in interface NodeInfo

Returns:

The Node object describing the containing element or root node.

getRoot

public NodeInfo getRoot()

Get the root node

Specified by:

getRoot in interface NodeInfo

Returns:

the NodeInfo representing the root of this tree

copy

public void copy(Receiver out,
                 int copyOptions,
                 Location locationId)
          throws XPathException

Copy the node to a given Outputter

Specified by:

copy in interface NodeInfo

Parameters:

out - 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 - a selection of the options defined in CopyOptions

locationId - If non-null, identifies the location of the instruction that requested this copy. If null, indicates that the location information is not available

Throws:

XPathException - if any downstream error occurs