planetj.dataengine.application
Class ApplicationSQLContext

java.lang.Object
  planetj.dataengine.AbstractContext
      planetj.database.SQLContext
          planetj.dataengine.application.ApplicationSQLContext

All Implemented Interfaces:

java.lang.Cloneable, IApplicationContext, IContext, INavigationObject, IOperationContext, java.io.Serializable

public class ApplicationSQLContext

extends SQLContext

implements IOperationContext

SQLContext used for queries which correspond to a specific Application or Operation

See Also:

Serialized Form

Field Summary

static java.lang.String

className

Fields inherited from class planetj.database.SQLContext

ALL_ROWS, CACHE_EXPIRATION_TIME_1_DAY, CACHE_EXPIRATION_TIME_1_HOUR, CACHE_EXPIRATION_TIME_1_WEEK, CACHE_EXPIRATION_TIME_15_MINUTES, CACHE_EXPIRATION_TIME_30_MINUTES, CACHE_EXPIRATION_TIME_NEVER, CACHING_CHECK, CACHING_CHECK_AND_STORE, CACHING_NONE, CACHING_STORE, LIBRARY_AS_SPECIFIED, LIBRARY_SYSTEM, LIBRARY_UNKNOWN, LIBRARY_USER

Fields inherited from class planetj.dataengine.AbstractContext

DEFAULT_TYPE, mCode, mLocked, mParameterized, mParameterNames, mParameterSource, mParameterValues, PARAM_ESCAPE_NUMBERED, PARAM_ESCAPE_TABLE, PARAM_ESCAPE_USAGE_ID, PARAM_ESCAPE_USER, PARAM_ESCAPE_USER_USAGE_ID, PARAM_NUMBERED, PARAM_TABLE, PARAM_USAGE_ID, PARAM_USER, PARAM_USER_USAGE_ID, TYPE_TABLE_PARAMETER

Constructor Summary

ApplicationSQLContext()
ListViewSQLContext constructor comment.

ApplicationSQLContext(java.lang.String pSystemAlias)
ListViewSQLContext constructor comment.

ApplicationSQLContext(java.lang.String pSystemAlias, ExecutingContext ec)
Constructor.

Method Summary

boolean	equals(java.lang.Object o) Checks to see if given Object to see if it is the same as this ApplicationSQLContext.
Application	getApplication() Gets this SQLContext's corresponding Application
int	getApplicationId() Gets this SQLContext's corresponding Application
java.lang.String	getCreationSource() Gets this context's source of where it was created.
Operation	getOperation() Gets this SQLContext's corresponding SQLOperation
int	getOperationId() Gets this SQLContext's corresponding Application
PropertyGroupList	getPropertyGroups() Get all the property groups stored in this RowCollection's attributes.
AbstractContext	getSecondaryContext(java.lang.String name) Gets the secondary context with the specified name, or null if no such secondary context exists
SQLOperation	getSQLOperation() Gets this SQLContext's corresponding SQLOperation
java.lang.String	getTitle() Gets the title for this operation.
int	hashCode() Creates the hash code for this ApplicationSQLContext.
void	setApplication(Application newApplication) Sets this SQLContext's corresponding Application
void	setApplicationId(int appId) Sets this SQLContext's corresponding Application
void	setMetaDataAlias(java.lang.String alias) Set the alias for the system the operation and application reside.
void	setOperationId(int id) Sets this SQLContext's corresponding Application
void	setParameterValues(Row row) Provides values for all of this context's RowParameters and ContextParameterParameters.
void	setSecondaryContext(java.lang.String name, AbstractContext ac) Sets the secondary context for a given name
SQLContext	setTitle(java.lang.String title) Sets the title of this SQLContext, which also becomes the title of its RC's
void	setView(View newView) Deprecated. use setOperation() instead
void	setViewId(int viewId) Deprecated. use setOperationId() instead

Methods inherited from class planetj.database.SQLContext

