Package org.h2.expression.function

Class SoundexFunction

java.lang.Object

org.h2.expression.Expression

org.h2.expression.Operation1_2

org.h2.expression.function.Function1_2

org.h2.expression.function.SoundexFunction

All Implemented Interfaces:

NamedExpression, HasSQL, Typed

public final class SoundexFunction
extends Function1_2

A SOUNDEX or DIFFERENCE function.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DIFFERENCE	DIFFERENCE() (non-standard).
static final int	SOUNDEX	SOUNDEX() (non-standard).

Fields inherited from class org.h2.expression.Operation1_2

left, right, type

Fields inherited from class org.h2.expression.Expression

AUTO_PARENTHESES, MAP_IN_AGGREGATE, MAP_IN_WINDOW, MAP_INITIAL, WITH_PARENTHESES, WITHOUT_PARENTHESES

Fields inherited from interface org.h2.util.HasSQL

ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

Constructor Summary

Constructors

Constructor	Description
SoundexFunction(Expression arg1, Expression arg2, int function)

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name.
Value	getValue(SessionLocal session, Value v1, Value v2)	Returns the value of this function.
Expression	optimize(SessionLocal session)	Try to optimize the expression.

Methods inherited from class org.h2.expression.function.Function1_2

getUnenclosedSQL, getValue

Methods inherited from class org.h2.expression.Operation1_2

getCost, getSubexpression, getSubexpressionCount, getType, isEverything, mapColumns, setEvaluatable, updateAggregate

Methods inherited from class org.h2.expression.Expression

addFilterConditions, createIndexConditions, getAlias, getBooleanValue, getColumnName, getColumnNameForView, getEnclosedSQL, getNonAliasExpression, getNotIfPossible, getNullable, getSchemaName, getSQL, getSQL, getSQL, getSQL, getTableAlias, getTableName, getTypeIfStaticallyKnown, getWhenSQL, getWhenValue, isConstant, isIdentity, isNullConstant, isValueSet, isWhenConditionOperand, needParentheses, optimizeCondition, 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.util.HasSQL

getTraceSQL

Field Details

SOUNDEX

public static final int SOUNDEX

SOUNDEX() (non-standard).

See Also:

• Constant Field Values

DIFFERENCE

public static final int DIFFERENCE

DIFFERENCE() (non-standard).

See Also:

• Constant Field Values

Constructor Details

SoundexFunction

public SoundexFunction(Expression arg1,
 Expression arg2,
 int function)

Method Details

getValue

public Value getValue(SessionLocal session,
 Value v1,
 Value v2)

Description copied from class: Function1_2

Returns the value of this function.

Overrides:

getValue in class Function1_2

Parameters:

session - the session

v1 - the value of first argument

v2 - the value of second argument, or null

Returns:

the resulting value

optimize

public Expression optimize(SessionLocal session)

Description copied from class: Expression

Try to optimize the expression.

Specified by:

optimize in class Expression

Parameters:

session - the session

Returns:

the optimized expression

getName

public String getName()

Description copied from interface: NamedExpression

Get the name.

Returns:

the name in uppercase