Package net.sf.saxon.value
Class TextFragmentValue
java.lang.Object
net.sf.saxon.value.TextFragmentValue
- All Implemented Interfaces:
Source
,SourceLocator
,ActiveSource
,GroundedValue
,Item
,NodeInfo
,Sequence
,Location
,Locator
This class represents a temporary tree whose root document node owns a single text node.
-
Constructor Summary
ConstructorsConstructorDescriptionTextFragmentValue
(Configuration config, UnicodeString value, String baseURI) Constructor: create a result tree fragment containing a single text node -
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 result tree fragment value 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 document node.getDeclaredNamespaces
(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.int
Get the fingerprint of the node, used for matching namesGet 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 NodeInfo object representing the document node at the root of the treeGet the type annotation of this node, if any.Get the system ID (the document URI) of the document node.Get information about the tree to which this NodeInfo belongsGet the String Value of the document node, which is the same as the string value of the text nodeString[]
getUnparsedEntity
(String name) Get the unparsed entity with a given nameGet the list of unparsed entities defined in this documentboolean
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()
Returns a hash code value for the object.boolean
isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPEDiterateAxis
(int axisNumber) Return an iteration over the nodes reached by the given axis from this nodeiterateAxis
(int axisNumber, NodePredicate nodeTest) Return an enumeration over the nodes reached by the given axis from this nodestatic NodeInfo
makeTextFragment
(Configuration config, UnicodeString value, String baseURI) Static factory method: create a result tree fragment containing a single text node, unless the text is zero length, in which case an empty document node is returnedGet an immutable copy of this Location object.Get the element with a given ID.void
setSystemId
(String systemId) Set the system ID (that is, the document URI property) for the document 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, getColumnNumber, getConfiguration, getGenre, getLineNumber, getPublicId, getURI, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
TextFragmentValue
Constructor: create a result tree fragment containing a single text node- Parameters:
config
- the Saxon Configurationvalue
- a String containing the valuebaseURI
- the base URI of the document node
-
-
Method Details
-
makeTextFragment
Static factory method: create a result tree fragment containing a single text node, unless the text is zero length, in which case an empty document node is returned- Parameters:
config
- the Saxon Configurationvalue
- a String containing the valuebaseURI
- the base URI of the document node- Returns:
- the result tree fragment, or an empty document node
-
getTreeInfo
Get information about the tree to which this NodeInfo belongs- Specified by:
getTreeInfo
in interfaceNodeInfo
- Returns:
- the TreeInfo
- Since:
- 9.7
-
getRootNode
Get the NodeInfo object representing the document node at the root of the tree- Returns:
- the document node
-
isTyped
public boolean isTyped()Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED- Returns:
- true if the document contains elements whose type is other than UNTYPED
-
getNodeKind
public final int getNodeKind()Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- Type.DOCUMENT (always)
- See Also:
-
getUnicodeStringValue
Get the String Value of the document node, which is the same as the string value of the text node- Specified by:
getUnicodeStringValue
in interfaceGroundedValue
- Specified by:
getUnicodeStringValue
in interfaceItem
- Returns:
- the string value
-
equals
Determine whether this is the same node as another node -
hashCode
public int hashCode()Returns a hash code value for the object. -
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.
-
generateId
Get a character string that uniquely identifies this node- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- the buffer to contain the generated ID
-
setSystemId
Set the system ID (that is, the document URI property) for the document node.- Specified by:
setSystemId
in interfaceNodeInfo
- Specified by:
setSystemId
in interfaceSource
- Throws:
UnsupportedOperationException
- (always). This kind of tree does not have a document URI.
-
getSystemId
Get the system ID (the document URI) of the document 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 document 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.
-
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 undeclarations 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. -
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
-
iterateAxis
Return an iteration 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 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:
-
getParent
Find the parent node of this node. -
getRoot
Get the root node -
copy
Copy the result tree fragment value 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
-
selectID
Get the element with a given ID.- Parameters:
id
- The unique ID of the required elementgetParent
- True if, in the case of an element of type xs:ID, we want its parent- Returns:
- null (this kind of tree contains no elements)
-
getUnparsedEntityNames
Get the list of unparsed entities defined in this document- Returns:
- an Iterator, whose items are of type String, containing the names of all unparsed entities defined in this document. If there are no unparsed entities or if the information is not available then an empty iterator is returned
-
getUnparsedEntity
Get the unparsed entity with a given name- Parameters:
name
- the name of the entity- Returns:
- the URI and public ID of the entity if there is one, or null if not
-