addListener, addTable, appendProperties, clear, clearTables, clone, cloneContext, cloneContext, execute, execute, finalize, getCachingLevel, getCachingTimeMillis, getConnection, getConnection, getConnectionAlias, getConnectionOwner, getExecutionRule, getFirstRowIndex, getHashcode, getKeyContext, getListeners, getLogicalFieldNames, getMetaDataAlias, getMode, getNumberOfTables, getParameterClass, getRectifiedCode, getReportBreakCollection, getReRunCount, getRowClass, getRowCollection, getRowCollectionClass, getRowCount, getRowCreator, getSafeSQL, getSourceRow, getSQL, getSQLDeleteStatement, getSQLInsertStatement, getSQLParameters, getSQLSelectStatement, getSQLStatement, getSQLUpdateStatement, getSystemAlias, getTable, getTable, getTables, getTimestamp, getTotalRecords, getTotalRecordsFromDB, getUsageIdRow, getUseWOWLibrary, hashCode, hasListeners, initializeAndStore, isAlterTableStatement, isAssociatedJoinOperationPresent, isAutoRefresh, isAutoStartWOWConnection, isBatch, isCacheResults, isCallStatement, isCheckCache, isCheckFieldDataFileForFDs, isDeleteStatement, isGroupByStatement, isInsertStatement, isMetaDataQuery, isParameterTokenEnd, isQuery, isReadTotalRecords, isResultSetRetained, isRowCollectionContext, isRunInBackground, isSelectStatement, isSourceRowPresent, isSystemAliasSpecified, isUnionStatement, isUpdate, isUpdateStatement, isUsePreparedStatement, isVoid, loadParameterRequestAndSessionValues, nextShift, parameterAltered, prepareForExecution, rectifyCode, removeFieldDescriptorIds, removeListener, removeTable, returnConnection, setAssociatedJoinOperationPresent, setAutoRefresh, setAutoStartWOWConnection, setBatch, setCacheResults, setCachingLevel, setCachingTimeMillis, setCheckCache, setCheckFieldDataFileForFDs, setCode, setCode, setConnection, setConnectionInternal, setExecutionRule, setFirstRowIndex, setKeyContext, setParameterValue, setReadTotalRecords, setRectifiedCode, setReportBreakCollection, setReportBreakCollection, setReRunCount, setResultSetRetained, setRowClass, setRowCollection, setRowCollectionClass, setRowCount, setRowCreator, setRowValues, setRunInBackground, setSourceRow, setSQL, setSQL, setSQLInternal, setSystemAlias, setTables, setTables, setTotalRecords, setUsageIdRow, setUsePreparedStatement, setUseWOWLibrary, toString

Methods inherited from class planetj.dataengine.AbstractContext

appendParameters, clearParameterValues, createParameter, equals, getCode, getDataTimestamp, getDisplayParameters, getExecutingContext, getFirstDisplayParameter, getFirstParameterForInput, getNavigationKey, getNavigationListKey, getOriginalCode, getParameter, getParameter, getParameterCollection, getParameterCount, getParameterCount, getParameterDisplayFields, getParameterDisplayFields, getParameterRow, getParameters, getParameters, getParameterSource, getParameterValidationExceptions, getParameterValuesType, getPrimaryContext, getPropertyGroup, getPropertyGroups, getRowParameters, handleParameter, isCloneNeeded, isContainsDisplayParameters, isContainsParameters, isLocked, isParameterized, isParameterTokenEnd, isRefreshing, isSecondaryContext, loadGlobalValues, loadSQLTextReplacementValues, loadUserAndExecutingContextValues, lock, removeNavigationKey, setCodeInternal, setCreationSource, setDataTimestamp, setExecutingContext, setNavigationKey, setParameterCollection, setParameterDisplayValues, setParameterValue, setParameterValue, setParameterValues, setParameterValuesType, setPrimaryContext, setRefreshing

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface planetj.dataengine.operation.IOperationContext

getDataTimestamp, setDataTimestamp

Methods inherited from interface planetj.dataengine.application.IApplicationContext

getMetaDataAlias

Methods inherited from interface planetj.dataengine.IContext

clone, getDisplayParameters, getExecutingContext, getOriginalCode, getParameter, getParameter, getParameterCount, getParameterCount, getParameters, getParameters, getParameterValidationExceptions, getParameterValuesType, getPropertyGroup, getPropertyGroups, isContainsDisplayParameters, isParameterized, isSecondaryContext, parameterAltered, setExecutingContext, setParameterValues

