Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.icl.saxon.expr

Class TextFragmentValue

Implemented Interfaces:
NodeList
public final class TextFragmentValue
extends SingletonNodeSet
This class represents a Value of type result tree fragment, specifically, an RTF whose root owns a single text node.

Nested Class Summary

Field Summary

Fields inherited from class com.icl.saxon.expr.SingletonNodeSet

generalUseAllowed, node

Fields inherited from class com.icl.saxon.expr.Value

ANY, BOOLEAN, NODESET, NUMBER, OBJECT, STRING

Fields inherited from class com.icl.saxon.expr.Expression

staticContext

Constructor Summary

TextFragmentValue(String value, String systemId, Controller controller)
Constructor: create a result tree fragment containing a single text node

Method Summary

boolean
asBoolean()
Convert the result tree fragment to a boolean
double
asNumber()
Convert the result tree fragment to a number
String
asString()
Convert the result tree fragment to a string.
boolean
compare(int operator, Value other)
Test how a FragmentValue compares to another Value under a relational comparison.
void
copy(Outputter out)
Copy the result tree fragment value to a given Outputter
void
display(int level)
Diagnostic print of expression structure
NodeEnumeration
enumerate()
Return an enumeration of this nodeset value.
boolean
equals(Value other)
Test whether a nodeset "equals" another Value
int
getCount()
Count the nodes in the node-set.
int
getDataType()
Determine the data type of the expression, if possible
NodeInfo
getFirst()
Get the first node in the nodeset (in document order)
DocumentInfo
getRootNode()
Get the root (document) node
int
getType()
Return the type of the value
boolean
notEquals(Value other)
Test whether a nodeset "not-equals" another Value
void
outputStringValue(Outputter out, Context context)
Evaluate an expression as a String and write the result to the specified outputter.
Expression
simplify()
Simplify the expression

Methods inherited from class com.icl.saxon.expr.SingletonNodeSet

allowGeneralUse, asBoolean, asString, enumerate, equals, evaluate, evaluateAsNodeSet, getCount, getFirst, getLength, isGeneralUseAllowed, isSorted, item, notEquals, setSorted, simplify, sort

Methods inherited from class com.icl.saxon.expr.NodeSetValue

asBoolean, asNumber, asString, compare, conversionPreference, convertToJava, display, enumerate, enumerate, equals, evaluate, evaluateAsNodeSet, getCount, getDataType, getFirst, isSorted, notEquals, setSorted, sort

Methods inherited from class com.icl.saxon.expr.Value

asBoolean, asNumber, asString, compare, conversionPreference, convertToJava, equals, evaluate, getDependencies, inverse, notEquals, numericCompare, reduce, simplify, stringToNumber

Methods inherited from class com.icl.saxon.expr.Expression

containsReferences, display, enumerate, evaluate, evaluateAsBoolean, evaluateAsNodeSet, evaluateAsNumber, evaluateAsString, getDataType, getDependencies, getStaticContext, indent, isContextDocumentNodeSet, make, outputStringValue, reduce, setStaticContext, simplify, usesCurrent

Constructor Details

TextFragmentValue

public TextFragmentValue(String value,
                         String systemId,
                         Controller controller)
Constructor: create a result tree fragment containing a single text node

Parameters:

Method Details

asBoolean

public boolean asBoolean()
Convert the result tree fragment to a boolean
Overrides:
asBoolean in interface SingletonNodeSet

asNumber

public double asNumber()
Convert the result tree fragment to a number
Overrides:
asNumber in interface NodeSetValue

asString

public String asString()
Convert the result tree fragment to a string.
Overrides:
asString in interface SingletonNodeSet

compare

public boolean compare(int operator,
                       Value other)
            throws XPathException
Test how a FragmentValue compares to another Value under a relational comparison.
Overrides:
compare in interface NodeSetValue

copy

public void copy(Outputter out)
            throws TransformerException
Copy the result tree fragment value to a given Outputter

display

public void display(int level)
Diagnostic print of expression structure
Overrides:
display in interface NodeSetValue

enumerate

public NodeEnumeration enumerate()
            throws XPathException
Return an enumeration of this nodeset value.
Overrides:
enumerate in interface SingletonNodeSet

equals

public boolean equals(Value other)
            throws XPathException
Test whether a nodeset "equals" another Value
Overrides:
equals in interface SingletonNodeSet

getCount

public int getCount()
Count the nodes in the node-set.
Overrides:
getCount in interface SingletonNodeSet

getDataType

public int getDataType()
Determine the data type of the expression, if possible
Overrides:
getDataType in interface NodeSetValue

Returns:
Value.NODESET

getFirst

public NodeInfo getFirst()
Get the first node in the nodeset (in document order)
Overrides:
getFirst in interface SingletonNodeSet

Returns:
the first node

getRootNode

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

getType

public int getType()
Return the type of the value

Returns:
Value.NODESET (always)

notEquals

public boolean notEquals(Value other)
            throws XPathException
Test whether a nodeset "not-equals" another Value
Overrides:
notEquals in interface SingletonNodeSet

outputStringValue

public void outputStringValue(Outputter out,
                              Context context)
            throws TransformerException
Evaluate an expression as a String and write the result to the specified outputter.
Overrides:
outputStringValue in interface Expression

Parameters:
out - The required outputter
context - The context in which the expression is to be evaluated

simplify

public Expression simplify()
Simplify the expression
Overrides:
simplify in interface SingletonNodeSet

Overview Package Tree Index Deprecated About