com.saxonica.ee.optim

Class IndexedFilterExpression

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.BinaryExpression

com.saxonica.ee.optim.IndexedFilterExpression

All Implemented Interfaces:

ContextOriginator, ContextSwitchingExpression, IdentityComparable

public final class IndexedFilterExpression
extends BinaryExpression
implements ContextSwitchingExpression

An IndexedFilterExpression contains a base expression and a filter predicate. The base expression will always be a local variable reference. The filter will always be a Comparison, and it will have no positional dependencies

Field Summary

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

operator

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

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD

Constructor Summary

Constructors

Constructor and Description
IndexedFilterExpression(VariableReference start, ComparisonExpression filter, boolean indexFirstOperand) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	computeCardinality() Get the static cardinality of this expression
int	computeDependencies() Determine which aspects of the context the expression depends on.
int	computeSpecialProperties() Get the static properties of this expression (other than its type).
Expression	copy() Copy an expression.
boolean	equals(Object other) Is this expression the same as another expression?
void	export(ExpressionPresenter out) Diagnostic print of expression structure.
Expression	getActionExpression() Get the subexpression that is evaluated in the new context
VariableReference	getBaseExpression() Get the underlying expression
ExpressionCompiler	getExpressionCompiler() Return the compiler of the IndexedFilter expression
ComparisonExpression	getFilter() Get the filter expression
ItemType	getItemType() Get the data type of the items returned
protected OperandRole	getOperandRole(int arg) Get the operand role
Expression	getSearchExpression() Get the expression whose value we will be searching for
Expression	getSelectExpression() Get the subexpression that sets the context item
VariableReference	getStart()
Expression	getUseExpression() Get the expression to be indexed
int	hashCode() get HashCode for comparing two expressions
SequenceIterator	iterate(XPathContext context) Iterate over the results, returning them in the correct order
Expression	optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Perform optimisation of an expression and its subexpressions.
Expression	promote(PromotionOffer offer) Promote this expression if possible
void	setFilter(ComparisonExpression filter)
void	setStart(VariableReference start)
String	toShortString() Produce a short string identifying the expression for use in error messages
String	toString() Represent the expression as a string.
Expression	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) Type-check the expression

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

displayOperator, explainExtraAttributes, getImplementationMethod, getLhs, getLhsExpression, getOperator, getRhs, getRhsExpression, isAssociative, isCommutative, isInverse, operands, setFlattened, setLhsExpression, setRhsExpression, tag

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

addToPathMap, adoptChildExpression, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getConstructType, getCost, getDependencies, getEvaluationMethod, getExpressionName, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLocation, getNetCost, getObjectName, getPackageData, getParentExpression, getPosture, getPostureAndSweepIfKnown, getProperties, getProperty, getRetainedStaticContext, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStreamability, getStreamingAdjunct, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterateEvents, makeStreamingAdjunct, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, optimizeForType, process, promoteChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setFiltered, setLocation, setParentExpression, setPostureAndSweep, setRetainedStaticContext, setRetainedStaticContextLocally, setStaticProperty, simplify, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toStreamingPattern, typeCheckChildren, typeError, unordered

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedFilterExpression

public IndexedFilterExpression(VariableReference start,
                       ComparisonExpression filter,
                       boolean indexFirstOperand)

Constructor

Parameters:

start - Variable containing the sequence of items from which the selection will take place.

filter - An expression defining the filter predicate

indexFirstOperand - true if the first operand of the filter comparison is to be indexed, false if the second operand is to be indexed

Method Detail

getOperandRole

protected OperandRole getOperandRole(int arg)

Description copied from class: BinaryExpression

Get the operand role

Overrides:

getOperandRole in class BinaryExpression

Parameters:

arg - which argument: 0 for the lhs, 1 for the rhs

Returns:

the operand role

getItemType

public ItemType getItemType()

Get the data type of the items returned

Specified by:

getItemType in class Expression

Returns:

an integer representing the data type

getBaseExpression

public VariableReference getBaseExpression()

Get the underlying expression

Returns:

the expression being filtered

getFilter

public ComparisonExpression getFilter()

Get the filter expression

Returns:

the expression acting as the filter predicate

