Top Description Fields Constructors Methods
org.h2.expression.condition

public final Class ConditionIn

extends Condition
Class Inheritance
Imports
java.util.ArrayList, .List, org.h2.engine.SessionLocal, org.h2.expression.Expression, .ExpressionColumn, .ExpressionList, .ExpressionVisitor, .Parameter, .TypedValueExpression, .ValueExpression, org.h2.index.IndexCondition, org.h2.table.ColumnResolver, .TableFilter, org.h2.value.TypeInfo, .Value, .ValueBoolean, .ValueNull, .ValueRow
An 'in' condition with a list of values, as in WHERE NAME IN(...)

Field Summary

Modifier and TypeField and Description
private Expression
left

private final boolean
not

private final ArrayList<Expression>
valueList

private final boolean
whenOperand

Constructor Summary

AccessConstructor and Description
public
ConditionIn(Expression
the expression before IN
left, boolean
whether the result should be negated
not, boolean
whether this is a when operand
whenOperand, ArrayList<Expression>
the value list (at least one element)
values)

Create a new IN(..) condition.

Method Summary

Modifier and TypeMethod and Description
private boolean
areAllValues(ExpressionVisitor visitor)

private void
createCompoundIndexCondition(TableFilter filter)

Creates a compound index condition containing every item in the expression list.

public void
createIndexConditions(SessionLocal
the session
session, TableFilter
the table filter
filter)

Overrides org.h2.expression.Expression.createIndexConditions.

Create index conditions if possible and attach them to the table filter.

private static void
createIndexConditions(TableFilter filter, ExpressionColumn l, ArrayList<Expression> valueList)

private void
createUniqueIndexConditions(TableFilter filter, ExpressionList list)

Creates a unique index condition for every item in the expression list.

pack-priv Expression

Returns:

null if the condition was not added, or the new condition
getAdditional(Comparison
the second condition
other)

Add an additional element if possible.

public int
getCost()

Implements abstract org.h2.expression.Expression.getCost.

Estimate the cost to process the expression.

public Expression
getNotIfPossible(SessionLocal
the session
session)

Overrides org.h2.expression.Expression.getNotIfPossible.

If it is possible, return the negated expression.

public Expression
getSubexpression(int
0-based index
index)

Overrides org.h2.expression.Expression.getSubexpression.

Returns subexpression with specified index.

public int
getSubexpressionCount()

Overrides org.h2.expression.Expression.getSubexpressionCount.

Returns count of subexpressions.

public StringBuilder
getUnenclosedSQL(StringBuilder
string builder
builder, int
formatting flags
sqlFlags)

Implements abstract org.h2.expression.Expression.getUnenclosedSQL.

Get the SQL statement of this expression.

public Value
getValue(SessionLocal
the session
session)

Implements abstract org.h2.expression.Expression.getValue.

Return the resulting value for the current row.

private Value
getValue(SessionLocal session, Value left)

public StringBuilder
getWhenSQL(StringBuilder
string builder
builder, int
formatting flags
sqlFlags)

Overrides org.h2.expression.Expression.getWhenSQL.

Appends the SQL statement of this when operand to the specified builder.

public boolean
getWhenValue(SessionLocal
the session
session, Value
value on the left side
left)

Overrides org.h2.expression.Expression.getWhenValue.

Return the resulting value of when operand for the current row.

public boolean
isEverything(ExpressionVisitor
the visitor
visitor)

Implements abstract org.h2.expression.Expression.isEverything.

Check if this expression and all sub-expressions can fulfill a criteria.

public boolean
isWhenConditionOperand()

Overrides org.h2.expression.Expression.isWhenConditionOperand.

Returns whether this expression is a right side of condition in a when operand.

public void
mapColumns(ColumnResolver
the column resolver
resolver, int
the subquery nesting level
level, int
current state for nesting checks, initial value is MAP_INITIAL
state)

Implements abstract org.h2.expression.Expression.mapColumns.

Map the columns of the resolver to expression columns.

public boolean
needParentheses()

Overrides org.h2.expression.Expression.needParentheses.

Returns whether this expressions needs to be wrapped in parentheses when it is used as an argument of other expressions.

public Expression
optimize(SessionLocal
the session
session)

Implements abstract org.h2.expression.Expression.optimize.

Try to optimize the expression.

