HyperSQL Database 2.7.4 · org.hsqldb.FunctionSQL · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
pack-priv static final short[]	doubleParamList
pack-priv static final short[]	emptyParamList
private static final int	FUNC_ABS
protected static final int	FUNC_BIT_LENGTH
private static final int	FUNC_CARDINALITY
private static final int	FUNC_CEILING
protected static final int	FUNC_CHAR_LENGTH
private static final int	FUNC_CHAR_NORMALIZE
private static final int	FUNC_CURRENT_CATALOG
protected static final int	FUNC_CURRENT_DATE
private static final int	FUNC_CURRENT_DEFAULT_TRANSFORM_GROUP
private static final int	FUNC_CURRENT_PATH
private static final int	FUNC_CURRENT_ROLE
private static final int	FUNC_CURRENT_SCHEMA
protected static final int	FUNC_CURRENT_TIME
protected static final int	FUNC_CURRENT_TIMESTAMP
private static final int	FUNC_CURRENT_TRANSFORM_GROUP_FOR_TYPE
private static final int	FUNC_CURRENT_USER
private static final int	FUNC_EXP
protected static final int	FUNC_EXTRACT
private static final int	FUNC_FLOOR
protected static final int	FUNC_FOLD_LOWER
protected static final int	FUNC_FOLD_UPPER
protected static final int	FUNC_LN
protected static final int	FUNC_LOCALTIME
protected static final int	FUNC_LOCALTIMESTAMP
private static final int	FUNC_MAX_CARDINALITY
private static final int	FUNC_MOD
private static final int	FUNC_OCCURENCES_REGEX
protected static final int	FUNC_OCTET_LENGTH
private static final int	FUNC_OVERLAY_BINARY
pack-priv static final int	FUNC_OVERLAY_CHAR
private static final int	FUNC_POSITION_BINARY
protected static final int	FUNC_POSITION_CHAR
private static final int	FUNC_POSITION_REGEX
private static final int	FUNC_POWER
private static final int	FUNC_REGEX_TRANSLITERATION
private static final int	FUNC_SESSION_USER
private static final int	FUNC_SQRT
private static final int	FUNC_SUBSTRING_BINARY
protected static final int	FUNC_SUBSTRING_CHAR
private static final int	FUNC_SUBSTRING_REG_EXPR
private static final int	FUNC_SUBSTRING_REGEX
private static final int	FUNC_SYSTEM_USER
private static final int	FUNC_TRANSCODING
private static final int	FUNC_TRANSLITERATION
private static final int	FUNC_TRIM_ARRAY
private static final int	FUNC_TRIM_BINARY
protected static final int	FUNC_TRIM_CHAR
protected static final int	FUNC_USER
private static final int	FUNC_VALUE
private static final int	FUNC_WIDTH_BUCKET
pack-priv int	funcType
pack-priv boolean	isDeterministic
pack-priv boolean	isSQLValueFunction
pack-priv String	name
pack-priv static OrderedIntHashSet	nonDeterministicFuncSet
pack-priv static final short[]	noParamList
pack-priv static final short[]	optionalDoubleParamList
pack-priv static final short[]	optionalIntegerParamList
pack-priv static final short[]	optionalNoParamList
pack-priv static final short[]	optionalSingleParamList
pack-priv short[]	parseList
pack-priv short[]	parseListAlt
pack-priv static final short[]	quadParamList
pack-priv static IntValueHashMap<String>	regularFuncMap
pack-priv static final short[]	singleParamList
pack-priv static final short[]	tripleParamList
pack-priv static IntValueHashMap<String>	valueFuncMap

Constructor Summary

Access	Constructor and Description
protected	FunctionSQL()
protected	FunctionSQL(int id)

Method Summary

Modifier and Type	Method and Description
public String	describe(Session session, int blanks) Overrides org.hsqldb.Expression.describe. Returns a String representation of this object.
pack-priv boolean	equals(Expression other) Overrides org.hsqldb.Expression.equals. SIMPLE_COLUMN expressions can be of different Expression subclass types
pack-priv Object	getExtractValue(Session session, Object[] data)
public Expression	getFunctionExpression()
public String	getSQL() Overrides org.hsqldb.Expression.getSQL. For use with CHECK constraints.
public Object	getValue(Session session) Overrides org.hsqldb.Expression.getValue. Evaluates and returns this Function in the context of the session.
pack-priv Object	getValue(Session session, Object[] data)
public int	hashCode() Overrides org.hsqldb.Expression.hashCode. Returns a hash code value for this object.
public boolean	isDeterministic()
public boolean	isValueFunction()
public static FunctionSQL	newSQLFunction(String token, ParserDQL.CompileContext context)
public void	resolveTypes(Session session, Expression parent) Overrides org.hsqldb.Expression.resolveTypes.
public void	setArguments(Expression[] newNodes)

