IntegerRangeTest

java.lang.Object
- net.sf.saxon.expr.Expression
- - net.sf.saxon.expr.IntegerRangeTest

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, InstructionInfo, org.xml.sax.Locator
```
public class IntegerRangeTest
extends Expression
```
An IntegerRangeTest is an expression of the form E = N to M where E is numeric, and N and M are both expressions of type integer.

See Also:

Serialized Form

Field Summary
- Fields inherited from class net.sf.saxon.expr.Expression
  EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties

Constructor Summary

Constructors
Constructor Description

IntegerRangeTest(Expression value, Expression min, Expression max)
Construct a IntegerRangeTest

Constructors
Constructor	Description
`IntegerRangeTest(Expression value, Expression min, Expression max)`	Construct a IntegerRangeTest

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`computeCardinality()`	Determine the static cardinality
`Expression`	`copy()`	Copy an expression.
`Item`	`evaluateItem(XPathContext c)`	Evaluate the expression
`void`	`explain(ExpressionPresenter destination)`	Diagnostic print of expression structure.
`ItemType`	`getItemType(TypeHierarchy th)`	Get the data type of the items returned
`Expression`	`getMaxValueExpression()`	Get the expression denoting the end of the range
`Expression`	`getMinValueExpression()`	Get the expression denoting the start of the range
`Expression`	`getValueExpression()`	Get the value to be tested
`java.util.Iterator`	`iterateSubExpressions()`	Get the immediate sub-expressions of this expression.
`Expression`	`optimize(ExpressionVisitor visitor, ItemType contextItemType)`	Perform optimisation of an expression and its subexpressions.
`Expression`	`promote(PromotionOffer offer)`	Promote this expression if possible
`boolean`	`replaceSubExpression(Expression original, Expression replacement)`	Replace one subexpression by a replacement subexpression
`Expression`	`typeCheck(ExpressionVisitor visitor, ItemType contextItemType)`	Type-check the expression

Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeSpecialProperties, computeStaticProperties, display, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluatePendingUpdates, explain, findParentOf, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, implementsStaticTypeCheck, isUpdatingExpression, iterate, iterateEvents, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, simplify, staticTypeCheck, suppressValidation, toString, typeError

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IntegerRangeTest
```
public IntegerRangeTest(Expression value,
                        Expression min,
                        Expression max)
```
    Construct a IntegerRangeTest
    
    Parameters:
    
    value - the integer value to be tested to see if it is in the range min to max inclusive
    
    min - the lowest permitted value
    
    max - the highest permitted value
- Method Detail
  - getValueExpression
```
public Expression getValueExpression()
```
    Get the value to be tested
    
    Returns:
    
    the expression that evaluates to the value being tested
  - getMinValueExpression
```
public Expression getMinValueExpression()
```
    Get the expression denoting the start of the range
    
    Returns:
    
    the expression denoting the minumum value
  - getMaxValueExpression
```
public Expression getMaxValueExpression()
```
    Get the expression denoting the end of the range
    
    Returns:
    
    the expression denoting the maximum value
  - typeCheck
```
public Expression typeCheck(ExpressionVisitor visitor,
                            ItemType contextItemType)
                     throws XPathException
```
    Type-check the expression
    
    Overrides:
    
    typeCheck in class Expression
    
    Parameters:
    
    visitor - an expression visitor
    
    contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
    
    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)
  - optimize
```
public Expression optimize(ExpressionVisitor visitor,
                           ItemType contextItemType)
                    throws XPathException
```
    Perform optimisation of an expression and its subexpressions.
    
    This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.
    
    Overrides:
    
    optimize in class Expression
    
    Parameters:
    
    visitor - an expression visitor
    
    contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
    
    Returns:
    
    the original expression, rewritten if appropriate to optimize execution
    
    Throws:
    
    XPathException - if an error is discovered during this phase (typically a type error)
  - getItemType
```
public ItemType getItemType(TypeHierarchy th)
```
    Get the data type of the items returned
    
    Specified by:
    
    getItemType in class Expression
    
    Parameters:
    
    th - the type hierarchy cache
    
    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
    
    Specified by:
    
    computeCardinality in class Expression
    
    Returns:
    
    the computed cardinality, as one of the values StaticProperty.ALLOWS_ZERO_OR_ONE, StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE, StaticProperty.ALLOWS_ZERO_OR_MORE
  - copy
```
public Expression copy()
```
    Copy an expression. This makes a deep copy.
    
    Specified by:
    
    copy in class Expression
    
    Returns:
    
    the copy of the original expression
  - iterateSubExpressions
```
public java.util.Iterator iterateSubExpressions()
```
    Get the immediate sub-expressions of this expression. Default implementation returns a zero-length array, appropriate for an expression that has no sub-expressions.
    
    Overrides:
    
    iterateSubExpressions in class Expression
    
    Returns:
    
    an iterator containing the sub-expressions of this expression
  - replaceSubExpression
```
public boolean replaceSubExpression(Expression original,
                                    Expression replacement)
```
    Replace one subexpression by a replacement subexpression
    
    Overrides:
    
    replaceSubExpression in class Expression
    
    Parameters:
    
    original - the original subexpression
    
    replacement - the replacement subexpression
    
    Returns:
    
    true if the original subexpression is found
  - promote
```
public Expression promote(PromotionOffer offer)
                   throws XPathException
```
    Promote this expression if possible
    
    Overrides:
    
    promote in class Expression
    
    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
  - evaluateItem
```
public Item evaluateItem(XPathContext c)
                  throws XPathException
```
    Evaluate the expression
    
    Specified by:
    
    evaluateItem in interface EvaluableItem
    
    Overrides:
    
    evaluateItem in class Expression
    
    Parameters:
    
    c - The context in which the expression is to be evaluated
    
    Returns:
    
    the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
    
    Throws:
    
    XPathException - if any dynamic error occurs evaluating the expression
  - explain
```
public void explain(ExpressionPresenter destination)
```
    Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
    
    Specified by:
    
    explain in class Expression
    
    Parameters:
    
    destination - the expression presenter used to display the structure

Class IntegerRangeTest

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

IntegerRangeTest

Method Detail

getValueExpression

getMinValueExpression

getMaxValueExpression

typeCheck

optimize

getItemType

computeCardinality

copy

iterateSubExpressions

replaceSubExpression

promote

evaluateItem

explain