Package net.sf.saxon.expr
Class IntegerRangeTest
java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.IntegerRangeTest
- All Implemented Interfaces:
Serializable
,SourceLocator
,LocationProvider
,SaxonLocator
,EvaluableItem
,SequenceIterable
,InstructionInfo
,Locator
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:
-
Field Summary
Fields inherited from class net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties
-
Constructor Summary
ConstructorsConstructorDescriptionIntegerRangeTest
(Expression value, Expression min, Expression max) Construct a IntegerRangeTest -
Method Summary
Modifier and TypeMethodDescriptionint
Determine the static cardinalitycopy()
Copy an expression.Evaluate the expressionvoid
explain
(ExpressionPresenter destination) Diagnostic print of expression structure.Get the data type of the items returnedGet the expression denoting the end of the rangeGet the expression denoting the start of the rangeGet the value to be testedGet the immediate sub-expressions of this expression.optimize
(ExpressionVisitor visitor, ItemType contextItemType) Perform optimisation of an expression and its subexpressions.promote
(PromotionOffer offer) Promote this expression if possibleboolean
replaceSubExpression
(Expression original, Expression replacement) Replace one subexpression by a replacement subexpressiontypeCheck
(ExpressionVisitor visitor, ItemType contextItemType) Type-check the expressionMethods 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
-
Constructor Details
-
IntegerRangeTest
Construct a IntegerRangeTest- Parameters:
value
- the integer value to be tested to see if it is in the range min to max inclusivemin
- the lowest permitted valuemax
- the highest permitted value
-
-
Method Details
-
getValueExpression
Get the value to be tested- Returns:
- the expression that evaluates to the value being tested
-
getMinValueExpression
Get the expression denoting the start of the range- Returns:
- the expression denoting the minumum value
-
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 classExpression
- Parameters:
visitor
- an expression visitorcontextItemType
- 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 toType.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 classExpression
- Parameters:
visitor
- an expression visitorcontextItemType
- 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 toType.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
Get the data type of the items returned- Specified by:
getItemType
in classExpression
- 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 classExpression
- 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
Copy an expression. This makes a deep copy.- Specified by:
copy
in classExpression
- Returns:
- the copy of the original expression
-
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 classExpression
- Returns:
- an iterator containing the sub-expressions of this expression
-
replaceSubExpression
Replace one subexpression by a replacement subexpression- Overrides:
replaceSubExpression
in classExpression
- Parameters:
original
- the original subexpressionreplacement
- the replacement subexpression- Returns:
- true if the original subexpression is found
-
promote
Promote this expression if possible- Overrides:
promote
in classExpression
- 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
Evaluate the expression- Specified by:
evaluateItem
in interfaceEvaluableItem
- Overrides:
evaluateItem
in classExpression
- 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
Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.- Specified by:
explain
in classExpression
- Parameters:
destination
- the expression presenter used to display the structure
-