Inherited from org.hsqldb.Expression:: checkValidCheckConstraint collectAllExpressions collectAllSubqueries collectObjectNames collectRangeVariables collectRangeVariables convertToType costFactor countNulls duplicate equals equals equals getAggregatedValue getAlias getCheckSelect getColumn getColumnIndex getColumnName getCondition getConstantValueNoCheck getContextSQL getDataType getDegree getIndexableExpression getJoinRangeVariables getLeftNode getNodeDataType getNodeDataTypes getNullability getRangeVariable getResult getRightNode getRowValue getSimpleName getSubqueries getSubType getTable getType getUnkeyedColumns getValue getValueClassName hasAggregate hasCondition hasNonDeterministicFunction hasReference hasReference insertValuesIntoSubqueryTable isComposedOf isComposedOf isConditionRangeVariable isCorrelated isDistinctAggregate isDynamicParam isFalse isIndexable isSelfAggregate isTrue isUnresolvedParam materialise prepareTable replaceAliasInOrderBy replaceColumnReferences replaceExpressions replaceNode replaceRangeVariables resetColumnReferences resolveCheckOrGenExpression resolveColumnReferences resolveColumnReferences resolveColumnSet resolveColumnSet resolveGrantFilter setAggregate setAlias setAsConstantValue setAsConstantValue setAttributesAsColumn setCollation setCondition setCorrelatedReferences setDataType setLeftNode setNoOptimisation setRightNode setSubType swapLeftAndRightNodes testCondition updateAggregatingValue updateAggregatingValue

Field Detail

doubleParamList	back to summary
pack-priv static final short[] doubleParamList

emptyParamList	back to summary
pack-priv static final short[] emptyParamList

FUNC_ABS	back to summary
private static final int FUNC_ABS

FUNC_BIT_LENGTH	back to summary
protected static final int FUNC_BIT_LENGTH

FUNC_CARDINALITY	back to summary
private static final int FUNC_CARDINALITY

FUNC_CEILING	back to summary
private static final int FUNC_CEILING

FUNC_CHAR_LENGTH	back to summary
protected static final int FUNC_CHAR_LENGTH

FUNC_CHAR_NORMALIZE	back to summary
private static final int FUNC_CHAR_NORMALIZE

FUNC_CURRENT_CATALOG	back to summary
private static final int FUNC_CURRENT_CATALOG

FUNC_CURRENT_DATE	back to summary
protected static final int FUNC_CURRENT_DATE

FUNC_CURRENT_DEFAULT_TRANSFORM_GROUP	back to summary
private static final int FUNC_CURRENT_DEFAULT_TRANSFORM_GROUP

FUNC_CURRENT_PATH	back to summary
private static final int FUNC_CURRENT_PATH

FUNC_CURRENT_ROLE	back to summary
private static final int FUNC_CURRENT_ROLE

FUNC_CURRENT_SCHEMA	back to summary
private static final int FUNC_CURRENT_SCHEMA

FUNC_CURRENT_TIME	back to summary
protected static final int FUNC_CURRENT_TIME

FUNC_CURRENT_TIMESTAMP	back to summary
protected static final int FUNC_CURRENT_TIMESTAMP

FUNC_CURRENT_TRANSFORM_GROUP_FOR_TYPE	back to summary
private static final int FUNC_CURRENT_TRANSFORM_GROUP_FOR_TYPE

FUNC_CURRENT_USER	back to summary
private static final int FUNC_CURRENT_USER

FUNC_EXP	back to summary
private static final int FUNC_EXP

FUNC_EXTRACT	back to summary
protected static final int FUNC_EXTRACT

FUNC_FLOOR	back to summary
private static final int FUNC_FLOOR

FUNC_FOLD_LOWER	back to summary
protected static final int FUNC_FOLD_LOWER

FUNC_FOLD_UPPER	back to summary
protected static final int FUNC_FOLD_UPPER

FUNC_LN	back to summary
protected static final int FUNC_LN

FUNC_LOCALTIME	back to summary
protected static final int FUNC_LOCALTIME

FUNC_LOCALTIMESTAMP	back to summary
protected static final int FUNC_LOCALTIMESTAMP

FUNC_MAX_CARDINALITY	back to summary
private static final int FUNC_MAX_CARDINALITY

FUNC_MOD	back to summary
private static final int FUNC_MOD

FUNC_OCCURENCES_REGEX	back to summary
private static final int FUNC_OCCURENCES_REGEX

FUNC_OCTET_LENGTH	back to summary
protected static final int FUNC_OCTET_LENGTH

FUNC_OVERLAY_BINARY	back to summary
private static final int FUNC_OVERLAY_BINARY

FUNC_OVERLAY_CHAR	back to summary
pack-priv static final int FUNC_OVERLAY_CHAR

FUNC_POSITION_BINARY	back to summary
private static final int FUNC_POSITION_BINARY

