Class TinyTextualElement.TinyTextualElementText
- java.lang.Object
-
- net.sf.saxon.tree.tiny.TinyTextualElement.TinyTextualElementText
-
- All Implemented Interfaces:
javax.xml.transform.Source,javax.xml.transform.SourceLocator,GroundedValue,Item,NodeInfo,Sequence,Location,org.xml.sax.Locator
- Enclosing class:
- TinyTextualElement
public class TinyTextualElement.TinyTextualElementText extends java.lang.Object implements NodeInfo, javax.xml.transform.SourceLocator
Inner class representing the text node; this is created on demand
-
-
Field Summary
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
IS_DTD_TYPE, IS_NILLED
-
-
Constructor Summary
Constructors Constructor Description TinyTextualElementText()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AtomicSequenceatomize()Get the typed value.intcompareOrder(NodeInfo other)Determine the relative position of this node and another node, in document order.voidcopy(Receiver out, int copyOptions, Location locationId)Copy the node to a given Outputterbooleanequals(java.lang.Object other)Determine whether this is the same node as another nodevoidgenerateId(FastStringBuffer buffer)Get a character string that uniquely identifies this nodeNamespaceMapgetAllNamespaces()Get all the namespace bindings that are in-scope for this element.java.lang.StringgetAttributeValue(java.lang.String uri, java.lang.String local)Get the string value of a given attribute of this nodejava.lang.StringgetBaseURI()Get the base URI for the node.intgetColumnNumber()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.StringgetDisplayName()Get the display name of this node.intgetFingerprint()Get the fingerprint of the node, used for matching namesintgetLineNumber()Get line numberjava.lang.StringgetLocalPart()Get the local name of this node.intgetNodeKind()Return the type of node.NodeInfogetParent()Find the parent node of this node.java.lang.StringgetPrefix()Get the prefix part of the name of this node.NodeInfogetRoot()Get the root nodeSchemaTypegetSchemaType()Get the type annotation of this node, if any.java.lang.StringgetStringValue()Get the String Valuejava.lang.CharSequencegetStringValueCS()Get the value of the item as a CharSequence.java.lang.StringgetSystemId()Get the system ID for the entity containing the node.TreeInfogetTreeInfo()Get information about the tree to which this NodeInfo belongsjava.lang.StringgetURI()Get the URI part of the name of this node.booleanhasChildNodes()Determine whether the node has any children.booleanhasFingerprint()Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool.AxisIteratoriterateAxis(int axisNumber)Return an enumeration over the nodes reached by the given axis from this nodeAxisIteratoriterateAxis(int axisNumber, java.util.function.Predicate<? super NodeInfo> nodeTest)Return an enumeration over the nodes reached by the given axis from this nodeLocationsaveLocation()Get an immutable copy of this Location object.voidsetSystemId(java.lang.String systemId)Set the system ID for the entity containing the node.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, 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, head, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
attributes, children, children, getConfiguration, getGenre, getPublicId, hashCode, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
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 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:
hasFingerprintin interfaceNodeInfo- Returns:
- true if the implementation of this node provides fingerprints.
- Since:
- 9.8; previously Saxon relied on using
FingerprintedNodeas a marker interface.
-
getTreeInfo
public TreeInfo getTreeInfo()
Get information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfoin interfaceNodeInfo- 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:
setSystemIdin interfacejavax.xml.transform.Source
-
getNodeKind
public final int getNodeKind()
Return the type of node.- Specified by:
getNodeKindin interfaceNodeInfo- Returns:
- Type.TEXT (always)
- See Also:
Type
-
getStringValue
public java.lang.String getStringValue()
Get the String Value- Specified by:
getStringValuein interfaceGroundedValue- Specified by:
getStringValuein interfaceItem- Specified by:
getStringValuein interfaceNodeInfo- Returns:
- the string value of the node
- See Also:
Item.getStringValueCS()
-
getStringValueCS
public java.lang.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:
getStringValueCSin interfaceGroundedValue- Specified by:
getStringValueCSin interfaceItem- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
equals
public boolean equals(java.lang.Object other)
Determine whether this is the same node as another node
-
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node- Specified by:
generateIdin interfaceNodeInfo- 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:
getSystemIdin interfaceLocation- Specified by:
getSystemIdin interfaceorg.xml.sax.Locator- Specified by:
getSystemIdin interfaceNodeInfo- Specified by:
getSystemIdin interfacejavax.xml.transform.Source- Specified by:
getSystemIdin interfacejavax.xml.transform.SourceLocator- 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:
getBaseURIin 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
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:
compareOrderin 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:
getFingerprintin 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
public java.lang.String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.
-
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.
-
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:
getDisplayNamein interfaceNodeInfo- 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:
getLocalPartin 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:
hasChildNodesin interfaceNodeInfo- Returns:
trueif this node has any attributes,falseotherwise.
-
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:
getAttributeValuein 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:
getLineNumberin interfaceLocation- Specified by:
getLineNumberin interfaceorg.xml.sax.Locator- Specified by:
getLineNumberin interfaceNodeInfo- Specified by:
getLineNumberin interfacejavax.xml.transform.SourceLocator- 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:
getColumnNumberin interfaceLocation- Specified by:
getColumnNumberin interfaceorg.xml.sax.Locator- Specified by:
getColumnNumberin interfaceNodeInfo- Specified by:
getColumnNumberin interfacejavax.xml.transform.SourceLocator- 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:
saveLocationin interfaceLocation- 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:
getSchemaTypein 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
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespacesin 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
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:
getAllNamespacesin interfaceNodeInfo- 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:
atomizein interfaceItem- Specified by:
atomizein 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
public AxisIterator iterateAxis(int axisNumber)
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxisin interfaceNodeInfo- 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, java.util.function.Predicate<? super NodeInfo> nodeTest)
Return an enumeration over the nodes reached by the given axis from this node- Specified by:
iterateAxisin interfaceNodeInfo- Parameters:
axisNumber- the axis to be iterated overnodeTest- 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.
-
getRoot
public NodeInfo getRoot()
Get the root node
-
copy
public void copy(Receiver out, int copyOptions, Location locationId) throws XPathException
Copy the node to a given Outputter- Specified by:
copyin 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 inCopyOptionslocationId- If non-null, identifies the location of the instruction that requested this copy. If zero, indicates that the location information is not available- Throws:
XPathException- if any downstream error occurs
-
-