Package net.sf.saxon.value
Class TextFragmentValue
- java.lang.Object
-
- net.sf.saxon.value.TextFragmentValue
-
- All Implemented Interfaces:
javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,DocumentInfo
,FingerprintedNode
,Item
,NodeInfo
,ValueRepresentation
public final class TextFragmentValue extends java.lang.Object implements DocumentInfo, FingerprintedNode, javax.xml.transform.SourceLocator
This class represents a temporary tree whose root document node owns a single text node.
-
-
Field Summary
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description TextFragmentValue(java.lang.CharSequence value, java.lang.String baseURI)
Constructor: create a result tree fragment containing a single text node
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Value
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 whichNamespaces, boolean copyAnnotations, int locationId)
Copy the result tree fragment value to a given Outputtervoid
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this nodejava.lang.String
getAttributeValue(int fingerprint)
Get the value of a given attribute of this nodejava.lang.String
getBaseURI()
Get the base URI for the document node.int
getColumnNumber()
Return the character position where the current document event ends.Configuration
getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)int[]
getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.java.lang.String
getDisplayName()
Get the display name of this node.int
getDocumentNumber()
Get the unique document numberDocumentInfo
getDocumentRoot()
Get the root (document) nodeint
getFingerprint()
Get the fingerprint of the node, used for matching namesint
getLineNumber()
Get line numberjava.lang.String
getLocalPart()
Get the local name of this node.int
getNameCode()
Get the name code of the node, used for displaying namesNamePool
getNamePool()
Get the name pool used for the names in this documentint
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.java.lang.String
getPublicId()
Return the public identifier for the current document event.NodeInfo
getRoot()
Get the root nodejava.lang.String
getStringValue()
Get the String Valuejava.lang.CharSequence
getStringValueCS()
Get the value of the item as a CharSequence.java.lang.String
getSystemId()
Get the system ID (the document URI) of the document node.int
getTypeAnnotation()
Get the type annotation of this node, if any.SequenceIterator
getTypedValue()
Get the typed value of the itemjava.lang.String[]
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given namejava.lang.String
getURI()
Get the URI part of the name of this node.boolean
hasChildNodes()
Determine whether the node has any children.boolean
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another nodeAxisIterator
iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this nodeAxisIterator
iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this nodeNodeInfo
selectID(java.lang.String id)
Get the element with a given ID.void
sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element.void
setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)void
setSystemId(java.lang.String systemId)
Set the system ID (that is, the document URI property) for the document node.
-
-
-
Method Detail
-
setConfiguration
public void setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)
-
getConfiguration
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)- Specified by:
getConfiguration
in interfaceNodeInfo
- Returns:
- the Configuration
-
getNamePool
public NamePool getNamePool()
Get the name pool used for the names in this document- Specified by:
getNamePool
in interfaceNodeInfo
- Returns:
- the namepool
-
getDocumentNumber
public int getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumber
in interfaceNodeInfo
-
getNodeKind
public final int getNodeKind()
Return the type of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- Type.DOCUMENT (always)
- See Also:
Type
-
getStringValue
public java.lang.String getStringValue()
Get the String Value- Specified by:
getStringValue
in interfaceItem
- Specified by:
getStringValue
in interfaceNodeInfo
- Specified by:
getStringValue
in interfaceValueRepresentation
- 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:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Returns:
- the string value of the item
- See Also:
Item.getStringValue()
-
isSameNodeInfo
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- 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.
-
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node- Specified by:
generateId
in interfaceNodeInfo
- Parameters:
buffer
- the buffer to contain the generated ID
-
setSystemId
public void setSystemId(java.lang.String systemId)
Set the system ID (that is, the document URI property) for the document node.- Specified by:
setSystemId
in interfacejavax.xml.transform.Source
- Throws:
java.lang.UnsupportedOperationException
- (always). This kind of tree does not have a document URI.
-
getSystemId
public java.lang.String getSystemId()
Get the system ID (the document URI) of the document node.- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfacejavax.xml.transform.Source
- Specified by:
getSystemId
in 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 document node.- Specified by:
getBaseURI
in interfaceNodeInfo
- Returns:
- the base URI of the node. This may be null if the base URI is unknown.
-
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 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())
-
getNameCode
public int getNameCode()
Get the name code of the node, used for displaying names- Specified by:
getNameCode
in interfaceNodeInfo
- Returns:
- an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
- See Also:
allocate
,getFingerprint
-
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
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:
getDisplayName
in 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:
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.
-
getLineNumber
public int getLineNumber()
Get line number- Specified by:
getLineNumber
in interfaceNodeInfo
- Specified by:
getLineNumber
in interfacejavax.xml.transform.SourceLocator
- Returns:
- the line number of the node in its original source document; or -1 if not available
-
getTypeAnnotation
public int getTypeAnnotation()
Get the type annotation of this node, if any. Returns -1 for kinds of nodes that have no annotation, and for elements annotated as untyped, and attributes annotated as untypedAtomic.- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Returns:
- the type annotation of the node.
- See Also:
Type
-
sendNamespaceDeclarations
public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. Does nothing if the node is not an element.- Specified by:
sendNamespaceDeclarations
in interfaceNodeInfo
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor
-
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer)
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.
-
getTypedValue
public SequenceIterator getTypedValue()
Get the typed value of the item- Specified by:
getTypedValue
in interfaceItem
- Returns:
- the typed value of the item. In general this will be a sequence
-
atomize
public Value atomize()
Get the typed value. The result of this method will always be consistent with the methodItem.getTypedValue()
. However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.
-
getPublicId
public java.lang.String getPublicId()
Return the public identifier for the current document event.The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
- Specified by:
getPublicId
in interfacejavax.xml.transform.SourceLocator
- Returns:
- A string containing the public identifier, or null if none is available.
- See Also:
getSystemId()
-
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 interfacejavax.xml.transform.SourceLocator
- Returns:
- The column number, or -1 if none is available.
- See Also:
getLineNumber()
-
getAttributeValue
public java.lang.String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
iterateAxis
public AxisIterator iterateAxis(byte axisNumber)
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:
Axis
-
iterateAxis
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
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:
Axis
-
getParent
public NodeInfo getParent()
Find the parent node of this node.
-
getRoot
public NodeInfo getRoot()
Get the root node
-
getDocumentRoot
public DocumentInfo getDocumentRoot()
Get the root (document) node- Specified by:
getDocumentRoot
in interfaceNodeInfo
- Returns:
- the DocumentInfo representing the containing document
-
copy
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
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 copiedwhichNamespaces
- in the case of an element, controls which namespace nodes should be copied. Values areNodeInfo.NO_NAMESPACES
,NodeInfo.LOCAL_NAMESPACES
,NodeInfo.ALL_NAMESPACES
copyAnnotations
- indicates whether the type annotations of element and attribute nodes should be copiedlocationId
- If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier- Throws:
XPathException
-
selectID
public NodeInfo selectID(java.lang.String id)
Get the element with a given ID.- Specified by:
selectID
in interfaceDocumentInfo
- Parameters:
id
- The unique ID of the required element- Returns:
- null (this kind of tree contains no elements)
-
getUnparsedEntity
public java.lang.String[] getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in interfaceDocumentInfo
- Parameters:
name
- the name of the entity- Returns:
- the URI and public ID of the entity if there is one, or null if not
-
-