Package net.sf.saxon.expr
Class FilterExpression
- java.lang.Object
-
- net.sf.saxon.expr.ComputedExpression
-
- net.sf.saxon.expr.FilterExpression
-
- All Implemented Interfaces:
java.io.Serializable
,javax.xml.transform.SourceLocator
,Container
,Expression
,InstructionInfoProvider
public final class FilterExpression extends ComputedExpression
A FilterExpression contains a base expression and a filter predicate, which may be an integer expression (positional filter), or a boolean expression (qualifier)- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.expr.ComputedExpression
locationId, staticProperties
-
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
-
Constructor Summary
Constructors Constructor Description FilterExpression(Expression start, Expression filter)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
computeCardinality()
Get the static cardinality of this expressionint
computeDependencies()
Determine which aspects of the context the expression depends on.int
computeSpecialProperties()
Get the static properties of this expression (other than its type).void
display(int level, java.io.PrintStream out, Configuration config)
Diagnostic print of expression structureboolean
equals(java.lang.Object other)
Is this expression the same as another expression?Expression
getBaseExpression()
Get the underlying expressionExpression
getFilter()
Get the filter expressionItemType
getItemType(TypeHierarchy th)
Get the data type of the items returnedint
hashCode()
get HashCode for comparing two expressionsboolean
isIndexable()
Test whether the filter is amenable to indexingboolean
isPositional(TypeHierarchy th)
Determine if the filter is positionalSequenceIterator
iterate(XPathContext context)
Iterate over the results, returning them in the correct orderjava.util.Iterator
iterateSubExpressions()
Get the immediate subexpressions of this expressionExpression
optimize(Optimizer opt, StaticContext env, ItemType contextItemType)
Perform optimisation of an expression and its subexpressions.Expression
promote(PromotionOffer offer)
Promote this expression if possibleboolean
replaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpressionExpression
simplify(StaticContext env)
Simplify an expressionExpression
typeCheck(StaticContext env, ItemType contextItemType)
Type-check the expression-
Methods inherited from class net.sf.saxon.expr.ComputedExpression
adoptChildExpression, checkPermittedContents, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError
-
-
-
-
Constructor Detail
-
FilterExpression
public FilterExpression(Expression start, Expression filter)
Constructor- Parameters:
start
- A node-set expression denoting the absolute or relative set of nodes from which the navigation path should start.filter
- An expression defining the filter predicate
-
-
Method Detail
-
getItemType
public ItemType getItemType(TypeHierarchy th)
Get the data type of the items returned- Parameters:
th
-- Returns:
- an integer representing the data type
-
getBaseExpression
public Expression getBaseExpression()
Get the underlying expression- Returns:
- the expression being filtered
-
getFilter
public Expression getFilter()
Get the filter expression- Returns:
- the expression acting as the filter predicate
-
isPositional
public boolean isPositional(TypeHierarchy th)
Determine if the filter is positional- Parameters:
th
- the Type Hierarchy (for cached access to type information)- Returns:
- true if the value of the filter depends on the position of the item against which it is evaluated
-
simplify
public Expression simplify(StaticContext env) throws XPathException
Simplify an expression- Specified by:
simplify
in interfaceExpression
- Overrides:
simplify
in classComputedExpression
- Parameters:
env
- the static context- Returns:
- the simplified expression
- Throws:
XPathException
- if any failure occurs
-
typeCheck
public Expression typeCheck(StaticContext env, ItemType contextItemType) throws XPathException
Type-check the expression- Parameters:
env
- the static contextcontextItemType
- 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 expression after type-checking (potentially modified to add run-time checks and/or conversions)
- Throws:
StaticError
- if an error is discovered during this phase (typically a type error)XPathException
-
optimize
public Expression optimize(Optimizer opt, StaticContext env, 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.
- Parameters:
opt
- the optimizer in use. This provides access to supporting functions; it also allows different optimization strategies to be used in different circumstances.env
- the static context of the expressioncontextItemType
- 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:
StaticError
- if an error is discovered during this phase (typically a type error)XPathException
-
promote
public Expression promote(PromotionOffer offer) throws XPathException
Promote this expression if possible- Specified by:
promote
in interfaceExpression
- Overrides:
promote
in classComputedExpression
- 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
-
iterateSubExpressions
public java.util.Iterator iterateSubExpressions()
Get the immediate subexpressions of this expression- Specified by:
iterateSubExpressions
in interfaceExpression
- Overrides:
iterateSubExpressions
in classComputedExpression
- Returns:
- the subexpressions, as an array
-
replaceSubExpression
public boolean replaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression- Specified by:
replaceSubExpression
in interfaceContainer
- Overrides:
replaceSubExpression
in classComputedExpression
- Parameters:
original
- the original subexpressionreplacement
- the replacement subexpression- Returns:
- true if the original subexpression is found
-
computeCardinality
public int computeCardinality()
Get the static cardinality of this expression- Specified by:
computeCardinality
in classComputedExpression
- 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 classComputedExpression
- Returns:
- the static properties of the expression, as a bit-significant value
-
equals
public boolean equals(java.lang.Object other)
Is this expression the same as another expression?- Overrides:
equals
in classjava.lang.Object
- 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 classjava.lang.Object
- Returns:
- the hash code
-
iterate
public SequenceIterator iterate(XPathContext context) throws XPathException
Iterate over the results, returning them in the correct order- Specified by:
iterate
in interfaceExpression
- Overrides:
iterate
in classComputedExpression
- Parameters:
context
- the dynamic context for the evaluation- Returns:
- an iterator over the expression results
- Throws:
XPathException
- if any dynamic error occurs
-
isIndexable
public boolean isIndexable()
Test whether the filter is amenable to indexing
-
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 classComputedExpression
- Returns:
- the dependencies
-
display
public void display(int level, java.io.PrintStream out, Configuration config)
Diagnostic print of expression structure- Parameters:
level
- the indentation levelout
-config
-
-
-