Package wt.query

Class SQLFunction

java.lang.Object

wt.query.SQLFunction

All Implemented Interfaces:

Externalizable, Serializable, ColumnExpression, wt.query.Expression, OrderByExpression, RelationalExpression

Direct Known Subclasses:

AnalyticFunction

public class SQLFunction
extends Object
implements ColumnExpression, Externalizable

This class represents a SQL function within a SQL statement. Zero or more function arguments are supported.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABS	Supported API: true
static final String	ADD	Supported API: true
static final String	AVERAGE	Supported API: true
static final String	BITAND	Supported API: true
static final String	CEIL	Supported API: true
static final String	CONCAT	Supported API: true
static final String	COUNT	Supported API: true
static final String	DECODE	Supported API: true
static final String	DIVIDE	Supported API: true
static final String	FLOOR	Supported API: true
static final String	GET_DAY	Supported API: true
static final String	GET_HOURS	Supported API: true
static final String	GET_MINUTES	Supported API: true
static final String	GET_MONTH	Supported API: true
static final String	GET_SECONDS	Supported API: true
static final String	GET_YEAR	Supported API: true
static final String	IN_STRING	Supported API: true
static final String	LOG	Supported API: true
static final String	LOWER	Supported API: true
static final String	LTRIM	Supported API: true
static final String	MAXIMUM	Supported API: true
static final String	MINIMUM	Supported API: true
static final String	MOD	Supported API: true
static final String	MULTIPLY	Supported API: true
static final String	NLSSORT	Supported API: true
static final String	NULL_VALUE	Supported API: true
static final String	ROUND	Supported API: true
static final String	RTRIM	Supported API: true
static final String	SIGN	Supported API: true
static final String	SOUNDEX	Supported API: true
static final String	STDDEV	Supported API: true
static final String	SUB_STRING	Supported API: true
static final String	SUBTRACT	Supported API: true
static final String	SUM	Supported API: true
static final String	TO_CHAR	Supported API: true
static final String	TO_NUMBER	Supported API: true
static final String	TRUNCATE	Supported API: true
static final String	UPPER	Supported API: true

Fields inherited from interface wt.query.ColumnExpression

COLUMN_ALIAS

Method Summary

Modifier and Type	Method	Description
ColumnExpression	getArgumentAt(int a_position)	Returns the argument at the specfied position.
Vector	getArguments()	Gets the object for the association that plays role: arguments.
String	getColumnAlias()	Gets the value of the attribute: columnAlias; Alias for the column expression.
static SQLFunction	newSQLFunction(String a_functionName)	Constructs a new SQLFunction.
static SQLFunction	newSQLFunction(String a_functionName, ColumnExpression a_argument)	Constructs a new SQLFunction.
static SQLFunction	newSQLFunction(String a_functionName, ColumnExpression[] a_arguments)	Constructs a new SQLFunction.
static SQLFunction	newSQLFunction(String a_functionName, ColumnExpression a_argument_1, ColumnExpression a_argument_2)	Constructs a new SQLFunction.
static SQLFunction	newSQLFunction(String a_functionName, ColumnExpression a_argument_1, ColumnExpression a_argument_2, ColumnExpression a_argument_3)	Deprecated. As of 9.1, use newSQLFunction(String, ColumnExpression[])
void	setArgumentAt(ColumnExpression a_argument, int a_position)	Sets the argument at the specfied position.
void	setArguments(Vector a_Arguments)	Sets the object for the association that plays role: arguments.
void	setColumnAlias(String a_ColumnAlias)	Sets the value of the attribute: columnAlias; Alias for the column expression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ABS

public static final String ABS

Supported API: true

See Also:

• Constant Field Values

UPPER

public static final String UPPER

Supported API: true

See Also:

• Constant Field Values

LOWER

public static final String LOWER

Supported API: true

See Also:

• Constant Field Values

TO_CHAR

public static final String TO_CHAR

Supported API: true

See Also:

• Constant Field Values

AVERAGE

public static final String AVERAGE

Supported API: true

See Also:

• Constant Field Values

MAXIMUM

public static final String MAXIMUM

Supported API: true

See Also:

• Constant Field Values

MINIMUM

public static final String MINIMUM

Supported API: true

See Also:

• Constant Field Values

SUM

public static final String SUM

Supported API: true

See Also:

• Constant Field Values

COUNT

public static final String COUNT

Supported API: true

See Also:

• Constant Field Values

TRUNCATE

public static final String TRUNCATE

Supported API: true

See Also:

• Constant Field Values

CEIL

public static final String CEIL

Supported API: true

See Also:

• Constant Field Values

FLOOR

public static final String FLOOR

Supported API: true

See Also:

• Constant Field Values

LOG

public static final String LOG

Supported API: true

See Also:

• Constant Field Values

MOD

public static final String MOD

Supported API: true

