wt.query
Class TableColumn

java.lang.Object
  wt.query.TableColumn

All Implemented Interfaces:

ColumnExpression, Expression, Externalizable, OrderByExpression, RelationalExpression, Serializable

public class TableColumn

extends Object

implements ColumnExpression, Externalizable

This class represents a table column which can be used in a SQL statement. The exact table and column name specified are used directly in the SQL statement. This class should generally be used when specifying a column that is associated with an ExternalTableExpression that has been added to a query or for a column on a FROM expression with a known table alias. Using this class with some TableExpression implementations, such as ClassTableExpression, can result in invalid SQL since the actual table name can vary for descendant classes.

Supported API: true

Extendable: false

See Also:

ExternalTableExpression, Serialized Form

Field Summary

private boolean	advancedQueryEnabled
private static String	CLASSNAME
private String	columnAlias
private String	columnName
static long	EXTERNALIZATION_VERSION_UID
private Class	javaType
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	tableName

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

TableColumn()


Supported API: false

TableColumn(String a_tableName, String a_columnName)


Supported API: true

Method Summary

Object	getBindParameter() Gets the value of the attribute: bindParameter; Returns a bind parameter for this expression (if supported).
List	getClassAttributes() Supported API: false
String	getColumnAlias() Gets the value of the attribute: columnAlias; Alias for the column expression.
String	getColumnName() Gets the value of the attribute: columnName; Column name in the external table.
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
Class	getJavaType() Gets the value of the attribute: javaType; The java type of this expression.
String	getTableName() Gets the value of the attribute: tableName; External table 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.
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(TableColumn 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	setColumnAlias(String a_ColumnAlias) Sets the value of the attribute: columnAlias; Alias for the column expression.
void	setColumnName(String a_ColumnName) Sets the value of the attribute: columnName; Column name in the external table.
int	setFromAlias(String[] a_aliases, int a_offset) This method sets the FROM clause alias for this expression.
void	setJavaType(Class a_JavaType) Sets the value of the attribute: javaType; The java type of this expression.
void	setTableName(String a_TableName) Sets the value of the attribute: tableName; External table name.
String	toString()
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

tableName

private String tableName

columnName

private String columnName

javaType

private Class javaType

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

Constructor Detail

TableColumn

public TableColumn()

Supported API: false

TableColumn

public TableColumn(String a_tableName,
                   String a_columnName)

Supported API: true

Parameters:

a_tableName - Name of the database table.

a_columnName - Name of the database column.

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(TableColumn 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

getTableName

public String getTableName()

Gets the value of the attribute: tableName; External table name.

Supported API: true

Returns:

String

setTableName

public void setTableName(String a_TableName)
                  throws WTPropertyVetoException

Sets the value of the attribute: tableName; External table name.

Supported API: true

Parameters:

a_TableName -

Throws:

WTPropertyVetoException

getColumnName

public String getColumnName()

Gets the value of the attribute: columnName; Column name in the external table.

Supported API: true

Returns:

String

setColumnName

public void setColumnName(String a_ColumnName)
                   throws WTPropertyVetoException

Sets the value of the attribute: columnName; Column name in the external table.

Supported API: true

Parameters:

a_ColumnName -

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

setJavaType

public void setJavaType(Class a_JavaType)
                 throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_JavaType -

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

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()