org.hsqldb

Class FunctionCustom

java.lang.Object

org.hsqldb.Expression

org.hsqldb.FunctionSQL

org.hsqldb.FunctionCustom

All Implemented Interfaces:

java.lang.Cloneable

public class FunctionCustom
extends FunctionSQL

Implementation of HSQLDB functions that are not defined by the SQL standard.

Some functions are translated into equivalent SQL Standard functions.

Since:

1.9.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	openGroupDateTimeFunctions
static java.lang.String[]	openGroupNumericFunctions
static java.lang.String[]	openGroupStringFunctions
static java.lang.String[]	openGroupSystemFunctions

Fields inherited from class org.hsqldb.Expression

BINARY, LEFT, RIGHT, TERNARY, UNARY

Method Summary

Modifier and Type	Method and Description
Expression	getFunctionExpression()
java.lang.String	getSQL() For use with CHECK constraints.
static boolean	isRegularFunction(int tokenType)
static boolean	isValueFunction(int tokenType)
static FunctionSQL	newCustomFunction(java.lang.String token, int tokenType)
void	resolveTypes(Session session, Expression parent)
void	setArguments(Expression[] nodes)
static char[]	soundex(java.lang.String s) Returns a four character code representing the sound of the given String.

Methods inherited from class org.hsqldb.FunctionSQL

describe, equals, getValue, hashCode, isDeterministic, isValueFunction, newSQLFunction

Methods inherited from class org.hsqldb.Expression

checkValidCheckConstraint, duplicate, equals, getAggregatedValue, getColumn, getCondition, getConstantValueNoCheck, getResult, getRowValue, getSubqueries, getTable, getType, getUnkeyedColumns, hasCondition, isCorrelated, isFalse, isIndexable, isTrue, materialise, resolveCheckOrGenExpression, resolveColumnReferences, resolveColumnReferences, setCollation, setCondition, testCondition, updateAggregatingValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

openGroupNumericFunctions

public static final java.lang.String[] openGroupNumericFunctions

openGroupStringFunctions

public static final java.lang.String[] openGroupStringFunctions

openGroupDateTimeFunctions

public static final java.lang.String[] openGroupDateTimeFunctions

openGroupSystemFunctions

public static final java.lang.String[] openGroupSystemFunctions

Method Detail

newCustomFunction

public static FunctionSQL newCustomFunction(java.lang.String token,
                                            int tokenType)

isRegularFunction

public static boolean isRegularFunction(int tokenType)

isValueFunction

public static boolean isValueFunction(int tokenType)

setArguments

public void setArguments(Expression[] nodes)

Overrides:

setArguments in class FunctionSQL

getFunctionExpression

public Expression getFunctionExpression()

Overrides:

getFunctionExpression in class FunctionSQL

resolveTypes

public void resolveTypes(Session session,
                         Expression parent)

Overrides:

resolveTypes in class FunctionSQL

getSQL

public java.lang.String getSQL()

Description copied from class: Expression

For use with CHECK constraints. Under development. Currently supports a subset of expressions and is suitable for CHECK search conditions that refer only to the inserted/updated row. For full DDL reporting of VIEW select queries and CHECK search conditions, future improvements here are dependent upon improvements to SELECT query parsing, so that it is performed in a number of passes. An early pass should result in the query turned into an Expression tree that contains the information in the original SQL without any alterations, and with tables and columns all resolved. This Expression can then be preserved for future use. Table and column names that are not user-defined aliases should be kept as the HsqlName structures so that table or column renaming is reflected in the precompiled query.

Overrides:

getSQL in class FunctionSQL

soundex

public static char[] soundex(java.lang.String s)

Returns a four character code representing the sound of the given String. Non-ASCCI characters in the input String are ignored.

This method was rewritten for HSQLDB to comply with the description at http://www.archives.gov/research/census/soundex.html .

Parameters:

s - the String for which to calculate the 4 character SOUNDEX value

Returns:

the 4 character SOUNDEX value for the given String