planetj.database.sql
Class ColumnToken

java.lang.Object
  planetj.database.sql.SQLToken
      planetj.database.sql.ColumnToken

All Implemented Interfaces:

java.io.Serializable

public class ColumnToken

extends SQLToken

See Also:

Serialized Form

Field Summary

Fields inherited from class planetj.database.sql.SQLToken

WHITE_SPACE

Constructor Summary

ColumnToken(java.lang.String pToken, SQLStatement pStatement)
ColumnToken constructor comment.

Method Summary

java.lang.String	getCompleteToken()
FieldDescriptorRow	getFieldDescriptor() Gets the FieldDescriptor for this database column referenced by this token
FieldDescriptorRow	getFieldDescriptor(java.lang.String pSystemAlias) Gets the FieldDescriptor for this database column referenced by this token
java.lang.String	getLibraryName() Insert the method's description here.
java.lang.String	getName()
Table	getTable(java.lang.String pSystemAlias) Gets the Table in which the column referenced by this ColumnToken exists.
java.lang.String	getTableName() Gets the name of the table the column exists in.
protected TableToken	getTableToken() Gets the TableToken this column pertains to if it is known.
void	setCompleteToken(java.lang.String token)
void	setDisplayColumnName(java.lang.String pName)
ColumnToken	setFieldDescriptor(FieldDescriptorRow pFDRow) Sets the FieldDescriptor for this database column referenced by this token.
protected void	setLibraryName(java.lang.String newLibraryName) Insert the method's description here.
protected void	setName(java.lang.String name)
protected void	setTableName(java.lang.String pTableName) Sets the name of the table the column exists in.
void	setToken(java.lang.String token)
java.lang.String	toString()

Methods inherited from class planetj.database.sql.SQLToken

getStatement, getToken, isTokenParameter, isTokenWhiteSpace, setStatement

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnToken

public ColumnToken(java.lang.String pToken,
                   SQLStatement pStatement)

ColumnToken constructor comment.

Parameters:

pToken - String to create this token from.

Method Detail

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor()
                                      throws CMException

Gets the FieldDescriptor for this database column referenced by this token

Throws:

CMException

See Also:

setFieldDescriptor

getFieldDescriptor

public FieldDescriptorRow getFieldDescriptor(java.lang.String pSystemAlias)
                                      throws CMException

Gets the FieldDescriptor for this database column referenced by this token

Throws:

CMException

See Also:

setFieldDescriptor

getLibraryName

public java.lang.String getLibraryName()

Insert the method's description here. Creation date: (1/31/03 3:39:24 PM)

Returns:

java.lang.String

setDisplayColumnName

public void setDisplayColumnName(java.lang.String pName)

getName

public java.lang.String getName()

getTable

public Table getTable(java.lang.String pSystemAlias)
               throws CMException

Gets the Table in which the column referenced by this ColumnToken exists.

Throws:

CMException

getTableName

public java.lang.String getTableName()

Gets the name of the table the column exists in. Null is returned if the table name is not specified.

Returns:

name of table column exists in.

getTableToken

protected TableToken getTableToken()
                            throws CMException

Gets the TableToken this column pertains to if it is known. If no table name was set on this ColumnToken, null is returned.

Throws:

CMException

getCompleteToken

public java.lang.String getCompleteToken()

setCompleteToken

public void setCompleteToken(java.lang.String token)

setFieldDescriptor

public ColumnToken setFieldDescriptor(FieldDescriptorRow pFDRow)
                               throws CMException

Sets the FieldDescriptor for this database column referenced by this token. This can be used to adjust or change the FD associated with this columnToken. For example, when performing a SQL such as: select ..... where concat(a,b) = ? we don't know what to use for the column token of the concat(a,b) if if a or b is used the desired external name, length, etc will not be appropriate since we are concating 2 fields... This method will allow a DerivedFieldDescriptor to be created and set for this column...

Throws:

CMException

setLibraryName

protected void setLibraryName(java.lang.String newLibraryName)

Insert the method's description here. Creation date: (1/31/03 3:39:24 PM)

Parameters:

newLibraryName - java.lang.String

setName

protected void setName(java.lang.String name)

setTableName

protected void setTableName(java.lang.String pTableName)

Sets the name of the table the column exists in.

Parameters:

pTableName - name of table column exists in.

setToken

public void setToken(java.lang.String token)

Overrides:

setToken in class SQLToken

toString

public java.lang.String toString()

Overrides:

toString in class SQLToken