planetj.dataengine
Class DataEngineManager

java.lang.Object
  |
  +--planetj.dataengine.DataEngineManager

All Implemented Interfaces:

IApplicationJSPs, IDataEngine, IJSPPages, INavigation, IServletParameters, IWOWJSPs

public class DataEngineManager

extends Object

implements IDataEngine

!!DA (7/8/2003 11:34:33 AM) - needs documentation

Author:

PlanetJ Corporation

Field Summary

static String

className Class name.

Fields inherited from interface planetj.dataengine.IDataEngine

ACTION, ADMIN_MAGIC_REQUEST, ALL_SERVLET_PATHS, ALLOW_MULTIPLE_DELETES, ALLOW_MULTIPLE_SELECTION, APPLICATION, COMPANY, CONTEXT, CONTEXT_KEY, CONTROLLER_SERVLET_PATH, CONTROLLER_SERVLET_URI, CURRENT_SQL_CONTEXT, CURRENT_SQL_RECORD_COUNT, CURRENT_SQL_STRING, CURRENT_TOC, DATA_ENGINE_MESSAGE, DATAENGINE_ADMIN_SERVLET_PATH, DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH, DATAENGINE_APPLICATION_SERVLET_PATH, DATAEXPLORER_SERVLET_PATH, DE_ACTION_CATEGORY, DE_ACTION_SIGN_ON, DEFAULT_LAYOUT_DISPLAY_PROPERTIES, DEFAULT_RESULTS_KEY, DEFAULT_USER_LIBRARY, DETAILS, EDITABLE_OPERATIONS, ENVIRONMENT_MODE_DEVELOPMENT, ENVIRONMENT_MODE_PRODUCTION, ERROR_APPLICATION_INVALID, ERROR_COMPANY_INVALID, ERROR_MESSAGE, EXCEPTION, EXCEPTION_JSP_KEY, FIELD, FIELD_DESCRIPTOR_SERVLET_PATH, FIELD_LIST, FIELD_NAMES, FIELDS, FORM_LIB_TBL_FLD, FUNCTION, HIDDEN_APPLICATION_ID, HIDDEN_APPLICATION_METADATA_ALIAS, IGNORE_MAGIC_REQUEST, KEEP_INSERT_VALUES, LAST_JSP_CALLED, LAUNCHED_FROM_BUILDER, LIBRARY, LIBRARY_LIST, MAGIC_ACTION_ROW, MODE, MODE_COPY, MODE_DELETE, MODE_EDIT, MODE_INSERT, MODE_SEARCH, MODE_UNKNOWN, MODE_VIEW, MULTIPLESELECTION, NEW_ROW, NEW_WINDOW_FOR_RESULTS, NEXT_PAGE, NOSELECTION, OPERATION, OPERATION_KEY, OWNER_ID, PAGE, PAGE_REQUEST_EXECUTED, PAGE_VALIDATION_REQUIRED, PARAMETER_VALUE_PREFIX, PREVIOUS_PAGE, RESERVED_PARAMETERS, RETRIEVE_ALL_COLUMNS_ON_COPY, RETRIEVE_ALL_COLUMNS_ON_EDIT, RETRIEVE_ALL_COLUMNS_ON_VIEW, RETRIEVE_FIELDS, RETRIEVE_TABLES, RETURN_URI, ROW, ROW_ALTERNATE_KEY, ROW_COLLECTION, ROW_COLLECTION_KEY, ROW_KEY, ROW_KEY_FOR_DETAILS, ROW_SELECTION_JS_INCLUDED, ROWS_ALTERED_COUNT, SELECTED_ROW, SELECTED_ROW_COLLECTION, SELECTEDOBJECTS, SERVLET_CONTEXT, SESSION_RANDOM_NUMBER, SESSION_SIGNED_OFF, SESSION_SIGNON_RECEIPT_KEY, SESSION_TIMED_OUT, SHOW_FD_QUICK_LINKS, SHOW_UPDATABLE_TABLES, SHOW_UPDATEABLE_ROW, SIGN_ON_CALLER, SIGNON, SIGNON_AND_REGISTRATION_SERVLET_PATH, SINGLESELECTION, STATEMENT, SYSTEM, SYSTEMS_LIST, TABLE, TABLE_LIST, TRANSIENT, UNSUPPORTED, USER_LIBRARY_HTTP_PARAMETER, USER_LIBRARY_HTTP_SESSION_KEY, USER_MESSAGE, USER_PREFERENCES, VALID_SIGNON, WINDOW_CLOSE, WINDOW_NORMAL, WINDOW_POPUP, WINDOW_TYPE_PARAM

Fields inherited from interface planetj.dataengine.INavigation

