net.sf.saxon.value

Class TextFragmentValue

public final class TextFragmentValue extends Object implements DocumentInfo, FingerprintedNode, SourceLocator

This class represents a temporary tree whose root document node owns a single text node.
Constructor Summary
TextFragmentValue(CharSequence value, String baseURI)
Constructor: create a result tree fragment containing a single text node
Method Summary
Valueatomize()
Get the typed value.
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy the result tree fragment value to a given Outputter
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the base URI for the document node.
intgetColumnNumber()
Return the character position where the current document event ends.
ConfigurationgetConfiguration()
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.
StringgetDisplayName()
Get the display name of this node.
longgetDocumentNumber()
Get the unique document number
DocumentInfogetDocumentRoot()
Get the root (document) node
intgetFingerprint()
Get the fingerprint of the node, used for matching names
intgetLineNumber()
Get line number
StringgetLocalPart()
Get the local name of this node.
intgetNameCode()
Get the name code of the node, used for displaying names
NamePoolgetNamePool()
Get the name pool used for the names in this document
intgetNodeKind()
Return the type of node.
NodeInfogetParent()
Find the parent node of this node.
StringgetPrefix()
Get the prefix part of the name of this node.
StringgetPublicId()
Return the public identifier for the current document event.
NodeInfogetRoot()
Get the root node
StringgetStringValue()
Get the String Value
CharSequencegetStringValueCS()
Get the value of the item as a CharSequence.
StringgetSystemId()
Get the system ID (the document URI) of the document node.
intgetTypeAnnotation()
Get the type annotation of this node, if any.
SequenceIteratorgetTypedValue()
Get the typed value of the item
String[]getUnparsedEntity(String name)
Get the unparsed entity with a given name
Iterator<String>getUnparsedEntityNames()
Get the list of unparsed entities defined in this document
StringgetURI()
Get the URI part of the name of this node.
booleanhasChildNodes()
Determine whether the node has any children.
booleanisId()
Determine whether this node has the is-id property
booleanisIdref()
Determine whether this node has the is-idref property
booleanisNilled()
Determine whether the node has the is-nilled property
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
AxisIteratoriterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node
AxisIteratoriterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
NodeInfoselectID(String id, boolean getParent)
Get the element with a given ID.
voidsetConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)
voidsetSystemId(String systemId)
Set the system ID (that is, the document URI property) for the document node.

Constructor Detail

TextFragmentValue

public TextFragmentValue(CharSequence value, String baseURI)
Constructor: create a result tree fragment containing a single text node

Parameters: value a String containing the value baseURI the base URI of the document node

Method Detail

atomize

public Value atomize()
Get the typed value. The result of this method will always be consistent with the method 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.

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.

Since: 8.5

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.

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

copy

public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy the result tree fragment value to a given Outputter

generateId

public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node

Parameters: buffer the buffer to contain the generated ID

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

getBaseURI

public String getBaseURI()
Get the base URI for the document node.

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.

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

See Also: TextFragmentValue

getConfiguration

public Configuration getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)

getDeclaredNamespaces

public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.

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.

getDisplayName

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

Returns: The display name of this node. For a node with no name, return an empty string.

getDocumentNumber

public long getDocumentNumber()
Get the unique document number

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node

Returns: the DocumentInfo representing the containing document

getFingerprint

public int getFingerprint()
Get the fingerprint of the node, used for matching names

getLineNumber

public int getLineNumber()
Get line number

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

getLocalPart

public String getLocalPart()
Get the local name of this node.

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

getNameCode

public int getNameCode()
Get the name code of the node, used for displaying names

getNamePool

public NamePool getNamePool()
Get the name pool used for the names in this document

getNodeKind

public final int getNodeKind()
Return the type of node.

Returns: Type.DOCUMENT (always)

getParent

public NodeInfo getParent()
Find the parent node of this node.

Returns: The Node object describing the containing element or root node.

getPrefix

public String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.

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

getPublicId

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

Returns: A string containing the public identifier, or null if none is available.

See Also: TextFragmentValue

getRoot

public NodeInfo getRoot()
Get the root node

Returns: the NodeInfo representing the root of this tree

getStringValue

public String getStringValue()
Get the String Value

getStringValueCS

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

getSystemId

public String getSystemId()
Get the system ID (the document URI) of the document node.

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any. Returns XS_UNTYPED for kinds of nodes that have no annotation, and for elements annotated as untyped, and attributes annotated as untypedAtomic.

Returns: the type annotation of the node.

See Also: Type

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of the item

Returns: the typed value of the item. In general this will be a sequence

getUnparsedEntity

public String[] getUnparsedEntity(String name)
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

getUnparsedEntityNames

public Iterator<String> 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

getURI

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

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.

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.

Returns: true if this node has any attributes, false otherwise.

isId

public boolean isId()
Determine whether this node has the is-id property

Returns: true if the node is an ID

isIdref

public boolean isIdref()
Determine whether this node has the is-idref property

Returns: true if the node is an IDREF or IDREFS element or attribute

isNilled

public boolean isNilled()
Determine whether the node has the is-nilled property

Returns: true if the node has the is-nilled property

isSameNodeInfo

public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node

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

Parameters: axisNumber The axis to be iterated over nodeTest 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

selectID

public NodeInfo selectID(String id, boolean getParent)
Get the element with a given ID.

Parameters: id The unique ID of the required element getParent

Returns: null (this kind of tree contains no elements)

setConfiguration

public void setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)

setSystemId

public void setSystemId(String systemId)
Set the system ID (that is, the document URI property) for the document node.

Throws: UnsupportedOperationException (always). This kind of tree does not have a document URI.