net.sf.saxon.expr
public final class FilterExpression extends Expression
Modifier and Type | Field and Description |
---|---|
static int |
FILTERED |
EVALUATE_METHOD, ITERATE_METHOD, locationId, PROCESS_METHOD, staticProperties
Constructor and Description |
---|
FilterExpression(Expression start,
Expression filter)
Constructor
|
Modifier and Type | Method and Description |
---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
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(java.lang.Object other)
Is this expression the same as another expression?
|
void |
explain(ExpressionPresenter out)
Diagnostic print of expression structure.
|
Expression |
getBaseExpression()
Get the underlying expression
|
Expression |
getFilter()
Get the filter expression
|
ItemType |
getItemType(TypeHierarchy th)
Get the data type of the items returned
|
int |
hashCode()
get HashCode for comparing two expressions
|
boolean |
hasLoopingSubexpression(Expression child)
Given an expression that is an immediate child of this expression, test whether
the evaluation of the parent expression causes the child expression to be
evaluated repeatedly
|
boolean |
isIndependentNumericFilter()
Determine whether the filter is a simple independent numeric, that is, an expression
that satisfies the following conditions: (a) its value is numeric;
(b) the value does not depend on the context item or position;
(c) the cardinality is zero or one.
|
boolean |
isPositional(TypeHierarchy th)
Determine if the filter is positional
|
boolean |
isSimpleBooleanFilter()
Test if the filter always returns a singleton boolean
|
SequenceIterator |
iterate(XPathContext context)
Iterate over the results, returning them in the correct order
|
java.util.Iterator |
iterateSubExpressions()
Get the immediate subexpressions 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 |
simplify(ExpressionVisitor visitor)
Simplify an expression
|
java.lang.String |
toString()
The toString() method for an expression attempts to give a representation of the expression
in an XPath-like form, but there is no guarantee that the syntax will actually be true XPath.
|
Expression |
typeCheck(ExpressionVisitor visitor,
ItemType contextItemType)
Type-check the expression
|
adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeStaticProperties, display, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, 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, implementsStaticTypeCheck, isUpdatingExpression, iterateEvents, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError
public static final int FILTERED
public FilterExpression(Expression start, Expression filter)
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 predicatepublic ItemType getItemType(TypeHierarchy th)
getItemType
in class Expression
th
- the type hierarchy cachepublic Expression getBaseExpression()
public Expression getFilter()
public boolean isPositional(TypeHierarchy th)
th
- the Type Hierarchy (for cached access to type information)public boolean isSimpleBooleanFilter()
public boolean isIndependentNumericFilter()
public Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify
in class Expression
visitor
- the expression visitorXPathException
- if any failure occurspublic Expression typeCheck(ExpressionVisitor visitor, ItemType contextItemType) throws XPathException
typeCheck
in class Expression
visitor
- the expression visitorcontextItemType
- the type of the context item for this expressionXPathException
- if an error is discovered during this phase
(typically a type error)public Expression optimize(ExpressionVisitor visitor, ItemType contextItemType) throws XPathException
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 class Expression
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 to
Type.ITEM_TYPE
XPathException
- if an error is discovered during this phase
(typically a type error)public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
addToPathMap
in class Expression
pathMap
- the PathMap to which the expression should be addedpathMapNodeSet
- public Expression promote(PromotionOffer offer) throws XPathException
promote
in class Expression
offer
- details of the promotion that is possibleXPathException
- if any error is detectedpublic java.util.Iterator iterateSubExpressions()
iterateSubExpressions
in class Expression
public boolean hasLoopingSubexpression(Expression child)
hasLoopingSubexpression
in class Expression
child
- the immediate subexpressionpublic boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
in class Expression
original
- the original subexpressionreplacement
- the replacement subexpressionpublic int computeCardinality()
computeCardinality
in class Expression
public int computeSpecialProperties()
computeSpecialProperties
in class Expression
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- the expression to be compared with this onepublic int hashCode()
hashCode
in class java.lang.Object
public SequenceIterator iterate(XPathContext context) throws XPathException
iterate
in interface SequenceIterable
iterate
in class Expression
context
- the dynamic context for the evaluationXPathException
- if any dynamic error occurspublic int computeDependencies()
computeDependencies
in class Expression
public Expression copy()
copy
in class Expression
public java.lang.String toString()
toString
in class Expression
public void explain(ExpressionPresenter out)
explain
in class Expression
out
- the ExpressionPresenter to be used