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

public final Class DBObjectFunction

extends FunctionN
Class Inheritance
Imports
org.h2.engine.Database, .DbObject, .SessionLocal, org.h2.expression.Expression, .ExpressionVisitor, org.h2.index.Index, org.h2.message.DbException, org.h2.schema.Schema, org.h2.table.Table, org.h2.value.TypeInfo, .Value, .ValueBigint, .ValueInteger, .ValueNull, .ValueVarchar
DB_OBJECT_ID() and DB_OBJECT_SQL() functions.

Field Summary

Modifier and TypeField and Description
public static final int
DB_OBJECT_APPROXIMATE_SIZE

DB_OBJECT_APPROXIMATE_SIZE() (non-standard).

public static final int
DB_OBJECT_APPROXIMATE_TOTAL_SIZE

DB_OBJECT_APPROXIMATE_TOTAL_SIZE() (non-standard).

public static final int
DB_OBJECT_ID

DB_OBJECT_ID() (non-standard).

public static final int
DB_OBJECT_SIZE

DB_OBJECT_SIZE() (non-standard).

public static final int
DB_OBJECT_SQL

DB_OBJECT_SQL() (non-standard).

public static final int
DB_OBJECT_TOTAL_SIZE

DB_OBJECT_TOTAL_SIZE() (non-standard).

private final int
function

private static final String[]
NAMES

Constructor Summary

AccessConstructor and Description
public
DBObjectFunction(Expression objectType, Expression arg1, Expression arg2, int function)

Method Summary

Modifier and TypeMethod and Description
private static Value
getDbObjectSize(DbObject object, boolean total, boolean approximate)

public String
getName()

Implements org.h2.expression.function.NamedExpression.getName.

Get the name.

public Value
getValue(SessionLocal
the session
session, Value
the value of first argument, or null
v1, Value
the value of second argument, or null
v2, Value
the value of third argument, or null
v3)

Overrides org.h2.expression.function.FunctionN.getValue.

Returns the value of this function.

public boolean
isEverything(ExpressionVisitor
the visitor
visitor)

Overrides org.h2.expression.OperationN.isEverything.

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

public Expression
optimize(SessionLocal
the session
session)

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

Try to optimize the expression.

Inherited from org.h2.expression.function.FunctionN:
getUnenclosedSQLgetValue

Field Detail

DB_OBJECT_APPROXIMATE_SIZEback to summary
public static final int DB_OBJECT_APPROXIMATE_SIZE

DB_OBJECT_APPROXIMATE_SIZE() (non-standard).

DB_OBJECT_APPROXIMATE_TOTAL_SIZEback to summary
public static final int DB_OBJECT_APPROXIMATE_TOTAL_SIZE

DB_OBJECT_APPROXIMATE_TOTAL_SIZE() (non-standard).

DB_OBJECT_IDback to summary
public static final int DB_OBJECT_ID

DB_OBJECT_ID() (non-standard).

DB_OBJECT_SIZEback to summary
public static final int DB_OBJECT_SIZE

DB_OBJECT_SIZE() (non-standard).

DB_OBJECT_SQLback to summary
public static final int DB_OBJECT_SQL

DB_OBJECT_SQL() (non-standard).

DB_OBJECT_TOTAL_SIZEback to summary
public static final int DB_OBJECT_TOTAL_SIZE

DB_OBJECT_TOTAL_SIZE() (non-standard).

functionback to summary
private final int function
NAMESback to summary
private static final String[] NAMES

Constructor Detail

DBObjectFunctionback to summary
public DBObjectFunction(Expression objectType, Expression arg1, Expression arg2, int function)

Method Detail

getDbObjectSizeback to summary
private static Value getDbObjectSize(DbObject object, boolean total, boolean approximate)
getNameback to summary
public String getName()

Implements org.h2.expression.function.NamedExpression.getName.

Doc from org.h2.expression.function.NamedExpression.getName.

Get the name.

Returns:String

the name in uppercase

Annotations
@Override
getValueback to summary
public Value getValue(SessionLocal session, Value v1, Value v2, Value v3)

Overrides org.h2.expression.function.FunctionN.getValue.

Doc from org.h2.expression.function.FunctionN.getValue.

Returns the value of this function.

Parameters
session:SessionLocal

the session

v1:Value

the value of first argument, or null

v2:Value

the value of second argument, or null

v3:Value

the value of third argument, or null

Returns:Value

the resulting value

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

Overrides org.h2.expression.OperationN.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
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