CHILD_PREFIX, GROUP_ATTRIBUTES, GROUP_ID, INITIAL_GROUP_ID, INITIAL_PAGE_ID, INITIAL_REQUEST_ID, NAVIGATION_CHECKED, NAVIGATION_OBJECT_LIST_PREFIX, NEW_GROUP_ID, NEW_REQUEST_ID, NEW_SESSION_ID, PAGE_ATTRIBUTES, PAGE_ID, PARENT_PREFIX, PERSISTENT_ATTRIBUTES, PREVIOUS_ATTRIBUTES, PREVIOUS_GROUP_ID, PREVIOUS_PAGE_ID, PREVIOUS_REQUEST_ID, REQUEST_ID, RESET_GROUP_ID, RESET_NAVIGATION_IDS, RESET_NAVIGATION_IDS_COMPLETED, RESET_PAGE_ID, RESET_REQUEST_ID, RESET_SESSION_ID, SESSION_ID

Fields inherited from interface planetj.dataengine.IServletParameters

ALL, AUTO_RUN, BASE_URL, CACHE_TRACK_ON, CACHE_TRACK_WRITE_TO_FILE, CLEAN_UP_TIME, DATABASE, DRIVER, ENVIRONMENT_MODE, JDBC_OPTIMIZATIONS, MAX_CONNECTIONS, METADATA_LIBRARY, MIN_CONNECTIONS, ORPHAN_TIMEOUT, PASSWORD, PORT, SYSTEM_ALIAS, SYSTEM_ALIAS_PARAM, SYSTEM_URL, USER_ID, USER_PASSWORD

Fields inherited from interface planetj.dataengine.IJSPPages

CUSTOM_LOG_ON_JSP, DEFAULT_ADD_BODY_JSP, DEFAULT_EDIT_BODY_JSP, DEFAULT_PARAMS_JSP, DEFAULT_PRINT_PAGE_JSP, DEFAULT_RESULTS_JSP, DEFAULT_ROW_DETAILS, DEFAULT_SQL_OPERATION_RESULTS_JSP, DEFAULT_VIEW_BODY_JSP, DETAILS_JSP, DISPLAY_EXCEPTION_JSP, INITIAL_JSP, SIGN_ON_BODY_JSP, SIGN_ON_JSP, SIGNON_PARAMS_JSP

Fields inherited from interface planetj.dataengine.application.IApplicationJSPs

APPLICATION_ADD_JSP, APPLICATION_DETAILS_JSP, APPLICATION_EDIT_JSP, APPLICATION_ERROR_JSP, APPLICATION_HEADER_JSP, APPLICATION_INVALID_LICENSE_JSP, APPLICATION_JSP, APPLICATION_MESSAGE_JSP, APPLICATION_OPERATIONS_TOC, APPLICATION_RESULTS_JSP, APPLICATION_SIGN_ON_JSP, APPLICATION_TEMPLATE_JSP, APPLICATION_TOC_JSP, APPLICATION_VIEW_JSP

Fields inherited from interface planetj.dataengine.application.IWOWJSPs

WOW_MAIN_EXCEPTION_JSP, WOW_MANAGE_OPERATIONS_JSP, WOW_STEPS_JSP, WOW_TOC, WOW_VIEW_APPLICATIONS_JSP, WOW_VIEW_CONNECTIONS_JSP

Constructor Summary

DataEngineManager()

Method Summary

