wt.query
Class SQLFunction

java.lang.Object
  wt.query.SQLFunction

All Implemented Interfaces:

ColumnExpression, Expression, Externalizable, OrderByExpression, RelationalExpression, Serializable

public final 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

Nested Class Summary

(package private) static class

SQLFunction.Info

Field Summary

static String	ABS Supported API: true
static String	ADD Supported API: true
private boolean	advancedQueryEnabled
private boolean	aggregate
private Vector	arguments
static String	AVERAGE Supported API: true
static String	BITAND Supported API: true
static String	CEIL Supported API: true
private static String	CLASSNAME
private String	columnAlias
static String	CONCAT Supported API: true
static String	COUNT Supported API: true
static Object	DATE_SQL_FORMAT
static String	DAY_FMT
static boolean	DEBUG
private static DebugWriter	DEBUG_LOG
static String	DECODE Supported API: true
static String	DIVIDE Supported API: true
private static DMLGenerator	dmlGenerator
static long	EXTERNALIZATION_VERSION_UID
static String	FLOOR Supported API: true
static String	GET_DAY Supported API: true
static String	GET_HOURS Supported API: true
static String	GET_MINUTES Supported API: true
static String	GET_MONTH Supported API: true
static String	GET_SECONDS Supported API: true
static String	GET_YEAR Supported API: true
static String	HOUR_FMT
static int	HOUR_PER_DAY
static String	IN_STRING Supported API: true
private static Hashtable	INFO_MAP
static String	LENGTH Supported API: false
static String	LOG Supported API: true
static String	LOWER Supported API: true
static String	LTRIM Supported API: true
static String	MATCH_NUMBER
static String	MATCH_STRING
static String	MATCH_TIMESTAMP
static String	MAXIMUM Supported API: true
private int	maximumArgumentCount
static String	MINIMUM Supported API: true
private int	minimumArgumentCount
static String	MINUTE_FMT
static String	MOD Supported API: true
static String	MONTH_FMT
static String	MULTIPLY Supported API: true
private String	name
static String	NLSSORT Supported API: true
static String	NULL_VALUE Supported API: true
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	ROUND Supported API: true
static String	RTRIM Supported API: true
(package private) static long	serialVersionUID
static String	SIGN Supported API: true
static String	SOUNDEX Supported API: true
static String	STDDEV Supported API: true
static String	SUB_STRING Supported API: true
static String	SUBTRACT Supported API: true
static String	SUM Supported API: true
static String	SYSDATE Supported API: false
static String	TIME_DIFFERENCE_IN_DAY
static String	TIME_DIFFERENCE_IN_HOUR
static Object	TIME_SQL_FORMAT
static Object	TIMESTAMP_SQL_FORMAT
static String	TO_CHAR Supported API: true
static String	TO_DATE Supported API: false
static String	TO_DATE_FUNCTION Deprecated. Use TO_DATE
static String	TO_NUMBER Supported API: true
static String	TRUNC_FUNC Deprecated. Use TRUNCATE
static String	TRUNCATE Supported API: true
static String	UPPER Supported API: true
static String	UPPER_FUNCTION Deprecated. Use UPPER
static String	YEAR_FMT

Fields inherited from interface wt.query.ColumnExpression

ADVANCED_QUERY, ADVANCED_QUERY_ENABLED, COLUMN_ALIAS, JAVA_TYPE

Fields inherited from interface wt.query.Expression

FROM_COUNT

Fields inherited from interface wt.query.RelationalExpression

BIND_PARAMETER

Constructor Summary

	SQLFunction() Supported API: false
	SQLFunction(String a_function) Deprecated. Use newSQLFunction()
private	SQLFunction(String a_function, boolean a_isAggregate, int a_minimumArgumentCount, int a_maximumArgumentCount)
	SQLFunction(String a_function, RelationalExpression a_arg1) Deprecated. Use newSQLFunction(String, ColumnExpression)
	SQLFunction(String a_function, RelationalExpression a_arg1, RelationalExpression a_arg2) Deprecated. Use newSQLFunction(String, ColumnExpression, ColumnExpression)
	SQLFunction(String function, String format) Deprecated. Replaced by SQLFunction(String, RelationalExpression, RelationalExpression)

