net.sf.saxon.expr
Class RangeExpression

java.lang.Object
  |
  +--net.sf.saxon.expr.ComputedExpression
        |
        +--net.sf.saxon.expr.BinaryExpression
              |
              +--net.sf.saxon.expr.RangeExpression

All Implemented Interfaces:

Expression, java.io.Serializable

public class RangeExpression

extends net.sf.saxon.expr.BinaryExpression

A RangeExpression is an expression that represents an integer sequence as a pair of end-points (for example "x to y"). If the end-points are equal, the sequence is of length one.

From Saxon 7.8, the sequence must be ascending; if the end-point is less than the start-point, an empty sequence is returned. This is to allow expressions of the form "for $i in 1 to count($seq) return ...."

See Also:

Serialized Form

Field Summary
protected  Expression[]	operands
protected  int	operator

 

Fields inherited from class net.sf.saxon.expr.ComputedExpression

lineNumber, NO_ARGUMENTS, staticProperties

 

Constructor Summary

RangeExpression(Expression start, int op, Expression end)           Construct a RangeExpression

 

Method Summary
Expression	analyze(StaticContext env)           Type-check the expression
int	computeCardinality()           Determine the static cardinality
void	display(int level, NamePool pool)           Diagnostic print of expression structure
protected  java.lang.String	displayOperator()
boolean	equals(java.lang.Object other)           Is this expression the same as another expression?
ItemType	getItemType()           Get the data type of the items returned
Expression[]	getSubExpressions()           Get the immediate subexpressions of this expression
int	hashCode()           get HashCode for comparing two expressions.
protected static boolean	isCommutative(int operator)
SequenceIterator	iterate(XPathContext context)           Return an iteration over the sequence
Expression	promote(PromotionOffer offer)           Promote this expression if possible
void	setDetails(Expression p1, int op, Expression p2)           Identify the two operands and the operator (for use when the default constructor was used)
Expression	simplify()           Simplify an expression

 

Methods inherited from class net.sf.saxon.expr.ComputedExpression

computeDependencies, computeSpecialProperties, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getDependencies, getIntrinsicDependencies, getLineNumber, getSourceLocator, getSpecialProperties, markTailFunctionCalls, setLineNumber, typeError

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

operands

protected Expression[] operands

operator

protected int operator

RangeExpression

public RangeExpression(Expression start,
                       int op,
                       Expression end)

Construct a RangeExpression

analyze

public Expression analyze(StaticContext env)
                   throws XPathException

Type-check the expression

Specified by:

analyze in interface Expression

Overrides:

analyze in class net.sf.saxon.expr.BinaryExpression

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

XPathException

getItemType

public ItemType getItemType()

Get the data type of the items returned

Returns:

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

computeCardinality

public int computeCardinality()

Determine the static cardinality

Overrides:

computeCardinality in class net.sf.saxon.expr.BinaryExpression

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Return an iteration over the sequence

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

setDetails

public void setDetails(Expression p1,
                       int op,
                       Expression p2)

Identify the two operands and the operator (for use when the default constructor was used)

Parameters:

p1 - the left-hand operand

op - the operator, as a token returned by the Tokenizer (e.g. Tokenizer.AND)

p2 - the right-hand operand

simplify

public Expression simplify()
                    throws XPathException

Simplify an expression

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

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

getSubExpressions

public Expression[] getSubExpressions()

Get the immediate subexpressions of this expression

Specified by:

getSubExpressions in interface Expression

Overrides:

getSubExpressions in class ComputedExpression

Returns:

an array containing the sub-expressions of this expression

isCommutative

protected static boolean isCommutative(int operator)

equals

public boolean equals(java.lang.Object other)

Is this expression the same as another expression?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

get HashCode for comparing two expressions. Note that this hashcode gives the same result for (A op B) and for (B op A), whether or not the operator is commutative.

Overrides:

hashCode in class java.lang.Object

display

public void display(int level,
                    NamePool pool)

Diagnostic print of expression structure

Parameters:

level - indentation level for this expression

displayOperator

protected java.lang.String displayOperator()