| java.lang.Object
 net.sf.saxon.value.TextFragmentValue
| Method Summary | |
| public Value | atomize()
Get the typed value. | | 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 -1 if this node precedes the other node, +1 if it follows the othernode, or 0 if they are the same node. | | public void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
| | public String | generateId()
| | public String | getAttributeValue(int fingerprint)
| | public String | getBaseURI()
Get the base URI for the node. | | public int | getColumnNumber()
Return the character position where the current document event ends. | | public Configuration | getConfiguration()
| | 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 resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. | | public String | getDisplayName()
Get the display name of this node. | | public int | getDocumentNumber()
| | public DocumentInfo | getDocumentRoot()
| | public int | getFingerprint()
| | public int | getLineNumber()
| | public String | getLocalPart()
Get the local name of this node. | | public int | getNameCode()
| | public NamePool | getNamePool()
| | final public int | getNodeKind()
Return the type of node. | | public NodeInfo | getParent()
Find the parent node of this node. | | public String | getPrefix()
Get the prefix part of the name of this node. | | public String | getPublicId()
Return the public identifier for the current document event. | | public NodeInfo | getRoot()
| | public String | getStringValue()
| | public CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. | | public String | getSystemId()
Get the system ID for the entity containing the node. | | public int | getTypeAnnotation()
Get the type annotation of this node, if any. | | public SequenceIterator | getTypedValue()
Get the typed value of the item
the typed value of the item. | | public String | getURI()
Get the URI part of the name of this node. | | public String[] | getUnparsedEntity(String name)
| | public boolean | hasChildNodes()
Determine whether the node has any children. | | public boolean | isSameNodeInfo(NodeInfo other)
| | public AxisIterator | iterateAxis(byte axisNumber)
| | public AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
| | public NodeInfo | selectID(String id)
Get the element with a given ID. | | public void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element. | | public void | setConfiguration(Configuration config)
| | public void | setSystemId(String systemId)
Set the system ID for the entity containing the node. |
| TextFragmentValue | | public TextFragmentValue(CharSequence value, String systemId)(Code) | | Constructor: create a result tree fragment containing a single text node
Parameters:
value - a String containing the value |
| atomize | | public Value atomize()(Code) | | Get the typed value. The result of this method will always be consistent with the method
net.sf.saxon.om.Item.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.
the typed value. If requireSingleton is set to true, the result will always be anAtomicValue. In other cases it may be a Value representing a sequence whose items are atomicvalues.
since:
8.5 |
| compareOrder | | public int compareOrder(NodeInfo other)(Code) | | 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 -1 if this node precedes the other node, +1 if it follows the othernode, or 0 if they are the same node. (In this case, isSameNode() will alwaysreturn true, and the two nodes will produce the same result for generateId()) |
| copy | | public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException(Code) | | Copy the result tree fragment value to a given Outputter
|
| generateId | | public String generateId()(Code) | | Get a character string that uniquely identifies this node
a string. |
| getAttributeValue | | public String getAttributeValue(int fingerprint)(Code) | | Get the value of a given attribute of this node
Parameters:
fingerprint - The fingerprint of the attribute name the attribute value if it exists or null if not |
| getBaseURI | | public String getBaseURI()(Code) | | Get the base URI for the node. Default implementation for child nodes gets
the base URI of the parent node.
|
| getColumnNumber | | public int getColumnNumber()(Code) | | 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.
The column number, or -1 if none is available.
See Also: TextFragmentValue.getLineNumber |
| getConfiguration | | public Configuration getConfiguration()(Code) | | Get the configuration previously set using setConfiguration
(or the default configuraton allocated automatically)
|
| getDeclaredNamespaces | | public int[] getDeclaredNamespaces(int[] buffer)(Code) | | 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 resultmay overwrite the contents of this array, to avoid the cost of allocating a new array on the heap. An array of integers representing the namespace declarations and undeclarations present onthis element. For a node other than an element, return null. Otherwise, the returned array is asequence of namespace codes, whose meaning may be interpreted by reference to the name pool. Thetop 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()(Code) | | Get the display name of this node. For elements and attributes this is [prefix:]localname.
For unnamed nodes, it is an empty string.
The display name of this node.For a node with no name, return an empty string. |
| getDocumentNumber | | public int getDocumentNumber()(Code) | | Get the unique document number
|
| getDocumentRoot | | public DocumentInfo getDocumentRoot()(Code) | | Get the root (document) node
the DocumentInfo representing the containing document |
| getFingerprint | | public int getFingerprint()(Code) | | Get the fingerprint of the node, used for matching names
|
| getLineNumber | | public int getLineNumber()(Code) | | Get line number
the line number of the node in its original source document; or-1 if not available |
| getLocalPart | | public String getLocalPart()(Code) | | Get the local name of this node.
The local name of this node.For a node with no name, return "". |
| getNameCode | | public int getNameCode()(Code) | | Get the name code of the node, used for displaying names
|
| getNamePool | | public NamePool getNamePool()(Code) | | Get the name pool used for the names in this document
|
| getNodeKind | | final public int getNodeKind()(Code) | | Return the type of node.
Type.DOCUMENT (always) |
| getParent | | public NodeInfo getParent()(Code) | | Find the parent node of this node.
The Node object describing the containing element or root node. |
| getPrefix | | public String getPrefix()(Code) | | Get the prefix part of the name of this node. This is the name before the ":" if any.
the prefix part of the name. For an unnamed node, return "". |
| getPublicId | | public String getPublicId()(Code) | | 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.
A string containing the public identifier, ornull if none is available.
See Also: TextFragmentValue.getSystemId |
| getRoot | | public NodeInfo getRoot()(Code) | | Get the root node
the NodeInfo representing the root of this tree |
| getStringValue | | public String getStringValue()(Code) | | Get the String Value
|
| getStringValueCS | | public CharSequence getStringValueCS()(Code) | | 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()(Code) | | Get the system ID for the entity containing the node.
|
| getTypeAnnotation | | public int getTypeAnnotation()(Code) | | 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.
the type annotation of the node.
See Also: net.sf.saxon.type.Type |
| getTypedValue | | public SequenceIterator getTypedValue()(Code) | | Get the typed value of the item
the typed value of the item. In general this will be a sequence |
| getURI | | public String getURI()(Code) | | 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.
The URI of the namespace of this node. For an unnamed node, or foran element or attribute in the default namespace, return an empty string. |
| getUnparsedEntity | | public String[] getUnparsedEntity(String name)(Code) | | Get the unparsed entity with a given name
Parameters:
name - the name of the entity the URI and public ID of the entity if there is one, or null if not |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Determine whether the node has any children.
true if this node has any attributes,false otherwise. |
| isSameNodeInfo | | public boolean isSameNodeInfo(NodeInfo other)(Code) | | Determine whether this is the same node as another node
true if this Node object and the supplied Node object represent thesame node in the tree. |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber)(Code) | | Return an iteration over the nodes reached by the given axis from this node
Parameters:
axisNumber - The axis to be iterated over a AxisIterator that scans the nodes reached by the axis in turn.
See Also: net.sf.saxon.om.Axis |
| iterateAxis | | public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)(Code) | | Return an enumeration over the nodes reached by the given axis from this node
Parameters:
axisNumber - The axis to be iterated over
Parameters:
nodeTest - A pattern to be matched by the returned nodes a AxisIterator that scans the nodes reached by the axis in turn.
See Also: net.sf.saxon.om.Axis |
| selectID | | public NodeInfo selectID(String id)(Code) | | Get the element with a given ID.
Parameters:
id - The unique ID of the required element null (this kind of tree contains no elements) |
| sendNamespaceDeclarations | | public void sendNamespaceDeclarations(Receiver out, boolean includeAncestors)(Code) | | Output all namespace nodes associated with this element. Does nothing if
the node is not an element.
Parameters:
out - The relevant outputter
Parameters:
includeAncestors - True if namespaces declared on ancestor |
| setConfiguration | | public void setConfiguration(Configuration config)(Code) | | Set the configuration (containing the name pool used for all names in this document)
|
| setSystemId | | public void setSystemId(String systemId)(Code) | | Set the system ID for the entity containing the node.
|
|
|