private Expression
optimize2(SessionLocal session, boolean constant, boolean allValuesConstant, boolean allValuesNull, ArrayList<Expression> values)

public void
setEvaluatable(TableFilter
the table filter
tableFilter, boolean
true if the table filter can return value
b)

Implements abstract org.h2.expression.Expression.setEvaluatable.

Tell the expression columns whether the table filter can return values now.

public void
updateAggregate(SessionLocal
the session
session, int
select stage
stage)

Implements abstract org.h2.expression.Expression.updateAggregate.

Update an aggregate value.

Inherited from org.h2.expression.condition.Condition:
castToBooleangetType

Field Detail

leftback to summary
private Expression left
notback to summary
private final boolean not
valueListback to summary
private final ArrayList<Expression> valueList
whenOperandback to summary
private final boolean whenOperand

Constructor Detail

ConditionInback to summary
public ConditionIn(Expression left, boolean not, boolean whenOperand, ArrayList<Expression> values)

Create a new IN(..) condition.

Parameters
left:Expression

the expression before IN

not:boolean

whether the result should be negated

whenOperand:boolean

whether this is a when operand

values:ArrayList<Expression>

the value list (at least one element)

Method Detail

areAllValuesback to summary
private boolean areAllValues(ExpressionVisitor visitor)
createCompoundIndexConditionback to summary
private void createCompoundIndexCondition(TableFilter filter)

Creates a compound index condition containing every item in the expression list.

See Also
IndexCondition#getCompoundInList(ExpressionList, List)
createIndexConditionsback to summary
public void createIndexConditions(SessionLocal session, TableFilter filter)

Overrides org.h2.expression.Expression.createIndexConditions.

Doc from org.h2.expression.Expression.createIndexConditions.

Create index conditions if possible and attach them to the table filter.

Parameters
session:SessionLocal

the session

filter:TableFilter

the table filter

Annotations
@Override
createIndexConditionsback to summary
private static void createIndexConditions(TableFilter filter, ExpressionColumn l, ArrayList<Expression> valueList)
createUniqueIndexConditionsback to summary
private void createUniqueIndexConditions(TableFilter filter, ExpressionList list)

Creates a unique index condition for every item in the expression list.

See Also
IndexCondition#getInList(ExpressionColumn, List)
getAdditionalback to summary
pack-priv Expression getAdditional(Comparison other)

Add an additional element if possible. Example: given two conditions A IN(1, 2) OR A=3, the constant 3 is added: A IN(1, 2, 3).

Parameters
other:Comparison

the second condition

Returns:Expression

null if the condition was not added, or the new condition

getCostback to summary
public int getCost()

Implements abstract org.h2.expression.Expression.getCost.

Doc from org.h2.expression.Expression.getCost.

Estimate the cost to process the expression. Used when optimizing the query, to calculate the query plan with the lowest estimated cost.

Returns:int

the estimated cost

Annotations
@Override
getNotIfPossibleback to summary
public Expression getNotIfPossible(SessionLocal session)

Overrides org.h2.expression.Expression.getNotIfPossible.

Doc from org.h2.expression.Expression.getNotIfPossible.

If it is possible, return the negated expression. This is used to optimize NOT expressions: NOT ID>10 can be converted to ID<=10. Returns null if negating is not possible.

Parameters
session:SessionLocal

the session

Returns:Expression

the negated expression, or null

Annotations
@Override
getSubexpressionback to summary
public Expression getSubexpression(int index)

Overrides org.h2.expression.Expression.getSubexpression.

Doc from org.h2.expression.Expression.getSubexpression.

Returns subexpression with specified index.

Parameters
index:int

0-based index

Returns:Expression

subexpression with specified index, may be null

Annotations
@Override
getSubexpressionCountback to summary
public int getSubexpressionCount()

Overrides org.h2.expression.Expression.getSubexpressionCount.

Doc from org.h2.expression.Expression.getSubexpressionCount.

Returns count of subexpressions.

Returns:int

count of subexpressions

Annotations
@Override
getUnenclosedSQLback to summary
public StringBuilder getUnenclosedSQL(StringBuilder builder, int sqlFlags)

Implements abstract org.h2.expression.Expression.getUnenclosedSQL.

Doc from org.h2.expression.Expression.getUnenclosedSQL.

Get the SQL statement of this expression. This may not always be the original SQL statement, especially after optimization. Enclosing '(' and ')' are never appended.