FUNC_POSITION_CHAR	back to summary
protected static final int FUNC_POSITION_CHAR

FUNC_POSITION_REGEX	back to summary
private static final int FUNC_POSITION_REGEX

FUNC_POWER	back to summary
private static final int FUNC_POWER

FUNC_REGEX_TRANSLITERATION	back to summary
private static final int FUNC_REGEX_TRANSLITERATION

FUNC_SESSION_USER	back to summary
private static final int FUNC_SESSION_USER

FUNC_SQRT	back to summary
private static final int FUNC_SQRT

FUNC_SUBSTRING_BINARY	back to summary
private static final int FUNC_SUBSTRING_BINARY

FUNC_SUBSTRING_CHAR	back to summary
protected static final int FUNC_SUBSTRING_CHAR

FUNC_SUBSTRING_REG_EXPR	back to summary
private static final int FUNC_SUBSTRING_REG_EXPR

FUNC_SUBSTRING_REGEX	back to summary
private static final int FUNC_SUBSTRING_REGEX

FUNC_SYSTEM_USER	back to summary
private static final int FUNC_SYSTEM_USER

FUNC_TRANSCODING	back to summary
private static final int FUNC_TRANSCODING

FUNC_TRANSLITERATION	back to summary
private static final int FUNC_TRANSLITERATION

FUNC_TRIM_ARRAY	back to summary
private static final int FUNC_TRIM_ARRAY

FUNC_TRIM_BINARY	back to summary
private static final int FUNC_TRIM_BINARY

FUNC_TRIM_CHAR	back to summary
protected static final int FUNC_TRIM_CHAR

FUNC_USER	back to summary
protected static final int FUNC_USER

FUNC_VALUE	back to summary
private static final int FUNC_VALUE

FUNC_WIDTH_BUCKET	back to summary
private static final int FUNC_WIDTH_BUCKET

funcType	back to summary
pack-priv int funcType

isDeterministic	back to summary
pack-priv boolean isDeterministic

isSQLValueFunction	back to summary
pack-priv boolean isSQLValueFunction

name	back to summary
pack-priv String name

nonDeterministicFuncSet	back to summary
pack-priv static OrderedIntHashSet nonDeterministicFuncSet

noParamList	back to summary
pack-priv static final short[] noParamList

optionalDoubleParamList	back to summary
pack-priv static final short[] optionalDoubleParamList

optionalIntegerParamList	back to summary
pack-priv static final short[] optionalIntegerParamList

optionalNoParamList	back to summary
pack-priv static final short[] optionalNoParamList

optionalSingleParamList	back to summary
pack-priv static final short[] optionalSingleParamList

parseList	back to summary
pack-priv short[] parseList

parseListAlt	back to summary
pack-priv short[] parseListAlt

quadParamList	back to summary
pack-priv static final short[] quadParamList

regularFuncMap	back to summary
pack-priv static IntValueHashMap<String> regularFuncMap

singleParamList	back to summary
pack-priv static final short[] singleParamList

tripleParamList	back to summary
pack-priv static final short[] tripleParamList

valueFuncMap	back to summary
pack-priv static IntValueHashMap<String> valueFuncMap

Constructor Detail

FunctionSQL	back to summary
protected FunctionSQL()

FunctionSQL	back to summary
protected FunctionSQL(int id)

Method Detail

describe

back to summary

public String describe(Session session, int blanks)

Overrides org.hsqldb.Expression.describe.

Returns a String representation of this object.

equals

back to summary

pack-priv boolean equals(Expression other)

Overrides org.hsqldb.Expression.equals.

Doc from org.hsqldb.Expression.equals.

SIMPLE_COLUMN expressions can be of different Expression subclass types

getExtractValue	back to summary
pack-priv Object getExtractValue(Session session, Object[] data)

getFunctionExpression	back to summary
public Expression getFunctionExpression()

getSQL

back to summary

public String getSQL()

Overrides org.hsqldb.Expression.getSQL.

Doc from org.hsqldb.Expression.getSQL.

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.

getValue

back to summary

public Object getValue(Session session)

Overrides org.hsqldb.Expression.getValue.

Evaluates and returns this Function in the context of the session.

getValue	back to summary
pack-priv Object getValue(Session session, Object[] data)

hashCode back to summary

public int hashCode()

Overrides org.hsqldb.Expression.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isDeterministic	back to summary
public boolean isDeterministic()

isValueFunction	back to summary
public boolean isValueFunction()

newSQLFunction	back to summary
public static FunctionSQL newSQLFunction(String token, ParserDQL.CompileContext context)

resolveTypes	back to summary
public void resolveTypes(Session session, Expression parent) Overrides org.hsqldb.Expression.resolveTypes.

setArguments	back to summary
public void setArguments(Expression[] newNodes)

public Class FunctionSQL

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail