Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.value.TextFragmentValue
public final class TextFragmentValue
extends java.lang.Object
implements DocumentInfo, FingerprintedNode, SourceLocator
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 | |
|
Method Summary | |
Value |
|
int |
|
void | |
void |
|
String |
|
String |
|
int |
|
Configuration |
|
int[] |
|
String |
|
int |
|
DocumentInfo |
|
int |
|
int |
|
String |
|
int |
|
NamePool |
|
int |
|
NodeInfo |
|
String |
|
String |
|
NodeInfo |
|
String |
|
CharSequence |
|
String |
|
int |
|
SequenceIterator |
|
String |
|
String[] |
|
boolean |
|
boolean |
|
AxisIterator |
|
AxisIterator |
|
NodeInfo |
|
void |
|
void |
|
public TextFragmentValue(CharSequence value, String baseURI)
Constructor: create a result tree fragment containing a single text node
- Parameters:
value
- a String containing the valuebaseURI
- the base URI of the document node
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.
- 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
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 interface NodeInfo
- 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())
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
Copy the result tree fragment value to a given Outputter
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
- Specified by:
- generateId in interface NodeInfo
- Parameters:
buffer
- the buffer to contain the generated ID
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- Specified by:
- getAttributeValue in interface NodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name
- Returns:
- the attribute value if it exists or null if not
public String getBaseURI()
Get the base URI for the document node.
- Specified by:
- getBaseURI in interface NodeInfo
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:
getLineNumber()
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration (or the default configuraton allocated automatically)
- Specified by:
- getConfiguration in interface NodeInfo
public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
- Specified by:
- getDeclaredNamespaces in interface NodeInfo
- 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.
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.
- Specified by:
- getDisplayName in interface NodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
public int getDocumentNumber()
Get the unique document number
- Specified by:
- getDocumentNumber in interface NodeInfo
public DocumentInfo getDocumentRoot()
Get the root (document) node
- Specified by:
- getDocumentRoot in interface NodeInfo
- Returns:
- the DocumentInfo representing the containing document
public int getFingerprint()
Get the fingerprint of the node, used for matching names
- Specified by:
- getFingerprint in interface NodeInfo
public int getLineNumber()
Get line number
- Specified by:
- getLineNumber in interface NodeInfo
- Returns:
- the line number of the node in its original source document; or -1 if not available
public String getLocalPart()
Get the local name of this node.
- Specified by:
- getLocalPart in interface NodeInfo
- Returns:
- The local name of this node. For a node with no name, return "".
public int getNameCode()
Get the name code of the node, used for displaying names
- Specified by:
- getNameCode in interface NodeInfo
public NamePool getNamePool()
Get the name pool used for the names in this document
- Specified by:
- getNamePool in interface NodeInfo
public final int getNodeKind()
Return the type of node.
- Specified by:
- getNodeKind in interface NodeInfo
- Returns:
- Type.DOCUMENT (always)
public NodeInfo getParent()
Find the parent node of this node.
- Returns:
- The Node object describing the containing element or root node.
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 "".
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:
getSystemId()
public NodeInfo getRoot()
Get the root node
- Returns:
- the NodeInfo representing the root of this tree
public String getStringValue()
Get the String Value
- Specified by:
- getStringValue in interface NodeInfo
- getStringValue in interface Item
- getStringValue in interface ValueRepresentation
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.
- Specified by:
- getStringValueCS in interface Item
- getStringValueCS in interface ValueRepresentation
public String getSystemId()
Get the system ID (the document URI) of the document node.
- Specified by:
- getSystemId in interface NodeInfo
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 interface NodeInfo
- Returns:
- the type annotation of the node.
- See Also:
Type
public SequenceIterator getTypedValue()
Get the typed value of the item
- Specified by:
- getTypedValue in interface Item
- Returns:
- the typed value of the item. In general this will be a sequence
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.
public String[] getUnparsedEntity(String name)
Get the unparsed entity with a given name
- Specified by:
- getUnparsedEntity in interface DocumentInfo
- Parameters:
name
- the name of the entity
- Returns:
- the URI and public ID of the entity if there is one, or null if not
public boolean hasChildNodes()
Determine whether the node has any children.
- Specified by:
- hasChildNodes in interface NodeInfo
- Returns:
true
if this node has any attributes,false
otherwise.
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
- Specified by:
- isSameNodeInfo in interface NodeInfo
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
public AxisIterator iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node
- Specified by:
- iterateAxis in interface NodeInfo
- Parameters:
axisNumber
- The axis to be iterated over
- Returns:
- a AxisIterator that scans the nodes reached by the axis in turn.
- See Also:
Axis
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 interface NodeInfo
- 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
public NodeInfo selectID(String id)
Get the element with a given ID.
- Specified by:
- selectID in interface DocumentInfo
- Parameters:
id
- The unique ID of the required element
- Returns:
- null (this kind of tree contains no elements)
public void setConfiguration(Configuration config)
Set the configuration (containing the name pool used for all names in this document)
public void setSystemId(String systemId)
Set the system ID (that is, the document URI property) for the document node.