Class TinyTextualElement.TinyTextualElementText
- All Implemented Interfaces:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,Location
,Locator
- Enclosing class:
TinyTextualElement
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Get the typed value.int
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
Copy the node to a given Outputterboolean
Determine whether this is the same node as another nodevoid
generateId
(StringBuilder buffer) Get a character string that uniquely identifies this nodeGet all the namespace bindings that are in-scope for this element.getAttributeValue
(NamespaceUri uri, String local) Get the string value of a given attribute of this nodeGet the base URI for the node.int
Return the character position where the current document event ends.getDeclaredNamespaces
(NamespaceBinding[] buffer) Get all namespace declarations and undeclarations defined on this element.Get the display name of this node.int
Get the fingerprint of the node, used for matching namesint
Get line numberGet the local name of this node.Get the URI part of the name of this node.final int
Return the type of node.Find the parent node of this node.Get the prefix part of the name of this node.getRoot()
Get the root nodeGet the type annotation of this node, if any.Get the system ID for the entity containing the node.Get information about the tree to which this NodeInfo belongsGet the value of the item as a UnicodeString.boolean
Determine whether the node has any children.boolean
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()iterateAxis
(int axisNumber) Return an enumeration over the nodes reached by the given axis from this nodeiterateAxis
(int axisNumber, NodePredicate predicate) Return an enumeration over the nodes reached by the given axis from this nodeGet an immutable copy of this Location object.void
setSystemId
(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.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
Methods inherited from interface net.sf.saxon.om.Item
getLength, getStringValue, head, itemAt, iterate, reduce, subsequence
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, attributes, children, children, deliver, getAttributeValue, getConfiguration, getGenre, getPublicId, getURI, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
TinyTextualElementText
-
-
Method Details
-
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 thegetFingerprint()
method must return the fingerprint of the node. If the answer is false, then thegetFingerprint()
method should throw anUnsupportedOperationException
. 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 interfaceNodeInfo
- Returns:
- true if the implementation of this node provides fingerprints.
- Since:
- 9.8; previously Saxon relied on using
FingerprintedNode
as a marker interface.
-
getTreeInfo
Get information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfo
in interfaceNodeInfo
- Returns:
- the TreeInfo
- Since:
- 9.7
-
setSystemId
Set the system ID for the entity containing the node.- Specified by:
setSystemId
in interfaceNodeInfo
- Specified by:
setSystemId
in interfaceSource
-
getNodeKind
public final int getNodeKind()Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- Type.TEXT (always)
- See Also:
-
getUnicodeStringValue
Get the value of the item as a UnicodeString.- Specified by:
getUnicodeStringValue
in interfaceGroundedValue
- Specified by:
getUnicodeStringValue
in interfaceItem
- Returns:
- the string value of the text node
-
equals
Determine whether this is the same node as another node -
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() -
generateId
Get a character string that uniquely identifies this node- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- a buffer which will be updated to hold a string that uniquely identifies this node, across all documents.
-
getSystemId
Get the system ID for the entity containing the node.- Specified by:
getSystemId
in interfaceLocation
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.
-
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 interfaceNodeInfo
- 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
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 interfaceNodeInfo
- 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 interfaceNodeInfo
- 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
Get the prefix part of the name of this node. This is the name before the ":" if any. -
getNamespaceUri
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:
getNamespaceUri
in interfaceNodeInfo
- 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
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 interfaceNodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getLocalPart
Get the local name of this node.- Specified by:
getLocalPart
in interfaceNodeInfo
- 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 interfaceNodeInfo
- Returns:
true
if this node has any attributes,false
otherwise.
-
getAttributeValue
Get the string value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespacelocal
- 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 interfaceLocation
- Specified by:
getLineNumber
in interfaceLocator
- Specified by:
getLineNumber
in interfaceNodeInfo
- Specified by:
getLineNumber
in interfaceSourceLocator
- 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 interfaceLocation
- Specified by:
getColumnNumber
in interfaceLocator
- Specified by:
getColumnNumber
in interfaceNodeInfo
- Specified by:
getColumnNumber
in interfaceSourceLocator
- Returns:
- The column number, or -1 if none is available.
- See Also:
-
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 interfaceLocation
- Returns:
- an immutable copy (which may be the original object, if it is already immutable)
-
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 interfaceNodeInfo
- 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
Get all namespace declarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- 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
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 interfaceNodeInfo
- Returns:
- the in-scope namespaces for an element, or null for any other kind of node.
-
atomize
Get the typed value.- Specified by:
atomize
in interfaceItem
- Specified by:
atomize
in interfaceNodeInfo
- 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
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be iterated over- Returns:
- a AxisIterator that scans the nodes reached by the axis in turn.
- See Also:
-
iterateAxis
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be iterated overpredicate
- A pattern to be matched by the returned nodes- Returns:
- a AxisIterator that scans the nodes reached by the axis in turn.
- See Also:
-
getParent
Find the parent node of this node. -
getRoot
Get the root node -
copy
Copy the node to a given Outputter- Specified by:
copy
in interfaceNodeInfo
- 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 inCopyOptions
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
-