Method Summary

private void	argumentsValidate(Vector a_Arguments)
ColumnExpression	getArgumentAt(int a_position) Returns the argument at the specfied position.
Vector	getArguments() Gets the object for the association that plays role: arguments.
Object	getBindParameter() Gets the value of the attribute: bindParameter; Returns a bind parameter for this expression (if supported).
ClassAttribute	getClassAttribute() Deprecated. at R6.0, use setArgumentAt(ColumnExpression, int) and getArguementAt(int)
List	getClassAttributes() Supported API: false
String	getColumnAlias() Gets the value of the attribute: columnAlias; Alias for the column expression.
private DMLGenerator	getDMLGenerator()
String	getExpression(boolean a_useBind, Vector a_tableInfos, Vector a_aliases, boolean a_outerJoin) Return string representation of this expression.
int	getFromCount() Gets the value of the attribute: fromCount; Number of from index values that this expression requires Supported API: false
static int	getFunctionCount() Gets the value of the attribute: functionCount; Returns the number of defined functions.
Class	getJavaType() Gets the value of the attribute: javaType; The java type of this expression.
int	getMaximumArgumentCount() Gets the value of the attribute: maximumArgumentCount.
int	getMinimumArgumentCount() Gets the value of the attribute: minimumArgumentCount.
String	getName() Gets the value of the attribute: name; Specifies the function name.
boolean	isAdvancedQuery() Gets the value of the attribute: advancedQuery; Indicates if the expression uses advanced query capabilities.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
boolean	isAggregate() Gets the value of the attribute: aggregate.
static Enumeration	list() Lists all defined SQL Functions.
static Vector	list(boolean a_scalarOnly, int a_minimumArgumentCount, int a_maximumArgumentCount) Lists all defined SQL Functions meeting that match the specified parameters.
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) Constructs a new SQLFunction.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SQLFunction thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.
void	setArgumentAt(ColumnExpression a_argument, int a_position) Sets the argument at the specfied position.
void	setArgumentAt(RelationalExpression a_argument, int a_position) Deprecated. Use setArgumentAt(ColumnExpression, int)
void	setArguments(Vector a_Arguments) Sets the object for the association that plays role: arguments.
void	setClassAttribute(ClassAttribute a_ClassAttribute) Deprecated. at R6.0, use setArgumentAt(ColumnExpression, int) and getArguementAt(int)
void	setColumnAlias(String a_ColumnAlias) Sets the value of the attribute: columnAlias; Alias for the column expression.
int	setFromAlias(String[] a_aliases, int a_offset) This method sets the FROM clause alias for this expression.
String	toString() Formats a string representation of this function.
int	validate(TableExpression[] a_tableExpressions, int a_offset) This method validates this expression against the specified table expression.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

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

aggregate

private boolean aggregate

minimumArgumentCount

private int minimumArgumentCount

maximumArgumentCount

private int maximumArgumentCount

TO_DATE

public static final String TO_DATE

Supported API: false

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

LENGTH

public static final String LENGTH

Supported API: false

See Also:

Constant Field Values

SYSDATE

public static final String SYSDATE

Supported API: false

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

arguments

private Vector arguments

columnAlias

private String columnAlias

advancedQueryEnabled

private transient boolean advancedQueryEnabled

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

MATCH_STRING

public static final String MATCH_STRING

See Also:

Constant Field Values

MATCH_NUMBER

public static final String MATCH_NUMBER

See Also:

Constant Field Values

MATCH_TIMESTAMP

public static final String MATCH_TIMESTAMP

See Also:

Constant Field Values

DEBUG

public static final boolean DEBUG

DEBUG_LOG

private static final DebugWriter DEBUG_LOG

MINUTE_FMT

public static final String MINUTE_FMT

See Also:

Constant Field Values

HOUR_FMT

public static final String HOUR_FMT

See Also:

Constant Field Values

DAY_FMT

public static final String DAY_FMT

See Also:

Constant Field Values

MONTH_FMT

public static final String MONTH_FMT

See Also:

Constant Field Values

YEAR_FMT

public static final String YEAR_FMT

See Also:

Constant Field Values

HOUR_PER_DAY

public static final int HOUR_PER_DAY

See Also:

Constant Field Values

