planetj.dataengine.parameter
Class TableParameter

java.lang.Object
  |
  +--planetj.dataengine.parameter.AbstractParameter
        |
        +--planetj.dataengine.parameter.RequestParameter
              |
              +--planetj.dataengine.parameter.RequestPromptParameter
                    |
                    +--planetj.dataengine.parameter.TableParameter

All Implemented Interfaces:

Cloneable, IDisplayParameter, IJDBCSQLParameter, INamedParameter, IParameter, Serializable

public class TableParameter

extends RequestPromptParameter

A parameter whose value is a String which indentifies a table.

See Also:

Serialized Form

Field Summary

Fields inherited from interface planetj.dataengine.parameter.IParameter

CONTEXT_SPECIFIC_ID_END, CONTEXT_SPECIFIC_ID_START, DEFAULT_DATA_TYPE, ID_START, PARAMETER_INDEX_PREFIX

Constructor Summary

TableParameter()

Method Summary

FieldDescriptorRow	getDisplayFieldDescriptor() Gets the FieldDescriptor for this parameter.
TableDescriptor	getDisplayTableDescriptor() Gets the TableDescriptor for this parameter
String	getFullyQualifiedVirtualTableName() Gets the name of the virtual table (including the library name).
String	getOperationString() Gets a String representing an operation which applies to this parameter.
String	getRequestKey() Gets the key with which this parameter's value is stored in the request
String	getVirtualLibraryName() Gets the name of the library containing the virtual table.
Table	getVirtualTable() Gets the virtual table.
String	getVirtualTableName() Gets the name of the virtual table (not including the library name).
boolean	isSQLParameter() TableParameters can never be sent to the DB as parameters
Object	loadValueFromSource(Object source) Loads this parameter's value from a source.
void	setContext(IContext context) Sets the parameter's context
void	setOperationString(String os) Sets a String representing an operation which applies to this parameter.
void	setToken(String token) Sets the literal token that was used to denote this parameter in code.

Methods inherited from class planetj.dataengine.parameter.RequestPromptParameter

clearValue, cloneParameter, getDisplayField, getDisplayField, isDisplay, setDisplay

Methods inherited from class planetj.dataengine.parameter.RequestParameter

getParameterName

Methods inherited from class planetj.dataengine.parameter.AbstractParameter

clone, equals, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getDefaultValueAsString, getSource, getTargetFieldDescriptor, getToken, getValue, hashCode, setDataType, setDefaultValueAsString, setSource, setSQLParameter, setValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.parameter.IParameter

clone, getCodeReplacementString, getContext, getContextIndex, getContextSpecificId, getDataType, getSource, getTargetFieldDescriptor, getToken, getValue, setDataType, setSource, setValue

Methods inherited from interface planetj.dataengine.parameter.IJDBCSQLParameter

setSQLParameter

Constructor Detail

TableParameter

public TableParameter()

Method Detail

getDisplayFieldDescriptor

public FieldDescriptorRow getDisplayFieldDescriptor()
                                             throws CMException

Gets the FieldDescriptor for this parameter. This will be a TableDescriptor

CMException

getDisplayTableDescriptor

public TableDescriptor getDisplayTableDescriptor()
                                          throws CMException

Gets the TableDescriptor for this parameter

CMException

getFullyQualifiedVirtualTableName

public String getFullyQualifiedVirtualTableName()

Gets the name of the virtual table (including the library name). The virtual table is the table that the parameterized code refers to - it may not actually exist, and it may be replaced with a different table (which must exist) before the code is executed. The only requirement for a virtual table is that is must have a table descriptor

getOperationString

public String getOperationString()

Gets a String representing an operation which applies to this parameter. "<=", "IS NULL", and "BETWEEN" are all examples of possible operation strings

getRequestKey

public String getRequestKey()
                     throws CMException

Gets the key with which this parameter's value is stored in the request

Overrides:

getRequestKey in class RequestParameter

CMException

getVirtualLibraryName

public String getVirtualLibraryName()

Gets the name of the library containing the virtual table. The virtual table is the table that the parameterized code refers to - it may not actually exist, and it may be replaced with a different table (which must exist) before the code is executed. The only requirement for a virtual table is that is must have a table descriptor

getVirtualTable

public Table getVirtualTable()
                      throws CMException

Gets the virtual table. The virtual table is the table that the parameterized code refers to - it may not actually exist, and it may be replaced with a different table (which must exist) before the code is executed. The only requirement for a virtual table is that is must have a table descriptor

CMException

getVirtualTableName

public String getVirtualTableName()

Gets the name of the virtual table (not including the library name). The virtual table is the table that the parameterized code refers to - it may not actually exist, and it may be replaced with a different table (which must exist) before the code is executed. The only requirement for a virtual table is that is must have a table descriptor

isSQLParameter

public boolean isSQLParameter()

TableParameters can never be sent to the DB as parameters

Specified by:

isSQLParameter in interface IJDBCSQLParameter

Overrides:

isSQLParameter in class AbstractParameter

loadValueFromSource

public Object loadValueFromSource(Object source)
                           throws CMException

Loads this parameter's value from a source. The object passed in may be ignored if the parameter already knows the source from which its value should be extracted.

Specified by:

loadValueFromSource in interface IParameter

Overrides:

loadValueFromSource in class RequestParameter

CMException

setContext

public void setContext(IContext context)

Sets the parameter's context

Specified by:

setContext in interface IParameter

Overrides:

setContext in class AbstractParameter

setOperationString

public void setOperationString(String os)

Sets a String representing an operation which applies to this parameter. "<=", "IS NULL", and "BETWEEN" are all examples of possible operation strings

setToken

public void setToken(String token)
              throws CMException

Sets the literal token that was used to denote this parameter in code. Subclasses may override this method if they need to do additional processing on the token as long as they invoke the setTokenInternal() method to actually set the token

Specified by:

setToken in interface IParameter

Overrides:

setToken in class RequestPromptParameter

CMException