wt.query
Class KeywordExpression

java.lang.Object
  wt.query.KeywordExpression

All Implemented Interfaces:

Serializable, ColumnExpression, Expression, OrderByExpression, RelationalExpression

public class KeywordExpression
extends Object
implements ColumnExpression, Serializable

This class represents an expression that evaluates to a SQL keyword that can be used in a SQL statement. There is no special significance to the values represented by this class. When the value evaluates to a string representation it is not quoted and cannot be replaced with a bind parameter.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static KeywordExpression

NULL Constant keyword expression representing SQL NULL.

Fields inherited from interface wt.query.ColumnExpression

COLUMN_ALIAS

Method Summary

String	getColumnAlias() Gets the value of the attribute: columnAlias; Alias for the column expression.
static KeywordExpression	newKeywordExpression(KeywordExpression a_keyword) Creates a new KeywordExpression from the specified KeywordExpression constant.
static KeywordExpression	newKeywordExpression(KeywordExpression a_keyword, Class a_javaType) Creates a new KeywordExpression from the specified KeywordExpression constant and type.
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 Detail

NULL

public static final KeywordExpression NULL

Constant keyword expression representing SQL NULL.

Supported API: true

Method Detail

newKeywordExpression

public static KeywordExpression newKeywordExpression(KeywordExpression a_keyword)

Creates a new KeywordExpression from the specified KeywordExpression constant.

Supported API: true

Parameters:

a_keyword - Specifies the keyword.

Returns:

KeywordExpression

newKeywordExpression

public static KeywordExpression newKeywordExpression(KeywordExpression a_keyword,
                                                     Class a_javaType)
                                              throws WTException

Creates a new KeywordExpression from the specified KeywordExpression constant and type.

Supported API: true

Parameters:

a_keyword - Specifies the keyword.

a_javaType - Specifies the type of the Keyword expression.

Returns:

KeywordExpression

Throws:

WTException

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