getSelectExpression

public Expression getSelectExpression()

Get the subexpression that sets the context item

Specified by:

getSelectExpression in interface ContextSwitchingExpression

Returns:

the subexpression that sets the context item, position, and size to each of its items in turn

getActionExpression

public Expression getActionExpression()

Get the subexpression that is evaluated in the new context

Specified by:

getActionExpression in interface ContextSwitchingExpression

Returns:

the subexpression evaluated in the context set by the controlling expression

getUseExpression

public Expression getUseExpression()

Get the expression to be indexed

Returns:

the "use" expression, the expression that computes the index key for each item in the population

getSearchExpression

public Expression getSearchExpression()

Get the expression whose value we will be searching for

Returns:

the search expression

typeCheck

public Expression typeCheck(ExpressionVisitor visitor,
                   ContextItemStaticInfo contextInfo)
                     throws XPathException

Type-check the expression

Overrides:

typeCheck in class BinaryExpression

Parameters:

visitor - an expression visitor

contextInfo - information about the static type of the context item

Returns:

the expression after type-checking (potentially modified to add run-time checks and/or conversions)

Throws:

XPathException - if an error is discovered during this phase (typically a type error)

optimize

public Expression optimize(ExpressionVisitor visitor,
                  ContextItemStaticInfo contextItemType)

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 BinaryExpression

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

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

promote

public Expression promote(PromotionOffer offer)
                   throws XPathException

Promote this expression if possible

Overrides:

promote in class Expression

Parameters:

offer - details of the promotion that is possible

Returns:

the promoted expression (or the original expression, unchanged)

Throws:

XPathException - if any error is detected

computeCardinality

public int computeCardinality()

Get the static cardinality of this expression

Overrides:

computeCardinality in class BinaryExpression

Returns:

the cardinality. The method attempts to determine the case where the filter predicate is guaranteed to select at most one item from the sequence being filtered

computeSpecialProperties

public int computeSpecialProperties()

Get the static properties of this expression (other than its type). The result is bit-significant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.

Overrides:

computeSpecialProperties in class BinaryExpression

Returns:

the static properties of the expression, as a bit-significant value

equals

public boolean equals(Object other)

Is this expression the same as another expression?

Overrides:

equals in class BinaryExpression

Parameters:

other - the expression to be compared with this one

Returns:

true if the two expressions are statically equivalent

hashCode

public int hashCode()

get HashCode for comparing two expressions

Overrides:

hashCode in class BinaryExpression

Returns:

the hash code

iterate

public SequenceIterator iterate(XPathContext context)
                         throws XPathException

Iterate over the results, returning them in the correct order

Overrides:

iterate in class Expression

Parameters:

context - the dynamic context for the evaluation

Returns:

an iterator over the expression results

Throws:

XPathException - if any dynamic error occurs

computeDependencies

public int computeDependencies()

Determine which aspects of the context the expression depends on. The result is a bitwise-or'ed value composed from constants such as XPathContext.VARIABLES and XPathContext.CURRENT_NODE

Overrides:

computeDependencies in class Expression

Returns:

the dependencies

getExpressionCompiler

public ExpressionCompiler getExpressionCompiler()

Return the compiler of the IndexedFilter expression

Overrides:

getExpressionCompiler in class Expression

Returns:

the relevant ExpressionCompiler

export

public void export(ExpressionPresenter out)

Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

Overrides:

export in class BinaryExpression

Parameters:

out - the output destination for the displayed expression tree

getStart

public VariableReference getStart()

setStart

public void setStart(VariableReference start)

setFilter

public void setFilter(ComparisonExpression filter)

toString

public String toString()

Description copied from class: BinaryExpression

Represent the expression as a string. The resulting string will be a valid XPath 3.0 expression with no dependencies on namespace bindings other than the binding of the prefix "xs" to the XML Schema namespace.

Overrides:

toString in class BinaryExpression

Returns:

the expression as a string in XPath 3.0 syntax

toShortString

public String toShortString()

Description copied from class: Expression

Produce a short string identifying the expression for use in error messages

Overrides:

toShortString in class BinaryExpression

Returns:

a short string, sufficient to identify the expression