net.sf.saxon.expr
Class CompareToIntegerConstant
- ComparisonExpression, EvaluableItem, InstructionInfoProvider, SequenceIterable, Serializable, SourceLocator
public class CompareToIntegerConstant
This class implements a comparison of a numeric value to an integer constant using one of the operators
eq, ne, lt, gt, le, ge. The semantics are identical to ValueComparison, but this is a fast path for an
important common case.
protected int | computeCardinality() - Compute the static cardinality of this expression
|
int | computeDependencies() - Compute the dependencies of an expression, as the union of the
dependencies of its subexpressions.
|
int | computeSpecialProperties() - Compute the special properties of this expression.
|
boolean | convertsUntypedToOther() - Determine whether untyped atomic values should be converted to the type of the other operand
|
Expression | copy() - Copy an expression.
|
boolean | effectiveBooleanValue(XPathContext context) - Get the effective boolean value of the expression.
|
Item | evaluateItem(XPathContext context) - Evaluate an expression as a single item.
|
void | explain(ExpressionPresenter destination) - Diagnostic print of expression structure.
|
AtomicComparer | getAtomicComparer() - Get the AtomicComparer used to compare atomic values.
|
long | getComparand() - Get the integer value on the rhs of the expression
|
int | getComparisonOperator() - Get the comparison operator
|
int | getImplementationMethod() - An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
|
ItemType | getItemType(TypeHierarchy th) - Determine the data type of the expression, if possible.
|
Expression | getOperand() - Get the expression on the lhs of the comparison
|
Expression[] | getOperands() - Get the two operands of the comparison
|
int | getSingletonOperator() - Get the primitive (singleton) operator used: one of Token.FEQ, Token.FNE, Token.FLT, Token.FGT,
Token.FLE, Token.FGE
|
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) - Offer promotion for this subexpression.
|
boolean | replaceSubExpression(Expression original, Expression replacement) - Replace one subexpression by a replacement subexpression
|
Expression | simplify(ExpressionVisitor visitor) - Simplify an expression.
|
Expression | typeCheck(ExpressionVisitor visitor, ItemType contextItemType) - Perform type checking of an expression and its subexpressions.
|
addToPathMap , adoptChildExpression , checkPermittedContents , computeCardinality , computeDependencies , computeSpecialProperties , computeStaticProperties , copy , display , doPromotion , dynamicError , effectiveBooleanValue , evaluateAsString , evaluateItem , explain , explain , findParentOf , getCardinality , getColumnNumber , getConstructType , getContainer , getDependencies , getExecutable , getHostLanguage , getImplementationMethod , getInstructionInfo , getIntrinsicDependencies , getItemType , getLineNumber , getLocationId , getLocationProvider , getPublicId , getSlotsUsed , getSpecialProperties , getSystemId , hasLoopingSubexpression , implementsStaticTypeCheck , iterate , iterateEvents , iterateSubExpressions , markTailFunctionCalls , optimize , process , promote , replaceSubExpression , resetLocalStaticProperties , setContainer , setFiltered , setFlattened , setLocationId , simplify , staticTypeCheck , suppressValidation , toString , typeCheck , typeError |
CompareToIntegerConstant
public CompareToIntegerConstant(Expression operand,
int operator,
long comparand)
Create the expression
computeCardinality
protected int computeCardinality()
Compute the static cardinality of this expression
- computeCardinality in interface Expression
computeDependencies
public int computeDependencies()
Compute the dependencies of an expression, as the union of the
dependencies of its subexpressions. (This is overridden for path expressions
and filter expressions, where the dependencies of a subexpression are not all
propogated). This method should be called only once, to compute the dependencies;
after that, getDependencies should be used.
- computeDependencies in interface Expression
- the depencies, as a bit-mask
computeSpecialProperties
public int computeSpecialProperties()
Compute the special properties of this expression. These properties are denoted by a bit-significant
integer, possible values are in class
StaticProperty
. The "special" properties are properties
other than cardinality and dependencies, and most of them relate to properties of node sequences, for
example whether the nodes are in document order.
- computeSpecialProperties in interface Expression
- the special properties, as a bit-significant integer
convertsUntypedToOther
public boolean convertsUntypedToOther()
Determine whether untyped atomic values should be converted to the type of the other operand
- convertsUntypedToOther in interface ComparisonExpression
- true if untyped values should be converted to the type of the other operand, false if they
should be converted to strings.
copy
public Expression copy()
Copy an expression. This makes a deep copy.
- copy in interface Expression
- the copy of the original expression
effectiveBooleanValue
public boolean effectiveBooleanValue(XPathContext context)
throws XPathException
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.
- effectiveBooleanValue in interface Expression
context
- The context in which the expression is to be evaluated
- the effective boolean value
XPathException
- if any dynamic error occurs evaluating the
expression
evaluateItem
public Item evaluateItem(XPathContext context)
throws XPathException
Evaluate an expression as a single item. This always returns either a single Item or
null (denoting the empty sequence). No conversion is done. This method should not be
used unless the static type of the expression is a subtype of "item" or "item?": that is,
it should not be called if the expression may return a sequence. There is no guarantee that
this condition will be detected.
- evaluateItem in interface EvaluableItem
- evaluateItem in interface Expression
context
- The context in which the expression is to be evaluated
- the node or atomic value that results from evaluating the
expression; or null to indicate that the result is an empty
sequence
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.
- explain in interface Expression
getComparand
public long getComparand()
Get the integer value on the rhs of the expression
getComparisonOperator
public int getComparisonOperator()
Get the comparison operator
getImplementationMethod
public int getImplementationMethod()
An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process().
This method indicates which of these methods is provided directly. The other methods will always be available
indirectly, using an implementation that relies on one of the other methods.
- getImplementationMethod in interface Expression
getItemType
public ItemType getItemType(TypeHierarchy th)
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.
- getItemType in interface Expression
th
- the type hierarchy cache
- a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER,
Type.NODE, or Type.ITEM (meaning not known at compile time)
getOperand
public Expression getOperand()
Get the expression on the lhs of the comparison
getSingletonOperator
public int getSingletonOperator()
Get the primitive (singleton) operator used: one of Token.FEQ, Token.FNE, Token.FLT, Token.FGT,
Token.FLE, Token.FGE
- getSingletonOperator in interface ComparisonExpression
iterateSubExpressions
public 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.
- iterateSubExpressions in interface Expression
- an iterator containing the sub-expressions of this expression
optimize
public Expression optimize(ExpressionVisitor visitor,
ItemType contextItemType)
throws XPathException
Perform optimisation of an expression and its subexpressions. This is the third and final
phase of static optimization.
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.
- optimize in interface Expression
visitor
- the 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 to
Type.ITEM_TYPE
- the original expression, rewritten if appropriate to optimize execution
XPathException
- if an error is discovered during this phase
(typically a type error)
promote
public Expression promote(PromotionOffer offer)
throws XPathException
Offer promotion for this subexpression. The offer will be accepted if the subexpression
is not dependent on the factors (e.g. the context item) identified in the PromotionOffer.
By default the offer is not accepted - this is appropriate in the case of simple expressions
such as constant values and variable references where promotion would give no performance
advantage. This method is always called at compile time.
- promote in interface Expression
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
- if the offer is not accepted, return this expression unchanged.
Otherwise return the result of rewriting the expression to promote
this subexpression
replaceSubExpression
public boolean replaceSubExpression(Expression original,
Expression replacement)
Replace one subexpression by a replacement subexpression
- replaceSubExpression in interface Expression
original
- the original subexpressionreplacement
- the replacement subexpression
- true if the original subexpression is found
simplify
public Expression simplify(ExpressionVisitor visitor)
throws XPathException
Simplify an expression. This performs any static optimization (by rewriting the expression
as a different expression). The default implementation does nothing.
- simplify in interface Expression
visitor
- the expression visitor
- the simplified expression
XPathException
- if an error is discovered during expression
rewriting
typeCheck
public Expression typeCheck(ExpressionVisitor visitor,
ItemType contextItemType)
throws XPathException
Perform type checking of an expression and its subexpressions. This is the second phase of
static optimization.
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 may not be accurately known if they have not been explicitly declared.
If the implementation returns a value other than "this", then it is required to ensure that
the parent pointer and location information in the returned expression have been set up correctly.
It should not rely on the caller to do this, although for historical reasons many callers do so.
- typeCheck in interface Expression
visitor
- the expession 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 to
Type.ITEM_TYPE
- the original expression, rewritten to perform necessary run-time type checks,
and to perform other type-related optimizations
XPathException
- if an error is discovered during this phase
(typically a type error)