Parameters
builder:StringBuilder

string builder

sqlFlags:int

formatting flags

Returns:StringBuilder

the specified string builder

Annotations
@Override
getValueback to summary
public Value getValue(SessionLocal session)

Implements abstract org.h2.expression.Expression.getValue.

Doc from org.h2.expression.Expression.getValue.

Return the resulting value for the current row.

Parameters
session:SessionLocal

the session

Returns:Value

the result

Annotations
@Override
getValueback to summary
private Value getValue(SessionLocal session, Value left)
getWhenSQLback to summary
public StringBuilder getWhenSQL(StringBuilder builder, int sqlFlags)

Overrides org.h2.expression.Expression.getWhenSQL.

Doc from org.h2.expression.Expression.getWhenSQL.

Appends the SQL statement of this when operand to the specified builder.

Parameters
builder:StringBuilder

string builder

sqlFlags:int

formatting flags

Returns:StringBuilder

the specified string builder

Annotations
@Override
getWhenValueback to summary
public boolean getWhenValue(SessionLocal session, Value left)

Overrides org.h2.expression.Expression.getWhenValue.

Doc from org.h2.expression.Expression.getWhenValue.

Return the resulting value of when operand for the current row.

Parameters
session:SessionLocal

the session

left:Value

value on the left side

Returns:boolean

the result

Annotations
@Override
isEverythingback to summary
public boolean isEverything(ExpressionVisitor visitor)

Implements abstract org.h2.expression.Expression.isEverything.

Doc from org.h2.expression.Expression.isEverything.

Check if this expression and all sub-expressions can fulfill a criteria. If any part returns false, the result is false.

Parameters
visitor:ExpressionVisitor

the visitor

Returns:boolean

if the criteria can be fulfilled

Annotations
@Override
isWhenConditionOperandback to summary
public boolean isWhenConditionOperand()

Overrides org.h2.expression.Expression.isWhenConditionOperand.

Doc from org.h2.expression.Expression.isWhenConditionOperand.

Returns whether this expression is a right side of condition in a when operand.

Returns:boolean

true if it is, false otherwise

Annotations
@Override
mapColumnsback to summary
public void mapColumns(ColumnResolver resolver, int level, int state)

Implements abstract org.h2.expression.Expression.mapColumns.

Doc from org.h2.expression.Expression.mapColumns.

Map the columns of the resolver to expression columns.

Parameters
resolver:ColumnResolver

the column resolver

level:int

the subquery nesting level

state:int

current state for nesting checks, initial value is MAP_INITIAL

Annotations
@Override
needParenthesesback to summary
public boolean needParentheses()

Overrides org.h2.expression.Expression.needParentheses.

Doc from org.h2.expression.Expression.needParentheses.

Returns whether this expressions needs to be wrapped in parentheses when it is used as an argument of other expressions.

Returns:boolean

true if it is

Annotations
@Override
optimizeback to summary
public Expression optimize(SessionLocal session)

Implements abstract org.h2.expression.Expression.optimize.

Doc from org.h2.expression.Expression.optimize.

Try to optimize the expression.

Parameters
session:SessionLocal

the session

Returns:Expression

the optimized expression

Annotations
@Override
optimize2back to summary
private Expression optimize2(SessionLocal session, boolean constant, boolean allValuesConstant, boolean allValuesNull, ArrayList<Expression> values)
setEvaluatableback to summary
public void setEvaluatable(TableFilter tableFilter, boolean b)

Implements abstract org.h2.expression.Expression.setEvaluatable.

Doc from org.h2.expression.Expression.setEvaluatable.

Tell the expression columns whether the table filter can return values now. This is used when optimizing the query.

Parameters
tableFilter:TableFilter

the table filter

b:boolean

true if the table filter can return value

Annotations
@Override
updateAggregateback to summary
public void updateAggregate(SessionLocal session, int stage)

Implements abstract org.h2.expression.Expression.updateAggregate.

Doc from org.h2.expression.Expression.updateAggregate.

Update an aggregate value. This method is called at statement execution time. It is usually called once for each row, but if the expression is used multiple times (for example in the column list, and as part of the HAVING expression) it is called multiple times - the row counter needs to be used to make sure the internal state is only updated once.

Parameters
session:SessionLocal

the session

stage:int

select stage

Annotations
@Override