Top Description Constructors Methods
org.h2.expression.function

public final Class SubstringFunction

extends FunctionN
Class Inheritance
Imports
java.util.Arrays, org.h2.api.ErrorCode, org.h2.engine.SessionLocal, org.h2.expression.Expression, .TypedValueExpression, org.h2.message.DbException, org.h2.value.DataType, .TypeInfo, .Value, .ValueNull, .ValueVarbinary, .ValueVarchar
A SUBSTRING function.

Constructor Summary

AccessConstructor and Description
public
SubstringFunction()

Method Summary

Modifier and TypeMethod and Description
public String
getName()

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

Get the name.

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

Overrides org.h2.expression.function.FunctionN.getUnenclosedSQL.

Get the SQL statement of this expression.

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 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:
getValue

Constructor Detail

SubstringFunctionback to summary
public SubstringFunction()

Method Detail

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
getUnenclosedSQLback to summary
public StringBuilder getUnenclosedSQL(StringBuilder builder, int sqlFlags)

Overrides org.h2.expression.function.FunctionN.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, 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
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