net.sf.saxon.sort
Class Reverser

java.lang.Object
  extended by net.sf.saxon.expr.ComputedExpression
      extended by net.sf.saxon.sort.Reverser
All Implemented Interfaces:
Serializable, Expression

public class Reverser
extends ComputedExpression

A Reverser is an expression that reverses the order of a sequence of items.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.expr.ComputedExpression
lineNumber, NO_ARGUMENTS, staticProperties
 
Constructor Summary
Reverser(Expression base)
           
 
Method Summary
 Expression analyze(StaticContext env)
          Perform static analysis of an expression and its subexpressions.
 int computeCardinality()
           
 int computeSpecialProperties()
           
 void display(int level, NamePool pool)
          Diagnostic print of expression structure.
 boolean effectiveBooleanValue(XPathContext context)
          Get the effective boolean value of the expression.
 Expression getBaseExpression()
           
 ItemType getItemType()
          Determine the data type of the expression, if possible.
 Expression[] getSubExpressions()
          Get the immediate sub-expressions of this expression.
 SequenceIterator iterate(XPathContext context)
          Return an Iterator to iterate over the values of a sequence.
 Expression promote(PromotionOffer offer)
          Promote this expression if possible
 Expression simplify()
          Simplify an expression.
 
Methods inherited from class net.sf.saxon.expr.ComputedExpression
computeDependencies, computeStaticProperties, dynamicError, evaluateAsString, evaluateItem, getCardinality, getDependencies, getIntrinsicDependencies, getLineNumber, getSpecialProperties, markTailFunctionCalls, setLineNumber, typeError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Reverser

public Reverser(Expression base)
Method Detail

getBaseExpression

public Expression getBaseExpression()

simplify

public Expression simplify()
                    throws XPathException
Description copied from class: ComputedExpression
Simplify an expression. This performs any static optimization (by rewriting the expression as a different expression). The default implementation does nothing.

Specified by:
simplify in interface Expression
Overrides:
simplify in class ComputedExpression
Returns:
the simplified expression
Throws:
XPathException - if an error is discovered during expression rewriting

analyze

public Expression analyze(StaticContext env)
                   throws XPathException
Description copied from interface: Expression
Perform static analysis of an expression and its subexpressions.

This checks statically that the operands of the expression have the correct type; if necessary it generates code to do run-time type checking or type conversion. A static type error is reported only if execution cannot possibly succeed, that is, if a run-time type error is inevitable. The call may return a modified form of the expression.

This method is called after all references to functions and variables have been resolved to the declaration of the function or variable. However, the types of such functions and variables will only be accurately known if they have been explicitly declared.

Parameters:
env - the static context of the expression
Returns:
the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
Throws:
XPathException - if an error is discovered during this phase (typically a type error)

getItemType

public ItemType getItemType()
Description copied from interface: Expression
Determine the data type of the expression, if possible. All expression return sequences, in general; this method determines the type of the items within the sequence, assuming that (a) this is known in advance, and (b) it is the same for all items in the sequence.

This method should always return a result, though it may be the best approximation that is available at the time.

Returns:
a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known at compile time)

computeSpecialProperties

public int computeSpecialProperties()
Overrides:
computeSpecialProperties in class ComputedExpression

computeCardinality

public int computeCardinality()
Specified by:
computeCardinality in class ComputedExpression

getSubExpressions

public Expression[] getSubExpressions()
Description copied from class: ComputedExpression
Get the immediate sub-expressions of this expression. Default implementation returns a zero-length array, appropriate for an expression that has no sub-expressions.

Specified by:
getSubExpressions in interface Expression
Overrides:
getSubExpressions in class ComputedExpression
Returns:
an array containing the sub-expressions of this expression

promote

public Expression promote(PromotionOffer offer)
                   throws XPathException
Promote this expression if possible

Specified by:
promote in interface Expression
Overrides:
promote in class ComputedExpression
Parameters:
offer - details of the offer, for example the offer to move expressions that don't depend on the context to an outer level in the containing expression
Returns:
if the offer is not accepted, return this expression unchanged. Otherwise return the result of rewriting the expression to promote this subexpression
Throws:
XPathException - if any error is detected

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException
Description copied from class: ComputedExpression
Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.

Specified by:
iterate in interface Expression
Overrides:
iterate in class ComputedExpression
Parameters:
context - supplies the context for evaluation
Returns:
a SequenceIterator that can be used to iterate over the result of the expression
Throws:
XPathException - if any dynamic error occurs evaluating the expression

effectiveBooleanValue

public boolean effectiveBooleanValue(XPathContext context)
                              throws XPathException
Description copied from class: ComputedExpression
Get the effective boolean value of the expression. This returns false if the value is the empty sequence, a zero-length string, a number equal to zero, or the boolean false. Otherwise it returns true.

Specified by:
effectiveBooleanValue in interface Expression
Overrides:
effectiveBooleanValue in class ComputedExpression
Parameters:
context - The context in which the expression is to be evaluated
Returns:
the effective boolean value
Throws:
XPathException - if any dynamic error occurs evaluating the expression

display

public void display(int level,
                    NamePool pool)
Description copied from interface: Expression
Diagnostic print of expression structure. The expression is written to the System.err output stream

Parameters:
level - indentation level for this expression