TIME_DIFFERENCE_IN_DAY

public static final String TIME_DIFFERENCE_IN_DAY

See Also:

Constant Field Values

TIME_DIFFERENCE_IN_HOUR

public static final String TIME_DIFFERENCE_IN_HOUR

See Also:

Constant Field Values

TRUNC_FUNC

public static final String TRUNC_FUNC

Deprecated. Use TRUNCATE

See Also:

Constant Field Values

TO_DATE_FUNCTION

public static final String TO_DATE_FUNCTION

Deprecated. Use TO_DATE

See Also:

Constant Field Values

UPPER_FUNCTION

public static final String UPPER_FUNCTION

Deprecated. Use UPPER

See Also:

Constant Field Values

DATE_SQL_FORMAT

public static final Object DATE_SQL_FORMAT

TIME_SQL_FORMAT

public static final Object TIME_SQL_FORMAT

TIMESTAMP_SQL_FORMAT

public static final Object TIMESTAMP_SQL_FORMAT

INFO_MAP

private static final Hashtable INFO_MAP

dmlGenerator

private static DMLGenerator dmlGenerator

Constructor Detail

SQLFunction

public SQLFunction()

Supported API: false

SQLFunction

public SQLFunction(String a_function)

Deprecated. Use newSQLFunction()

Supported API: false

Parameters:

a_function - Specifies the function name.

SQLFunction

public SQLFunction(String a_function,
                   RelationalExpression a_arg1)

Deprecated. Use newSQLFunction(String, ColumnExpression)

Supported API: false

Parameters:

a_function - Specifies the function name.

a_arg1 - Specifies the first argument to the function.

SQLFunction

public SQLFunction(String a_function,
                   RelationalExpression a_arg1,
                   RelationalExpression a_arg2)

Deprecated. Use newSQLFunction(String, ColumnExpression, ColumnExpression)

Supported API: false

Parameters:

a_function - Specifies the function name.

a_arg1 - Specifies the first argument to the function.

a_arg2 - Specifies the first argument to the function.

SQLFunction

private SQLFunction(String a_function,
                    boolean a_isAggregate,
                    int a_minimumArgumentCount,
                    int a_maximumArgumentCount)

Parameters:

a_function - Specifies the function name.

a_isAggregate - Specifies the first argument to the function.

a_minimumArgumentCount -

a_maximumArgumentCount -

SQLFunction

public SQLFunction(String function,
                   String format)
            throws QueryException

Deprecated. Replaced by SQLFunction(String, RelationalExpression, RelationalExpression)

Construct an instance

Parameters:

function - The function to be applied for persistent objects.

format - The format for the function.

Throws:

QueryException - Occurs if the given function/format pair is not supported.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SQLFunction thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getName

public String getName()

Gets the value of the attribute: name; Specifies the function name.

Supported API: false

Returns:

String

isAggregate

public boolean isAggregate()

Gets the value of the attribute: aggregate.

Supported API: false

Returns:

boolean

getMinimumArgumentCount

public int getMinimumArgumentCount()

Gets the value of the attribute: minimumArgumentCount.

Supported API: false

Returns:

int

getMaximumArgumentCount

public int getMaximumArgumentCount()

Gets the value of the attribute: maximumArgumentCount.

Supported API: false

Returns:

int

getFunctionCount

public static int getFunctionCount()

Gets the value of the attribute: functionCount; Returns the number of defined functions.

Supported API: false

Returns:

int

getClassAttribute

public ClassAttribute getClassAttribute()

Deprecated. at R6.0, use setArgumentAt(ColumnExpression, int) and getArguementAt(int)

Gets the value of the attribute: classAttribute; First argument, if it is a ClassAttribute

Supported API: false

Returns:

ClassAttribute

setClassAttribute

public void setClassAttribute(ClassAttribute a_ClassAttribute)
                       throws WTPropertyVetoException

Deprecated. at R6.0, use setArgumentAt(ColumnExpression, int) and getArguementAt(int)

Sets the value of the attribute: classAttribute; First argument, if it is a ClassAttribute

Supported API: false

Parameters:

a_ClassAttribute -

Throws:

WTPropertyVetoException

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

argumentsValidate

private void argumentsValidate(Vector a_Arguments)
                        throws WTPropertyVetoException