static String	getContextNavigationKey(Operation operation)
static Row	getCurrentAlternateRow(javax.servlet.http.HttpServletRequest request) Gets the current Alternate Row from the request.
static Application	getCurrentApplication(javax.servlet.http.HttpServletRequest request) Gets the current executing application from navigation.
static AbstractContext	getCurrentContext(javax.servlet.http.HttpServletRequest request) Gets the current AbstractContext from the request.
static String	getCurrentContextKey(javax.servlet.http.HttpServletRequest request) Gets the current AbstractContext key from the request.
static ExecutingContext	getCurrentExecutingContext(javax.servlet.http.HttpServletRequest request) Deprecated. replaced with getCurrentExecutingContext(HttpServletRequest, HttpServletResponse) to allow proper setting of request and response on executing context.
static ExecutingContext	getCurrentExecutingContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets the current executing context
static Operation	getCurrentOperation(javax.servlet.http.HttpServletRequest request) Gets the current Operation from the request.
static String	getCurrentOperationKey(javax.servlet.http.HttpServletRequest request) Gets the current Operation key from the request.
static Row	getCurrentRow(javax.servlet.http.HttpServletRequest request) Gets the current Row from the request.
static RowCollection	getCurrentRowCollection(javax.servlet.http.HttpServletRequest request) Gets the current RowCollection from the request.
static String	getCurrentRowCollectionKey(javax.servlet.http.HttpServletRequest request) Gets the current RowCollection key from the request.
static String	getCurrentRowKey(javax.servlet.http.HttpServletRequest request) Gets the current Row key from the request.
static SignOnReceipt	getCurrentUser(javax.servlet.http.HttpServletRequest request) Gets the current executing application from navigation.
static ExecutingContext	getExistingExecutingContext(javax.servlet.http.HttpServletRequest request) Gets the current executing context
static int	getIntMode(javax.servlet.http.HttpServletRequest req) Gets the current mode as one of the constants defined in the Row class
static int	getIntMode(Object mode) Gets the current mode as one of the constants defined in the Row class
static LayoutDisplayPropertyGroup	getLayoutProperties(boolean create, javax.servlet.http.HttpServletRequest request) Gets the current layout properties from the navigation request.
static LayoutDisplayPropertyGroup	getLayoutProperties(javax.servlet.http.HttpServletRequest request) Gets the current layout properties from the navigation request.
static String	getNavigationSuffix(Operation operation)
static String	getOperationNavigationKey(Operation operation)
static RowCollection	getRowCollection(Operation operation, javax.servlet.http.HttpServletRequest request) Gets the RowCollection for the given Operation out of the request.
static String	getRowCollectionNavigationKey(Operation operation)
static String	getRowNavigationKey(Operation operation)
static UserProperties	getUserProperties(boolean create, javax.servlet.http.HttpServletRequest request) Gets the default UserProperties from the session.
static UserProperties	getUserProperties(javax.servlet.http.HttpServletRequest request) Gets the default UserProperties from the session.
static void	handleFeature(IFeature feature, javax.servlet.http.HttpServletRequest req) Handles the feature, possibly causing a warning to be displayed
static void	setCurrentAlternateRow(Row row, javax.servlet.http.HttpServletRequest request) Set the current Alternate Row key.
static void	setCurrentApplication(Application application, javax.servlet.http.HttpServletRequest request) Gets the current executing application from navigation.
static void	setCurrentKeys(Operation operation, javax.servlet.http.HttpServletRequest request) Sets the current keys for objects associated with this operation.
static void	setCurrentRowCollectionKey(String key, javax.servlet.http.HttpServletRequest request) Set the current RowCollection key.
static void	setCurrentRowKey(String key, javax.servlet.http.HttpServletRequest request) Set the current Row key.
static void	setLayoutProperties(LayoutDisplayPropertyGroup layoutProperties, javax.servlet.http.HttpServletRequest request) Sets layout properties int the current navigation request.
static void	setUserProperties(UserProperties properties, javax.servlet.http.HttpServletRequest request) Sets the default UserProperties from the session.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

className

public static final String className

Class name.

Constructor Detail

DataEngineManager

public DataEngineManager()

Method Detail

getContextNavigationKey

public static String getContextNavigationKey(Operation operation)
                                      throws CMException

CMException

getCurrentApplication

public static Application getCurrentApplication(javax.servlet.http.HttpServletRequest request)

Gets the current executing application from navigation.

getCurrentContext

public static AbstractContext getCurrentContext(javax.servlet.http.HttpServletRequest request)

Gets the current AbstractContext from the request. If no IDataEngine.CONTEXT_KEY was specified in the request the default key IDataEngine.CONTEXT is used.

getCurrentContextKey

public static String getCurrentContextKey(javax.servlet.http.HttpServletRequest request)

Gets the current AbstractContext key from the request. If no IDataEngine.CONTEXT_KEY was specified in the request the default key IDataEngine.CONTEXT is used.

getCurrentExecutingContext

public static ExecutingContext getCurrentExecutingContext(javax.servlet.http.HttpServletRequest request)

Deprecated. replaced with getCurrentExecutingContext(HttpServletRequest, HttpServletResponse) to allow proper setting of request and response on executing context.

Gets the current executing context.

getCurrentExecutingContext

public static ExecutingContext getCurrentExecutingContext(javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)

Gets the current executing context

getCurrentOperation

public static Operation getCurrentOperation(javax.servlet.http.HttpServletRequest request)

Gets the current Operation from the request. If no IDataEngine.OPERATION_KEY was specified in the request the default key IDataEngine.OPERATION is used.

getCurrentOperationKey

public static String getCurrentOperationKey(javax.servlet.http.HttpServletRequest request)

Gets the current Operation key from the request. If no IDataEngine.OPERATION_KEY was specified in the request the default key IDataEngine.OPERATION is used.

getCurrentRow

public static Row getCurrentRow(javax.servlet.http.HttpServletRequest request)

Gets the current Row from the request. If no IDataEngine.ROW_KEY was specified in the request the default key IDataEngine.ROW is used.

getCurrentAlternateRow

