net.sf.saxon.value
public final class TextFragmentValue extends Object implements DocumentInfo, FingerprintedNode, SourceLocator
Constructor Summary | |
---|---|
TextFragmentValue(CharSequence value, String baseURI)
Constructor: create a result tree fragment containing a single text node |
Method Summary | |
---|---|
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 Outputter |
void | generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node |
String | getAttributeValue(int fingerprint)
Get the value of a given attribute of this node |
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.
|
String | getDisplayName()
Get the display name of this node. |
long | getDocumentNumber()
Get the unique document number |
DocumentInfo | getDocumentRoot()
Get the root (document) node |
int | getFingerprint()
Get the fingerprint of the node, used for matching names |
int | getLineNumber()
Get line number
|
String | getLocalPart()
Get the local name of this node. |
int | getNameCode()
Get the name code of the node, used for displaying names |
NamePool | getNamePool()
Get the name pool used for the names in this document |
int | getNodeKind()
Return the type of node. |
NodeInfo | getParent()
Find the parent node of this node. |
String | getPrefix()
Get the prefix part of the name of this node. |
String | getPublicId()
Return the public identifier for the current document event.
|
NodeInfo | getRoot()
Get the root node |
String | getStringValue()
Get the String Value |
CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. |
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 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 |
String | getURI()
Get the URI part of the name of this node. |
boolean | hasChildNodes()
Determine whether the node has any children. |
boolean | isId()
Determine whether this node has the is-id property
|
boolean | isIdref()
Determine whether this node has the is-idref property
|
boolean | isNilled()
Determine whether the node has the is-nilled property
|
boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node |
AxisIterator | iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node |
AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node |
NodeInfo | selectID(String id, boolean getParent)
Get the element with a given ID. |
void | setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document) |
void | setSystemId(String systemId)
Set the system ID (that is, the document URI property) for the document node. |
Parameters: value a String containing the value baseURI the base URI of the document node
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
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())
Parameters: buffer the buffer to contain the generated ID
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists or null if not
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
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.
Returns: The display name of this node. For a node with no name, return an empty string.
Returns: the DocumentInfo representing the containing document
Returns: the line number of the node in its original source document; or -1 if not available
Returns: The local name of this node. For a node with no name, return "".
Returns: Type.DOCUMENT (always)
Returns: The Node object describing the containing element or root node.
Returns: the prefix part of the name. For an unnamed node, return "".
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
Returns: the NodeInfo representing the root of this tree
Returns: the type annotation of the node.
See Also: Type
Returns: the typed value of the item. In general this will be a sequence
Parameters: name the name of the entity
Returns: the URI and public ID of the entity if there is one, or null if not
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
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.
Returns: true
if this node has any attributes,
false
otherwise.
Returns: true if the node is an ID
Returns: true if the node is an IDREF or IDREFS element or attribute
Returns: true if the node has the is-nilled property
Returns: true if this Node object and the supplied Node object represent the same node in the tree.
Parameters: axisNumber The axis to be iterated over
Returns: a AxisIterator that scans the nodes reached by the axis in turn.
See Also: Axis
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
Parameters: id The unique ID of the required element getParent
Returns: null (this kind of tree contains no elements)
Throws: UnsupportedOperationException (always). This kind of tree does not have a document URI.