Package org.basex.query.expr

Class Single

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Single

Direct Known Subclasses:

Cast, Castable, Catch, Closure, CmpIR, CmpR, CmpSR, Condition, Extension, FTContains, FuncLit, GroupSpec, Instance, OrderKey, Pos, Treat, Try, TypeCheck, TypeswitchGroup, Unary

public abstract class Single
extends ParseExpr

Abstract single expression.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
Expr	expr	Expression.

Fields inherited from class org.basex.query.expr.ParseExpr

exprType, info

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Single(InputInfo info, Expr expr, SeqType seqType)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	accept(ASTVisitor visitor)	Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.
Expr	arg(int a)	Returns the specified argument/operand of an expression (function, list, etc).
Expr[]	args()	Returns the arguments/operands of an expression (function, list, etc).
void	checkUp()	Checks if the updating semantics are satisfied.
Expr	compile(CompileContext cc)	Compiles and optimizes the expression, assigns types and cardinalities.
VarUsage	count(Var var)	Checks how often a variable or context reference is used in this expression.
boolean	equals(Object obj)	This function is e.g. called by: If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
int	exprSize()	Counts the number of expressions in this expression's subtree.
boolean	has(Flag... flags)	Indicates if an expression has one of the specified compiler properties.
Expr	inline(InlineContext ic)	Inlines an expression into this one, replacing all variable or context references.
boolean	inlineable(InlineContext ic)	Checks if inlining is possible.
Expr	optimize(CompileContext cc)	Optimizes an already compiled expression without recompiling its sub-expressions.
void	toXml(QueryPlan plan)	Creates a query plan.

Methods inherited from class org.basex.query.expr.ParseExpr

adoptType, atomValue, checkAllUp, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, data, info, item, iter, refineType, sc, seqType, size, test, toArray, toArray, toAtomItem, toBin, toBin, toBinOrNull, toBoolean, toBoolean, toBooleanOrFalse, toBytes, toBytes, toDouble, toDouble, toElem, toElem, toEnum, toFloat, toFunction, toLong, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumber, toNumberOrNull, toQNm, toQNmOrNull, toRecord, toString, toString, toStringOrNull, toToken, toToken, toTokenOrNull, toZeroToken, value

Methods inherited from class org.basex.query.expr.Expr

atomItem, atomIter, copy, ddo, funcType, hasFreeVars, indexAccessible, info, isSimple, markTailCalls, mergeEbv, optimizePos, simplify, simplifyFor, typeCheck, uses, vacuous, visitAll

Methods inherited from class org.basex.query.expr.ExprInfo

description, toErrorString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

expr

public Expr expr

Expression.

Constructor Detail

Single

protected Single(InputInfo info,
                 Expr expr,
                 SeqType seqType)

Constructor.

Parameters:

info - input info (can be null)

expr - expression

seqType - sequence type

Method Detail

checkUp

public void checkUp()
             throws QueryException

Description copied from class: Expr

Checks if the updating semantics are satisfied. This function is only called if any updating expression was found in the query.

Specified by:

checkUp in class Expr

Throws:

QueryException - query exception

compile

public Expr compile(CompileContext cc)
             throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns types and cardinalities.

Specified by:

compile in class Expr

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

optimize

public Expr optimize(CompileContext cc)
              throws QueryException

Description copied from class: Expr

Optimizes an already compiled expression without recompiling its sub-expressions.

Overrides:

optimize in class Expr

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

has

public boolean has(Flag... flags)

Description copied from class: Expr

Indicates if an expression has one of the specified compiler properties. This method must only be called at compile time. It is invoked to test properties of sub-expressions. It returns true if at least flag matches an expression.

Specified by:

has in class Expr

Parameters:

flags - flags to be checked

Returns:

result of check

inlineable

public boolean inlineable(InlineContext ic)

Description copied from class: Expr

Checks if inlining is possible. This function is called by InlineContext.inlineable(org.basex.query.expr.Expr...). The following tests might reject inlining if the expression depends on the context value:

• Preds.inlineable(org.basex.query.InlineContext)
• Path.inlineable(org.basex.query.InlineContext)
• Mapping.inlineable(org.basex.query.InlineContext)
• Mapping.inlineable(org.basex.query.InlineContext)
• TransformWith.inlineable(org.basex.query.InlineContext)

Specified by:

inlineable in class Expr

Parameters:

ic - inlining context

Returns:

result of check

count

public VarUsage count(Var var)

Description copied from class: Expr

Checks how often a variable or context reference is used in this expression. This function is, among others, called by:

• Closure.optimize(org.basex.query.CompileContext)
• GFLWOR.inlineForLet(org.basex.query.CompileContext)
• GFLWOR.optimizePos(org.basex.query.CompileContext)
• GFLWOR.simplify(org.basex.query.CompileContext)
• GFLWOR.unusedVars(org.basex.query.CompileContext)
• SimpleMap.optimize(org.basex.query.CompileContext)
• TypeswitchGroup.optimize(org.basex.query.CompileContext)

Specified by:

count in class Expr

Parameters:

var - variable (Var reference) or context (null) to inline

Returns:

number of usages, see VarUsage

inline

public Expr inline(InlineContext ic)
            throws QueryException

Description copied from class: Expr

Inlines an expression into this one, replacing all variable or context references. This function is called by InlineContext.inline(Expr) (see invocations of these functions for further inlinings). The variable reference is replaced in:

• OrderBy.inline(org.basex.query.InlineContext)
• VarRef.inline(org.basex.query.InlineContext)

The context is replaced in:

• ContextFn.inline(org.basex.query.InlineContext)
• ContextValue.inline(org.basex.query.InlineContext)
• Arr.inline(org.basex.query.InlineContext)

Specified by:

inline in class Expr

Parameters:

ic - inlining context

Returns:

resulting expression if something has changed, null otherwise

Throws:

QueryException - query exception

accept

public boolean accept(ASTVisitor visitor)

Description copied from class: Expr

Traverses this expression, notifying the visitor of declared and used variables, and checking the tree for other recursive properties.

Specified by:

accept in class Expr

Parameters:

visitor - visitor

Returns:

if the walk should be continued

args

public Expr[] args()

Description copied from class: Expr

Returns the arguments/operands of an expression (function, list, etc).

Overrides:

args in class Expr

Returns:

arguments or null

arg

public Expr arg(int a)

Description copied from class: Expr

Returns the specified argument/operand of an expression (function, list, etc).

Overrides:

arg in class Expr

Parameters:

a - index of argument

Returns:

argument or Empty.UNDEFINED if argument is undefined

exprSize

public int exprSize()

Description copied from class: Expr

Counts the number of expressions in this expression's subtree. This method is e.g. called by StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext) to check if an expression is small enough to be inlined.

Specified by:

exprSize in class Expr

Returns:

number of expressions

equals

public boolean equals(Object obj)

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Must be overwritten by implementing class.

Specified by:

equals in class Expr

toXml

public void toXml(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Specified by:

toXml in class ExprInfo

Parameters:

plan - expression plan