|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xquery.AbstractExpression
org.exist.xquery.PathExpr
PathExpr is just a sequence of XQuery/XPath expressions, which will be called step by step.
Field Summary |
Fields inherited from interface org.exist.xquery.Expression |
DOT_TEST, EXPRESSION_ID_INVALID, IGNORE_CONTEXT, IN_PREDICATE, IN_UPDATE, IN_WHERE_CLAUSE, NO_CONTEXT_ID, SINGLE_STEP_EXECUTION |
Constructor Summary | |
PathExpr(XQueryContext context)
|
Method Summary | |
void |
accept(ExpressionVisitor visitor)
Start traversing the expression tree using the specified ExpressionVisitor . |
void |
add(Expression s)
Add an arbitrary expression to this object's list of child-expressions. |
void |
add(PathExpr path)
Add all the child-expressions from another PathExpr to this object's child-expressions. |
void |
addPath(PathExpr path)
Add another PathExpr to this object's expression list. |
void |
addPredicate(Predicate pred)
Add a predicate expression to the list of expressions. |
void |
analyze(AnalyzeContextInfo contextInfo)
Statically analyze the expression and its subexpressions. |
void |
dump(ExpressionDumper dumper)
Write a diagnostic dump of the expression to the passed ExpressionDumper . |
void |
dump(java.io.Writer writer)
Writes a diagnostic dump of the expression structure to the specified writer. |
Sequence |
eval(Sequence contextSequence,
Item contextItem)
Evaluate the expression represented by this object. |
XQueryAST |
getASTNode()
Returns the XQueryAST node from which this expression
has been constructed by the parser. |
int |
getCardinality()
The default cardinality is Cardinality.EXACTLY_ONE . |
XQueryContext |
getContext()
|
int |
getDependencies()
Returns Dependency.DEFAULT_DEPENDENCIES . |
DocumentSet |
getDocumentSet()
|
Expression |
getExpression(int pos)
|
Expression |
getLastExpression()
|
int |
getLength()
|
java.lang.String |
getLiteralValue()
|
XACMLSource |
getSource()
Gets the source of this query. |
boolean |
isValid()
Is the compiled expression still valid? Returns false if, for example, the source code of one of the imported modules has changed. |
void |
replaceLastExpression(Expression s)
|
void |
reset()
Reset the compiled expression tree. |
void |
resetState()
Called to inform an expression that it should reset to its initial state. |
int |
returnsType()
The static return type of the expression. |
void |
setContext(XQueryContext context)
|
void |
setPrimaryAxis(int axis)
|
void |
setSource(XACMLSource source)
Sets the source of this query. |
java.lang.String |
toString()
|
Methods inherited from class org.exist.xquery.AbstractExpression |
eval, getContextDocSet, getContextId, getExpressionId, setASTNode, setContextDocSet |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.exist.xquery.CompiledXQuery |
eval |
Constructor Detail |
public PathExpr(XQueryContext context)
Method Detail |
public void setSource(XACMLSource source)
CompiledXQuery
setSource
in interface CompiledXQuery
source
- This query's sourcepublic XACMLSource getSource()
CompiledXQuery
getSource
in interface CompiledXQuery
public void add(Expression s)
s
- public void add(PathExpr path)
path
- public void addPath(PathExpr path)
path
- public void addPredicate(Predicate pred)
pred
- public void analyze(AnalyzeContextInfo contextInfo) throws XPathException
Expression
analyze
in interface Expression
XPathException
public Sequence eval(Sequence contextSequence, Item contextItem) throws XPathException
Expression
Dependency.CONTEXT_ITEM
bit is set in the bit field returned by Expression.getDependencies()
, the eval method will
be called once for every item in the context sequence. The contextItem
parameter will be set to the current item. Otherwise, the eval method will only be called
once for the whole context sequence and contextItem will be null.
eXist tries to process the entire context set in one, single step whenever
possible. Thus, most classes only expect context to contain a list of
nodes which represents the current context of the expression.
The position() function in XPath is an example for an expression,
which requires both, context sequence and context item to be set.
The context sequence might be a node set, a sequence of atomic values or a single
node or atomic value.
eval
in interface Expression
eval
in class AbstractExpression
XPathException
public XQueryContext getContext()
getContext
in interface CompiledXQuery
XQueryContext
used to create this querypublic DocumentSet getDocumentSet()
public Expression getExpression(int pos)
public Expression getLastExpression()
public int getLength()
public void accept(ExpressionVisitor visitor)
Expression
ExpressionVisitor
.
accept
in interface Expression
accept
in class AbstractExpression
public void dump(ExpressionDumper dumper)
Expression
ExpressionDumper
.
dump
in interface Expression
dumper
- the expression dumper to write topublic java.lang.String toString()
public int returnsType()
Expression
Type
. If the return type cannot be determined
statically, return Type.ITEM.
returnsType
in interface Expression
returnsType
in class AbstractExpression
public int getCardinality()
AbstractExpression
Cardinality.EXACTLY_ONE
.
getCardinality
in interface Expression
getCardinality
in class AbstractExpression
public int getDependencies()
AbstractExpression
Dependency.DEFAULT_DEPENDENCIES
.
getDependencies
in interface Expression
getDependencies
in class AbstractExpression
Expression.getDependencies()
public void replaceLastExpression(Expression s)
public java.lang.String getLiteralValue()
public XQueryAST getASTNode()
Expression
XQueryAST
node from which this expression
has been constructed by the parser. This node contains location information
(line number and column) important for error reports.
getASTNode
in interface Expression
getASTNode
in class AbstractExpression
public void setPrimaryAxis(int axis)
setPrimaryAxis
in interface Expression
setPrimaryAxis
in class AbstractExpression
public void resetState()
Expression
resetState
in interface Expression
resetState
in class AbstractExpression
public void reset()
CompiledXQuery
reset
in interface CompiledXQuery
public boolean isValid()
CompiledXQuery
isValid
in interface CompiledXQuery
public void dump(java.io.Writer writer)
CompiledXQuery
dump
in interface CompiledXQuery
public void setContext(XQueryContext context)
setContext
in interface CompiledXQuery
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |