Package org.basex.query.expr

Class TypeswitchGroup

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Single

org.basex.query.expr.TypeswitchGroup

public final class TypeswitchGroup
extends Single

Group of type switch cases.

Author:

BaseX Team 2005-22, BSD License, Christian Gruen

Field Summary

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

expr

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

exprType, info

Constructor Summary

Constructors

Constructor	Description
TypeswitchGroup(InputInfo info, Var var, SeqType[] seqTypes, Expr rtrn)	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	compile(CompileContext cc)	Compiles and optimizes the expression, assigns types and cardinalities.
TypeswitchGroup	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
boolean	equals(Object obj)	This function is e.g.
int	exprSize()	Counts the number of expressions in this expression's subtree.
Expr	inline(InlineContext ic)	Inlines an expression into this one, replacing all variable or context references.
Item	item(QueryContext qc, InputInfo ii)	Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence.
Iter	iter(QueryContext qc)	Evaluates the expression and returns an iterator on the resulting items.
void	markTailCalls(CompileContext cc)	Finds and marks tail calls, enabling TCO.
Expr	optimize(CompileContext cc)	Optimizes an already compiled expression without recompiling its sub-expressions.
Expr	simplifyFor(CompileContext.Simplify mode, CompileContext cc)	Simplifies the expression.
void	toString(QueryString qs)	Creates a query string.
void	toXml(QueryPlan plan)	Creates a query plan.
Expr	typeCheck(TypeCheck tc, CompileContext cc)	Tries to push the given type check inside this expression.
Value	value(QueryContext qc)	Evaluates the expression and returns the resulting value.

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

args, checkUp, count, has, inlineable

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

adoptType, atomValue, checkAllUp, checkNoEmpty, checkNoEmpty, checkNoneUp, checkNoUp, checkType, checkType, checkUp, copyType, ctxValue, data, ebv, info, refineType, seqType, size, test, toArray, toArray, toAtomItem, toB64, toB64, toBin, toBin, toBoolean, toBoolean, toBytes, toBytes, toDouble, toDouble, toElem, toFloat, toFunction, toItem, toItem, toLong, toLong, toMap, toMap, toNode, toNode, toNodeOrNull, toNumber, toNumberOrNull, toQNm, toQNm, toString, toString, toStringOrNull, toToken, toToken, toTokenOrNull, toZeroToken

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

arg, atomItem, atomIter, ddo, funcType, hasFreeVars, indexAccessible, isSimple, mergeEbv, optimizePos, simplify, uses, vacuous, visitAll

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

description, toErrorString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeswitchGroup

public TypeswitchGroup(InputInfo info,
                       Var var,
                       SeqType[] seqTypes,
                       Expr rtrn)

Constructor.

Parameters:

info - input info

var - variable (can be null)

seqTypes - sequence types this case matches, the empty array means default

rtrn - return expression

Method Detail

compile

public Expr compile(CompileContext cc)
             throws QueryException

Description copied from class: Expr

Compiles and optimizes the expression, assigns types and cardinalities.

Overrides:

compile in class Single

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 Single

Parameters:

cc - compilation context

Returns:

optimized expression

Throws:

QueryException - query exception

inline

public Expr inline(InlineContext ic)

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)

Overrides:

inline in class Single

Parameters:

ic - inlining context

Returns:

resulting expression if something has changed, null otherwise

typeCheck

public Expr typeCheck(TypeCheck tc,
                      CompileContext cc)
               throws QueryException

Description copied from class: Expr

Tries to push the given type check inside this expression.

Overrides:

typeCheck in class Expr

Parameters:

tc - type check to push into the expression

cc - compilation context

Returns:

the resulting expression if successful, null otherwise

Throws:

QueryException - query exception

copy

public TypeswitchGroup copy(CompileContext cc,
                            IntObjMap<Var> vm)

Description copied from class: Expr

Copies an expression. Used for inlining functions, or for copying static queries. It is utilized by VarRef.inline(org.basex.query.InlineContext), FuncItem.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext), Closure.inline(org.basex.query.InlineContext) and StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext).

Specified by:

copy in class Expr

Parameters:

cc - compilation context

vm - mapping from old variable IDs to new variable copies. Required by Closure.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>) and VarRef.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>)

Returns:

copied expression

iter

public Iter iter(QueryContext qc)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns an iterator on the resulting items. The implementation of this method is optional.

Overrides:

iter in class ParseExpr

Parameters:

qc - query context

Returns:

iterator

Throws:

QueryException - query exception

value

public Value value(QueryContext qc)
            throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting value. If this method is not implemented, Expr.item(QueryContext, InputInfo) must be implemented instead.

Overrides:

value in class ParseExpr

Parameters:

qc - query context

Returns:

value

Throws:

QueryException - query exception

item

public Item item(QueryContext qc,
                 InputInfo ii)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns the resulting item, or Empty.VALUE if the expression yields an empty sequence. If this method is not implemented, Expr.value(QueryContext) must be implemented instead.

Overrides:

item in class ParseExpr

Parameters:

qc - query context

ii - input info (only required by Seq instances, which have no input info)

Returns:

item or Empty.VALUE

Throws:

QueryException - query exception

markTailCalls

public void markTailCalls(CompileContext cc)

Description copied from class: Expr

Finds and marks tail calls, enabling TCO.

Overrides:

markTailCalls in class Expr

Parameters:

cc - compilation context, null if the changes should not be reported

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.

Overrides:

accept in class Single

Parameters:

visitor - visitor

Returns:

if the walk should be continued

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.

Overrides:

exprSize in class Single

Returns:

number of expressions

simplifyFor

public Expr simplifyFor(CompileContext.Simplify mode,
                        CompileContext cc)
                 throws QueryException

Description copied from class: Expr

Simplifies the expression. Overwritten by many expressions; calls Expr.simplify(Simplify, CompileContext) otherwise.

Overrides:

simplifyFor in class Expr

Parameters:

mode - mode of simplification

cc - compilation context

Returns:

simplified or original expression

Throws:

QueryException - query exception

See Also:

CompileContext.Simplify

equals

public boolean equals(Object obj)

Description copied from class: Single

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.

Overrides:

equals in class Single

toXml

public void toXml(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

toXml in class Single

Parameters:

plan - expression plan

toString

public void toString(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

toString in class ExprInfo

Parameters:

qs - query string builder