public static Row getCurrentAlternateRow(javax.servlet.http.HttpServletRequest request)

Gets the current Alternate Row from the request. If no alternate row is set, null is returned. The alternate row can be used to override the current row Jun 22, 2004 1:55:07 PM

Returns:

Row

getCurrentRowCollection

public static RowCollection getCurrentRowCollection(javax.servlet.http.HttpServletRequest request)

Gets the current RowCollection from the request. If no IDataEngine.ROW_COLLECTION_KEY was specified in the request the default key IDataEngine.ROW_COLLECTION is used.

getCurrentRowCollectionKey

public static String getCurrentRowCollectionKey(javax.servlet.http.HttpServletRequest request)

Gets the current RowCollection key from the request. If no IDataEngine.ROW_COLLECTION_KEY was specified in the request the default key IDataEngine.ROW_COLLECTION is used.

getCurrentRowKey

public static String getCurrentRowKey(javax.servlet.http.HttpServletRequest request)

Gets the current Row key from the request. If no IDataEngine.ROW_KEY was specified in the request the default key IDataEngine.ROW is used.

getCurrentUser

public static SignOnReceipt getCurrentUser(javax.servlet.http.HttpServletRequest request)

Gets the current executing application from navigation.

getExistingExecutingContext

public static ExecutingContext getExistingExecutingContext(javax.servlet.http.HttpServletRequest request)

Gets the current executing context

getIntMode

public static int getIntMode(Object mode)

Gets the current mode as one of the constants defined in the Row class

getIntMode

public static int getIntMode(javax.servlet.http.HttpServletRequest req)

Gets the current mode as one of the constants defined in the Row class

getLayoutProperties

public static LayoutDisplayPropertyGroup getLayoutProperties(javax.servlet.http.HttpServletRequest request)

Gets the current layout properties from the navigation request.

getLayoutProperties

public static LayoutDisplayPropertyGroup getLayoutProperties(boolean create,
                                                             javax.servlet.http.HttpServletRequest request)

Gets the current layout properties from the navigation request.

getNavigationSuffix

public static String getNavigationSuffix(Operation operation)
                                  throws CMException

CMException

getOperationNavigationKey

public static String getOperationNavigationKey(Operation operation)
                                        throws CMException

CMException

getRowCollection

public static RowCollection getRowCollection(Operation operation,
                                             javax.servlet.http.HttpServletRequest request)
                                      throws CMException

Gets the RowCollection for the given Operation out of the request. The Operation is used to generate the RowCollection's key to look up.

Parameters:

operation - Operation used to generate the RowCollection navigation key

request - HttpServletRequest from the client

Returns:

a RowCollection from the request if one exists for the given operation

CMException

getRowCollectionNavigationKey

public static String getRowCollectionNavigationKey(Operation operation)
                                            throws CMException

CMException

getRowNavigationKey

public static String getRowNavigationKey(Operation operation)
                                  throws CMException

CMException

getUserProperties

public static UserProperties getUserProperties(javax.servlet.http.HttpServletRequest request)

Gets the default UserProperties from the session.

getUserProperties

public static UserProperties getUserProperties(boolean create,
                                               javax.servlet.http.HttpServletRequest request)

Gets the default UserProperties from the session.

handleFeature

public static void handleFeature(IFeature feature,
                                 javax.servlet.http.HttpServletRequest req)
                          throws CMException

Handles the feature, possibly causing a warning to be displayed

CMException

setCurrentApplication

public static void setCurrentApplication(Application application,
                                         javax.servlet.http.HttpServletRequest request)

Gets the current executing application from navigation.

setCurrentKeys

public static void setCurrentKeys(Operation operation,
                                  javax.servlet.http.HttpServletRequest request)
                           throws CMException

Sets the current keys for objects associated with this operation.

CMException

setCurrentRowCollectionKey

public static void setCurrentRowCollectionKey(String key,
                                              javax.servlet.http.HttpServletRequest request)
                                       throws CMException

Set the current RowCollection key.

CMException

setCurrentRowKey

public static void setCurrentRowKey(String key,
                                    javax.servlet.http.HttpServletRequest request)
                             throws CMException

Set the current Row key.

CMException

setCurrentAlternateRow

public static void setCurrentAlternateRow(Row row,
                                          javax.servlet.http.HttpServletRequest request)

Set the current Alternate Row key.

setLayoutProperties

public static void setLayoutProperties(LayoutDisplayPropertyGroup layoutProperties,
                                       javax.servlet.http.HttpServletRequest request)

Sets layout properties int the current navigation request.

setUserProperties

public static void setUserProperties(UserProperties properties,
                                     javax.servlet.http.HttpServletRequest request)

Sets the default UserProperties from the session.