Parameters:

a_Arguments -

Throws:

WTPropertyVetoException

newSQLFunction

public static SQLFunction newSQLFunction(String a_functionName)

Constructs a new SQLFunction.

Supported API: true

Parameters:

a_functionName -

Returns:

SQLFunction

list

public static Enumeration list()

Lists all defined SQL Functions.

Supported API: false

Returns:

Enumeration

setArgumentAt

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

Deprecated. Use setArgumentAt(ColumnExpression, int)

Sets the argument at the specfied position.

Supported API: false

Parameters:

a_argument - Argument to set.

a_position - Position (0 based) to set the argument

Throws:

WTPropertyVetoException

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

list

public static Vector list(boolean a_scalarOnly,
                          int a_minimumArgumentCount,
                          int a_maximumArgumentCount)

Lists all defined SQL Functions meeting that match the specified parameters.

Supported API: false

Parameters:

a_scalarOnly - List only scalar functions.

a_minimumArgumentCount - List functions with minimum argument count greater than or equal to this value. If this value is less than 0, then this criteria is ignored.

a_maximumArgumentCount - List functions with maximum argument count less than or equal to this value. If this value is less than 0, then this criteria is ignored.

Returns:

Vector

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

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

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

getJavaType

public Class getJavaType()
                  throws WTException

Gets the value of the attribute: javaType; The java type of this expression.

Supported API: false

Specified by:

getJavaType in interface ColumnExpression

Returns:

Class

Throws:

WTException

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

Gets the value of the attribute: advancedQuery; Indicates if the expression uses advanced query capabilities.

Supported API: false

Specified by:

isAdvancedQuery in interface ColumnExpression

Returns:

boolean

Throws:

WTException

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

Gets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.

Supported API: false

Specified by:

isAdvancedQueryEnabled in interface ColumnExpression

Returns:

boolean

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

Sets the value of the attribute: advancedQueryEnabled; Indicates if advanced query capabilities are enabled.

Supported API: false

Specified by:

setAdvancedQueryEnabled in interface ColumnExpression

Parameters:

a_AdvancedQueryEnabled -

getFromCount

public int getFromCount()

Gets the value of the attribute: fromCount; Number of from index values that this expression requires

Supported API: false

Specified by:

getFromCount in interface Expression

Returns:

int

validate

public int validate(TableExpression[] a_tableExpressions,
                    int a_offset)
             throws QueryException

This method validates this expression against the specified table expression. A QueryException is thrown if this expression is not valid.

Supported API: false

Specified by:

validate in interface Expression

Parameters:

a_tableExpressions - Table expression to validate against.

a_offset - Offset index into the TableExpression array for the next valid TableExpression

Returns:

number of TableExpressions validated

Throws:

QueryException

setFromAlias

public int setFromAlias(String[] a_aliases,
                        int a_offset)

This method sets the FROM clause alias for this expression. This alias is used in this Expression in place of the corresponding TableExpression.

Supported API: false

Specified by:

setFromAlias in interface Expression

Parameters:

a_aliases - Array of aliases for expressions

a_offset - Offset index into the alias array for the next valid alias

Returns:

number of aliases used

getBindParameter

public Object getBindParameter()
                        throws WTException

Gets the value of the attribute: bindParameter; Returns a bind parameter for this expression (if supported).

Supported API: false

Specified by:

getBindParameter in interface RelationalExpression

Returns:

Object

Throws:

WTException

getExpression

public String getExpression(boolean a_useBind,
                            Vector a_tableInfos,
                            Vector a_aliases,
                            boolean a_outerJoin)
                     throws QueryException

Return string representation of this expression.

Supported API: false

Specified by:

getExpression in interface RelationalExpression

Parameters:

a_useBind - Indicates that bind variables should be used for this expression.

a_tableInfos -

a_aliases -

a_outerJoin - Indicates that outer join syntax should be used for this expression.

Returns:

String

Throws:

QueryException

getClassAttributes

public List getClassAttributes()

Supported API: false

Specified by:

getClassAttributes in interface RelationalExpression

Returns:

List

toString

public String toString()

Formats a string representation of this function.

getDMLGenerator

private DMLGenerator getDMLGenerator()