Package net.sf.saxon.expr.flwor

Class WhereClause

java.lang.Object

net.sf.saxon.expr.flwor.Clause

net.sf.saxon.expr.flwor.WhereClause

public class WhereClause
extends Clause

A "where" clause in a FLWOR expression

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.expr.flwor.Clause

Clause.ClauseName

Constructor Summary

Constructors

Constructor	Description
WhereClause(FLWORExpression flwor, Expression predicate)

Method Summary

Modifier and Type	Method	Description
void	addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)	Collect information about the navigation paths followed by this clause, for document projection purposes
WhereClause	copy(FLWORExpression flwor, RebindingMap rebindings)	Create a copy of this clause
void	explain(ExpressionPresenter out)	Diagnostic print of expression structure.
void	gatherVariableReferences(ExpressionVisitor visitor, Binding binding, java.util.List<VariableReference> references)	Build a list of all references to a variables declared in this clause
Clause.ClauseName	getClauseKey()	Get a keyword identifying what kind of clause this is
Expression	getPredicate()
TuplePull	getPullStream(TuplePull base, XPathContext context)	Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies
TuplePush	getPushStream(TuplePush destination, Outputter output, XPathContext context)	Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream
java.util.Map<java.lang.String,java.lang.Object>	getTraceInfo()	Get information for inclusion in trace output
void	processOperands(OperandProcessor processor)	Process the subexpressions of this clause
void	refineVariableType(ExpressionVisitor visitor, java.util.List<VariableReference> references, Expression returnExpr)	Supply improved type information to the expressions that contain references to the variables declared in this clause
void	setPredicate(Expression predicate)
void	setRepeated(boolean repeated)
java.lang.String	toShortString()	Get a short string representation of the clause
java.lang.String	toString()
void	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo)	Type-check the expression

Methods inherited from class net.sf.saxon.expr.flwor.Clause

containsNonInlineableVariableReference, getConfiguration, getLocation, getPackageData, getRangeVariables, isRepeated, optimize, setLocation, setPackageData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WhereClause

public WhereClause(FLWORExpression flwor,
                   Expression predicate)

Method Detail

setRepeated

public void setRepeated(boolean repeated)

Overrides:

setRepeated in class Clause

getClauseKey

public Clause.ClauseName getClauseKey()

Description copied from class: Clause

Get a keyword identifying what kind of clause this is

Specified by:

getClauseKey in class Clause

Returns:

the kind of clause

getPredicate

public Expression getPredicate()

setPredicate

public void setPredicate(Expression predicate)

copy

public WhereClause copy(FLWORExpression flwor,
                        RebindingMap rebindings)

Description copied from class: Clause

Create a copy of this clause

Specified by:

copy in class Clause

Parameters:

flwor - the new FLWORExpression to contain the copied clause

Returns:

the copied clause

typeCheck

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

Type-check the expression

Overrides:

typeCheck in class Clause

Parameters:

visitor - the ExpressionVisitor, providing access to static context information

contextInfo - static information about the dynamic context

Throws:

XPathException - if any error is detected

getPullStream

public TuplePull getPullStream(TuplePull base,
                               XPathContext context)

Get a tuple stream that implements the functionality of this clause, taking its input from another tuple stream which this clause modifies

Specified by:

getPullStream in class Clause

Parameters:

base - the input tuple stream

context - the dynamic evaluation context

Returns:

the output tuple stream

gatherVariableReferences

public void gatherVariableReferences(ExpressionVisitor visitor,
                                     Binding binding,
                                     java.util.List<VariableReference> references)

Description copied from class: Clause

Build a list of all references to a variables declared in this clause

Overrides:

gatherVariableReferences in class Clause

Parameters:

visitor - the expression visitor

binding - a variable declared in this clause

references - the list of variable references, initially empty, to which the method will append

refineVariableType

public void refineVariableType(ExpressionVisitor visitor,
                               java.util.List<VariableReference> references,
                               Expression returnExpr)

Description copied from class: Clause

Supply improved type information to the expressions that contain references to the variables declared in this clause

Overrides:

refineVariableType in class Clause

Parameters:

visitor - the expression visitor

references - the list of variable references

returnExpr - the expression in the return clause

getPushStream

public TuplePush getPushStream(TuplePush destination,
                               Outputter output,
                               XPathContext context)

Get a push-mode tuple stream that implements the functionality of this clause, supplying its output to another tuple stream

Specified by:

getPushStream in class Clause

Parameters:

destination - the output tuple stream

output - the destination for the result

context - the dynamic evaluation context

Returns:

the push tuple stream that implements the functionality of this clause of the FLWOR expression

processOperands

public void processOperands(OperandProcessor processor)
                     throws XPathException

Process the subexpressions of this clause

Specified by:

processOperands in class Clause

Parameters:

processor - the expression processor used to process the subexpressions

Throws:

XPathException - if any error is detected

addToPathMap

public void addToPathMap(PathMap pathMap,
                         PathMap.PathMapNodeSet pathMapNodeSet)

Description copied from class: Clause

Collect information about the navigation paths followed by this clause, for document projection purposes

Specified by:

addToPathMap in class Clause

Parameters:

pathMap - the path map in which the data is to be collected

pathMapNodeSet - the path map node set representing the paths to the context item

explain

public void explain(ExpressionPresenter out)
             throws XPathException

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

Specified by:

explain in class Clause

Parameters:

out - the expression presenter used to display the structure

Throws:

XPathException

toShortString

public java.lang.String toShortString()

Description copied from class: Clause

Get a short string representation of the clause

Overrides:

toShortString in class Clause

Returns:

a recognizable string

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTraceInfo

public java.util.Map<java.lang.String,java.lang.Object> getTraceInfo()

Get information for inclusion in trace output

Overrides:

getTraceInfo in class Clause

Returns:

a map containing the properties to be output