See Also:

• Constant Field Values

ROUND

public static final String ROUND

Supported API: true

See Also:

• Constant Field Values

SIGN

public static final String SIGN

Supported API: true

See Also:

• Constant Field Values

LTRIM

public static final String LTRIM

Supported API: true

See Also:

• Constant Field Values

RTRIM

public static final String RTRIM

Supported API: true

See Also:

• Constant Field Values

SOUNDEX

public static final String SOUNDEX

Supported API: true

See Also:

• Constant Field Values

TO_NUMBER

public static final String TO_NUMBER

Supported API: true

See Also:

• Constant Field Values

NLSSORT

public static final String NLSSORT

Supported API: true

See Also:

• Constant Field Values

ADD

public static final String ADD

Supported API: true

See Also:

• Constant Field Values

SUBTRACT

public static final String SUBTRACT

Supported API: true

See Also:

• Constant Field Values

DIVIDE

public static final String DIVIDE

Supported API: true

See Also:

• Constant Field Values

MULTIPLY

public static final String MULTIPLY

Supported API: true

See Also:

• Constant Field Values

GET_SECONDS

public static final String GET_SECONDS

Supported API: true

See Also:

• Constant Field Values

GET_MINUTES

public static final String GET_MINUTES

Supported API: true

See Also:

• Constant Field Values

GET_HOURS

public static final String GET_HOURS

Supported API: true

See Also:

• Constant Field Values

GET_DAY

public static final String GET_DAY

Supported API: true

See Also:

• Constant Field Values

GET_MONTH

public static final String GET_MONTH

Supported API: true

See Also:

• Constant Field Values

GET_YEAR

public static final String GET_YEAR

Supported API: true

See Also:

• Constant Field Values

CONCAT

public static final String CONCAT

Supported API: true

See Also:

• Constant Field Values

SUB_STRING

public static final String SUB_STRING

Supported API: true

See Also:

• Constant Field Values

STDDEV

public static final String STDDEV

Supported API: true

See Also:

• Constant Field Values

IN_STRING

public static final String IN_STRING

Supported API: true

See Also:

• Constant Field Values

NULL_VALUE

public static final String NULL_VALUE

Supported API: true

See Also:

• Constant Field Values

DECODE

public static final String DECODE

Supported API: true

See Also:

• Constant Field Values

BITAND

public static final String BITAND

Supported API: true

See Also:

• Constant Field Values

Method Details

getArguments

public Vector getArguments()

Gets the object for the association that plays role: arguments.

Supported API: true

Returns:

Vector

setArguments

public void setArguments(Vector a_Arguments)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: arguments.

Supported API: true

Parameters:

a_Arguments -

Throws:

WTPropertyVetoException

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName)
                                  throws QueryException

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

Returns:

SQLFunction

Throws:

QueryException

getArgumentAt

public ColumnExpression getArgumentAt(int a_position)

Returns the argument at the specfied position.

Supported API: true

Parameters:

a_position - Position (0 based) to set the argument

Returns:

ColumnExpression

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName,
 ColumnExpression a_argument)
                                  throws QueryException

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

a_argument -

Returns:

SQLFunction

Throws:

QueryException

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName,
 ColumnExpression a_argument_1,
 ColumnExpression a_argument_2)
                                  throws QueryException

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

a_argument_1 -

a_argument_2 -

Returns:

SQLFunction

Throws:

QueryException

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName,
 ColumnExpression a_argument_1,
 ColumnExpression a_argument_2,
 ColumnExpression a_argument_3)
                                  throws QueryException

Deprecated.

As of 9.1, use newSQLFunction(String, ColumnExpression[])

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

a_argument_1 -

a_argument_2 -

a_argument_3 -

Returns:

SQLFunction

Throws:

QueryException

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName,
 ColumnExpression[] a_arguments)
                                  throws QueryException

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

a_arguments -

Returns:

SQLFunction

Throws:

QueryException

setArgumentAt

public void setArgumentAt(ColumnExpression a_argument,
 int a_position)
                   throws WTPropertyVetoException

Sets the argument at the specfied position.

Supported API: true

Parameters:

a_argument - Argument to set.

a_position - Position (0 based) to set the argument

Throws:

WTPropertyVetoException

getColumnAlias

public String getColumnAlias()

Gets the value of the attribute: columnAlias; Alias for the column expression.

Supported API: true

Specified by:

getColumnAlias in interface ColumnExpression

Specified by:

getColumnAlias in interface OrderByExpression

Returns:

String

setColumnAlias

public void setColumnAlias(String a_ColumnAlias)
                    throws WTPropertyVetoException

Sets the value of the attribute: columnAlias; Alias for the column expression.

Supported API: true

Specified by:

setColumnAlias in interface ColumnExpression

Parameters:

a_ColumnAlias -

Throws:

WTPropertyVetoException