Field Detail

className

public static final java.lang.String className

Constructor Detail

ApplicationSQLContext

public ApplicationSQLContext()

ListViewSQLContext constructor comment.

ApplicationSQLContext

public ApplicationSQLContext(java.lang.String pSystemAlias)

ListViewSQLContext constructor comment.

Parameters:

pSystemAlias - java.lang.String

ApplicationSQLContext

public ApplicationSQLContext(java.lang.String pSystemAlias,
                             ExecutingContext ec)

Constructor.

Method Detail

equals

public boolean equals(java.lang.Object o)

Checks to see if given Object to see if it is the same as this ApplicationSQLContext.

Overrides:

equals in class SQLContext

Parameters:

o - Object to check for equality with

Returns:

true if the given Object is equal to this ApplicationSQLContext

getApplication

public Application getApplication()

Gets this SQLContext's corresponding Application

Specified by:

getApplication in interface IApplicationContext

getApplicationId

public int getApplicationId()

Gets this SQLContext's corresponding Application

Specified by:

getApplicationId in interface IApplicationContext

getCreationSource

public java.lang.String getCreationSource()

Description copied from class: AbstractContext

Gets this context's source of where it was created. Can be used logging purposes.

Overrides:

getCreationSource in class AbstractContext

getOperation

public Operation getOperation()

Gets this SQLContext's corresponding SQLOperation

Specified by:

getOperation in interface IOperationContext

getOperationId

public int getOperationId()

Gets this SQLContext's corresponding Application

Specified by:

getOperationId in interface IOperationContext

getPropertyGroups

public PropertyGroupList getPropertyGroups()

Get all the property groups stored in this RowCollection's attributes.

Specified by:

getPropertyGroups in interface IContext

Overrides:

getPropertyGroups in class SQLContext

getSecondaryContext

public AbstractContext getSecondaryContext(java.lang.String name)

Gets the secondary context with the specified name, or null if no such secondary context exists

getSQLOperation

public SQLOperation getSQLOperation()

Gets this SQLContext's corresponding SQLOperation

getTitle

public java.lang.String getTitle()

Gets the title for this operation. If the title is dynamic, then the parameter markers will be replaced by their values

Overrides:

getTitle in class SQLContext

hashCode

public int hashCode()

Creates the hash code for this ApplicationSQLContext.

Overrides:

hashCode in class SQLContext

Returns:

hash code for this context.

setApplication

public void setApplication(Application newApplication)

Sets this SQLContext's corresponding Application

setApplicationId

public void setApplicationId(int appId)

Sets this SQLContext's corresponding Application

Specified by:

setApplicationId in interface IApplicationContext

setMetaDataAlias

public void setMetaDataAlias(java.lang.String alias)

Description copied from interface: IApplicationContext

Set the alias for the system the operation and application reside.

Specified by:

setMetaDataAlias in interface IApplicationContext

setOperationId

public void setOperationId(int id)

Sets this SQLContext's corresponding Application

Specified by:

setOperationId in interface IOperationContext

setParameterValues

public void setParameterValues(Row row)
                        throws CMException

Provides values for all of this context's RowParameters and ContextParameterParameters. For each RowParameter, if the Row contains a field with the same name, then that Field's value is used to set that parameter. For each ConextParameterParameter, if the context contains the parameter number specified, its value is used.

Specified by:

setParameterValues in interface IContext

Overrides:

setParameterValues in class AbstractContext

Throws:

CMException

setSecondaryContext

public void setSecondaryContext(java.lang.String name,
                                AbstractContext ac)

Sets the secondary context for a given name

setTitle

public SQLContext setTitle(java.lang.String title)

Sets the title of this SQLContext, which also becomes the title of its RC's

Overrides:

setTitle in class SQLContext

setView

public void setView(View newView)

Deprecated. use setOperation() instead

Sets this SQLContext's corresponding View

setViewId

public void setViewId(int viewId)

Deprecated. use setOperationId() instead

Sets this SQLContext's corresponding Application