|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.value.Value<T> net.sf.saxon.value.Closure net.sf.saxon.value.SingletonClosure
public class SingletonClosure
A SingletonClosure represents a value that has not yet been evaluated: the value is represented by an expression, together with saved values of all the context variables that the expression depends on. The value of a SingletonClosure is always either a single item or an empty sequence.
The expression may depend on local variables and on the context item; these values are held in the saved XPathContext object that is kept as part of the Closure, and they will always be read from that object. The expression may also depend on global variables; these are unchanging, so they can be read from the Bindery in the normal way. Expressions that depend on other contextual information, for example the values of position(), last(), current(), current-group(), should not be evaluated using this mechanism: they should always be evaluated eagerly. This means that the Closure does not need to keep a copy of these context variables.
Field Summary |
---|
Fields inherited from class net.sf.saxon.value.Closure |
---|
depth, expression, inputIterator, savedXPathContext |
Fields inherited from class net.sf.saxon.value.Value |
---|
INDETERMINATE_ORDERING |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
---|
EMPTY_VALUE_ARRAY |
Constructor Summary | |
---|---|
SingletonClosure(Expression exp,
XPathContext context)
Constructor should not be called directly, instances should be made using the make() method. |
Method Summary | |
---|---|
Item |
asItem()
Return the value in the form of an Item |
int |
getLength()
Get the length of the sequence |
Item |
itemAt(int n)
Get the n'th item in the sequence (starting from 0). |
SequenceIterator |
iterate()
Evaluate the expression in a given context to return an iterator over a sequence |
Value |
materialize()
Return a value containing all the items in the sequence returned by this SequenceIterator |
void |
process(XPathContext context)
Process the expression by writing the value to the current Receiver |
Methods inherited from class net.sf.saxon.value.Closure |
---|
getCardinality, getExpression, getItemType, getSavedXPathContext, make, makeIteratorClosure, reduce, saveContext, setExpression, setSavedXPathContext |
Methods inherited from class net.sf.saxon.value.Value |
---|
asItem, asIterator, asValue, checkPermittedContents, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getIterator, getSchemaComparable, getSequenceLength, getStringValue, getStringValueCS, hashCode, isIdentical |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SingletonClosure(Expression exp, XPathContext context) throws XPathException
exp
- the expression to be lazily evaluatedcontext
- the context in which the expression should be evaluated
XPathException
Method Detail |
---|
public SequenceIterator iterate() throws XPathException
iterate
in class Closure
XPathException
- if a dynamic error occurs. This is possible only in the case of values
that are materialized lazily, that is, where the iterate() method leads to computation of an
expression that delivers the values.public void process(XPathContext context) throws XPathException
process
in class Closure
context
- The dynamic context, giving access to the current node,
the current variables, etc.
XPathException
- if an error occurs (for example if the value is
a closure that needs to be evaluated)public Item asItem() throws XPathException
asItem
in class Value
XPathException
- if an error occurs, notably if this value is a sequence
containing more than one itempublic Item itemAt(int n) throws XPathException
itemAt
in class Value
n
- position of the required item, counting from zero.
XPathException
- if an error occurs (for example if the
value is a Closure that needs to be evaluated to find the Nth item)public int getLength() throws XPathException
getLength
in class Value
XPathException
- if an error occurs (for example if the value is
a closure that needs to be read to determine its length)public Value materialize() throws XPathException
XPathException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |