org.h2.expression.function

Class JavaFunction

java.lang.Object

org.h2.expression.Expression

org.h2.expression.function.JavaFunction

All Implemented Interfaces:

FunctionCall

public class JavaFunction
extends Expression
implements FunctionCall

This class wraps a user-defined function.

Field Summary

Fields inherited from class org.h2.expression.Expression

MAP_IN_AGGREGATE, MAP_IN_WINDOW, MAP_INITIAL

Constructor Summary

Constructors

Constructor and Description
JavaFunction(FunctionAlias functionAlias, Expression[] args)

Method Summary

Methods

Modifier and Type	Method and Description
Expression[]	getArgs() Get the function arguments.
int	getCost() Estimate the cost to process the expression.
Expression[]	getExpressionColumns(Session session) If this expression consists of column expressions it should return them.
java.lang.String	getName() Get the name of the function.
java.lang.StringBuilder	getSQL(java.lang.StringBuilder builder, boolean alwaysQuote) Appends the SQL statement of this expression to the specified builder.
Expression	getSubexpression(int index) Returns subexpression with specified index.
int	getSubexpressionCount() Returns count of subexpressions.
TypeInfo	getType() Returns the data type.
Value	getValue(Session session) Return the resulting value for the current row.
ValueResultSet	getValueForColumnList(Session session, Expression[] argList) Get an empty result set with the column names set.
int	getValueType() Get the data type.
boolean	isDeterministic() Whether the function always returns the same result for the same parameters.
boolean	isEverything(ExpressionVisitor visitor) Check if this expression and all sub-expressions can fulfill a criteria.
void	mapColumns(ColumnResolver resolver, int level, int state) Map the columns of the resolver to expression columns.
Expression	optimize(Session session) Try to optimize the expression.
void	setEvaluatable(TableFilter tableFilter, boolean b) Tell the expression columns whether the table filter can return values now.
void	updateAggregate(Session session, int stage) Update an aggregate value.

Methods inherited from class org.h2.expression.Expression

addFilterConditions, createIndexConditions, getAlias, getBooleanValue, getColumnName, getExpressionColumns, getExpressionColumns, getNonAliasExpression, getNotIfPossible, getNullable, getSchemaName, getSQL, getTableAlias, getTableName, getUnenclosedSQL, isAutoIncrement, isConstant, isNullConstant, isValueSet, toString, writeExpressions, writeExpressions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.h2.expression.function.FunctionCall

getSQL

Constructor Detail

JavaFunction

public JavaFunction(FunctionAlias functionAlias,
            Expression[] args)

Method Detail

getValue

public Value getValue(Session session)

Description copied from class: Expression

Return the resulting value for the current row.

Specified by:

getValue in class Expression

Parameters:

session - the session

Returns:

the result

getType

public TypeInfo getType()

Description copied from class: Expression

Returns the data type. The data type may not be known before the optimization phase.

Specified by:

getType in class Expression

Returns:

the data type

getValueType

public int getValueType()

Description copied from interface: FunctionCall

Get the data type.

Specified by:

getValueType in interface FunctionCall

Returns:

the data type

mapColumns

public void mapColumns(ColumnResolver resolver,
              int level,
              int state)

Description copied from class: Expression

Map the columns of the resolver to expression columns.

Specified by:

mapColumns in class Expression

Parameters:

resolver - the column resolver

level - the subquery nesting level

state - current state for nesting checks, initial value is Expression.MAP_INITIAL

optimize

public Expression optimize(Session session)

Description copied from class: Expression

Try to optimize the expression.

Specified by:

optimize in interface FunctionCall

Specified by:

optimize in class Expression

Parameters:

session - the session

Returns:

the optimized expression

setEvaluatable

public void setEvaluatable(TableFilter tableFilter,
                  boolean b)

Description copied from class: Expression

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

Specified by:

setEvaluatable in class Expression

Parameters:

tableFilter - the table filter

b - true if the table filter can return value

getSQL

public java.lang.StringBuilder getSQL(java.lang.StringBuilder builder,
                             boolean alwaysQuote)

Description copied from class: Expression

Appends the SQL statement of this expression to the specified builder. This may not always be the original SQL statement, specially after optimization.

Specified by:

getSQL in class Expression

Parameters:

builder - string builder

alwaysQuote - quote all identifiers

Returns:

the specified string builder

updateAggregate

public void updateAggregate(Session session,
                   int stage)

Description copied from class: Expression

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.

Specified by:

updateAggregate in class Expression

Parameters:

session - the session

stage - select stage

getName

public java.lang.String getName()

Description copied from interface: FunctionCall

Get the name of the function.

Specified by:

getName in interface FunctionCall

Returns:

the name

getValueForColumnList

public ValueResultSet getValueForColumnList(Session session,
                                   Expression[] argList)

Description copied from interface: FunctionCall

Get an empty result set with the column names set.

Specified by:

getValueForColumnList in interface FunctionCall

Parameters:

session - the session

argList - the argument list (some arguments may be null)

Returns:

the empty result set

getArgs

public Expression[] getArgs()

Description copied from interface: FunctionCall

Get the function arguments.

Specified by:

getArgs in interface FunctionCall

Returns:

argument list

isEverything

public boolean isEverything(ExpressionVisitor visitor)

Description copied from class: Expression

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

Specified by:

isEverything in class Expression

Parameters:

visitor - the visitor

Returns:

if the criteria can be fulfilled

getCost

public int getCost()

Description copied from class: Expression

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

Specified by:

getCost in class Expression

Returns:

the estimated cost

isDeterministic

public boolean isDeterministic()

Description copied from interface: FunctionCall

Whether the function always returns the same result for the same parameters.

Specified by:

isDeterministic in interface FunctionCall

Returns:

true if it does

getExpressionColumns

public Expression[] getExpressionColumns(Session session)

Description copied from class: Expression

If this expression consists of column expressions it should return them.

Overrides:

getExpressionColumns in class Expression

Parameters:

session - the session

Returns:

array of expression columns if applicable, null otherwise

getSubexpressionCount

public int getSubexpressionCount()

Description copied from class: Expression

Returns count of subexpressions.

Overrides:

getSubexpressionCount in class Expression

Returns:

count of subexpressions

getSubexpression

public Expression getSubexpression(int index)

Description copied from class: Expression

Returns subexpression with specified index.

Overrides:

getSubexpression in class Expression

Parameters:

index - 0-based index

Returns:

subexpression with specified index, may be null