|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectplanetj.database.Row
planetj.database.connection.ConnectionRow
Class generated by planetj.dataengine.RowClassGenerator Created at: Wed Apr 10 19:24:10 PDT 2002
Nested Class Summary |
Nested classes inherited from class planetj.database.Row |
Row.SpacingRow |
Field Summary | |
static java.lang.String |
ACTION_RESTART
|
static java.lang.String |
ACTION_START
|
static java.lang.String |
ACTION_STOP
|
Fields inherited from class planetj.database.Row |
className, DISPLAY_ORDER_COMPARATOR, MODE_ALTER, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, mRowEventListeners |
Fields inherited from interface planetj.database.connection.IConnections |
ALIAS, AUTO_VERIFY, CLEAN_UP_TIMEOUT, CONNECTION_CLASS, CONNECTION_TABLE_NAME, DRIVER, ENCODED_USER_PASSWORD, FD_MANAGER, MAX_CONNECTIONS, MAX_SYSTEM_ALIAS_NAME_LENGTH, MIN_CONNECTIONS, ORPHAN_TIMEOUT, OWNER_ID, PASSWORD, PROPERTIES, STATUS, URL, USER_ID, VIEW_ADVANCED_SETTINGS |
Fields inherited from interface planetj.dataengine.security.IGuarded |
TYPE_ID_UNKNOWN, TYPE_NAME_FIELD, TYPE_NAME_SQLOPERATION, TYPE_SECURED_BY_LEVEL, TYPE_SECURED_BY_OPERATION, TYPE_UNSECURED |
Constructor Summary | |
ConnectionRow()
|
Method Summary | |
void |
closeConnectionPool()
Close the connection pool for this ConnectionRow exists. |
ConnectionRow |
createConnectionPool()
Create a connection pool based on the specific values of this Row. |
Row |
createRow(Row pDefaultRow)
Creates a new Row. |
boolean |
doesConnectionPoolExist()
Return a boolean indicating if the connection pool for this ConnectionRow exists. |
ActionDescriptor |
getActionDescriptor(AbstractAction action)
Get an action descriptor for the given action type and name. |
java.lang.String |
getAlias()
Getter method for the Alias property |
int |
getCleanUpTimeout()
Getter method for the CleanUpTimeout property |
java.lang.Class |
getConnectionClass()
Gets the Java class for this Connection. |
java.lang.String |
getConnectionClassName()
Gets the Java class name for this Connection. |
static ConnectionRow |
getConnectionRow(java.lang.String pMetaDataAlias,
java.lang.String pConnectionRowSystemAlias)
|
static ConnectionRow |
getConnectionRow(java.lang.String metaDataAlias,
java.lang.String alias,
java.lang.String libraryName)
Get the connection row for the given alias. |
static Table |
getConnectionTable(java.lang.String pSystemAlias)
|
java.lang.String |
getDeleteConfirmationMessage()
Get the delete confirmation message. |
java.lang.String |
getDriver()
Getter method for the Driver property |
java.lang.Object |
getFieldDefaultValue(Field field,
ExecutingContext ec)
Get the field's default value as a String. |
java.lang.String |
getHeaderText(ExecutingContext ec)
Returns information for the user that will be displayed in the header of the Row |
int |
getMaxConnections()
Getter method for the MaxConnections property |
int |
getMinConnections()
Getter method for the MinConnections property |
int |
getOrphanTimeout()
Getter method for the OrphanTimeout property |
int |
getOwnerId()
Getter method for the OwnerId property |
Field |
getOwnerIdField()
Returns the Owner Id Field |
java.lang.String |
getPassword()
Getter method for the Password property |
java.lang.String |
getProperties()
Getter method for the Properties property |
java.util.List |
getRowHandledActionNames()
Get a list of action's this connection row supports. |
java.lang.String |
getSystem()
Returns the system. |
java.lang.String |
getUrl()
Getter method for the Url property |
static java.lang.String |
getURLFormatForDriver(java.lang.String driverClass)
Gets an expected URL format for a driver class |
java.lang.String |
getUserId()
Getter method for the UserId property |
java.lang.String |
getUserMessageForOperation(int changeCount,
int mode)
Returns a message for the user based on the Mode of the Row |
java.lang.Object |
handleAction(java.lang.String action,
ExecutingContext ec)
Handles the given action. |
int |
insert(SQLContext context)
Inserts this Row into the specified database. |
boolean |
isActionApplicable(java.lang.String action,
ExecutingContext ec)
Check to see if the action is applicable for this connection row |
boolean |
isFieldApplicable(Field field,
ExecutingContext ec)
Tests if a field is applicable in the current scenario |
boolean |
isFieldRequired(Field field,
ExecutingContext pContext)
Tests if a field is required or not. |
boolean |
isInitializeDerivedFieldEnabled(java.lang.String fieldName)
Tells whether or not to initialize a Derived FD upon row creation. |
static boolean |
isShared(java.lang.String alias)
Check whether or not this connection is shared |
boolean |
isValidConnection()
This method will verify this ConnectionRow contains valid connection properties and using these properties actually establishes a connection to a database. |
protected void |
populate(java.sql.ResultSet pResults,
java.util.List pPhysicalNames,
java.sql.ResultSetMetaData pMetaData,
SQLContext pContext)
Populates this Row with the data from the result set. |
ConnectionRow |
setAlias(java.lang.String newValue)
Setter method for the Alias property |
ConnectionRow |
setCleanUpTimeout(int newValue)
Setter method for the CleanUpTimeout property |
protected void |
setConnectionClassInternal(java.lang.Class newConnClass)
Sets the Java class for this Connection. |
ConnectionRow |
setDriver(java.lang.String newValue)
Setter method for the Driver property |
ConnectionRow |
setMaxConnections(int newValue)
Setter method for the MaxConnections property |
ConnectionRow |
setMinConnections(int newValue)
Setter method for the MinConnections property |
ConnectionRow |
setOrphanTimeout(int newValue)
Setter method for the OrphanTimeout property |
ConnectionRow |
setOwnerId(int newValue)
Setter method for the OwnerId property |
void |
setPassword(java.lang.String newValue)
Setter method for the Password property |
ConnectionRow |
setProperties(java.lang.String newValue)
Setter method for the Properties property |
ConnectionRow |
setUrl(java.lang.String newValue)
Setter method for the Url property |
void |
setUserId(java.lang.String newValue)
Setter method for the UserId property |
Row |
statusChanged(Field pField,
ExecutingContext ec)
Invoked when a status change takes place on of this Row's fields. |
int |
update(java.sql.Connection conn,
ExecutingContext ec)
Updates the database with the values in this Row. |
boolean |
validate(ExecutingContext ec)
Validate this Row based on its configuration and field values. |
ValidationExceptionCollection |
verifyConnection()
This method will verify this ConnectionRow contains valid connection properties and using these properties actually establishes a connection to a database. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ACTION_START
public static final java.lang.String ACTION_STOP
public static final java.lang.String ACTION_RESTART
Constructor Detail |
public ConnectionRow()
Method Detail |
public java.lang.String getHeaderText(ExecutingContext ec)
Row
getHeaderText
in class Row
public ConnectionRow createConnectionPool() throws CMException
CMException
public Row createRow(Row pDefaultRow) throws CMException
transferDataTo()
method is used to move the data from the default Row to the newly created
Row. Override this method if the type of Row to add needs to be
dynamically determined from the retrieved data.
createRow
in interface IRowCreator
createRow
in class Row
pDefaultRow
- A Row containing data read from the database (it will
always be equal to this)
CMException
public boolean doesConnectionPoolExist() throws CMException
CMException
public void closeConnectionPool() throws CMException
CMException
public ActionDescriptor getActionDescriptor(AbstractAction action)
IActionObject
getActionDescriptor
in interface IActionObject
getActionDescriptor
in class Row
public java.util.List getRowHandledActionNames()
getRowHandledActionNames
in class Row
public java.lang.String getAlias()
public int getCleanUpTimeout()
public java.lang.Class getConnectionClass()
public static ConnectionRow getConnectionRow(java.lang.String pMetaDataAlias, java.lang.String pConnectionRowSystemAlias) throws CMException
CMException
public java.lang.String getConnectionClassName()
public static ConnectionRow getConnectionRow(java.lang.String metaDataAlias, java.lang.String alias, java.lang.String libraryName) throws CMException
CMException
public static Table getConnectionTable(java.lang.String pSystemAlias) throws CMException
CMException
public java.lang.String getDriver()
public java.lang.Object getFieldDefaultValue(Field field, ExecutingContext ec) throws CMException
Row
getFieldDefaultValue
in class Row
CMException
public int getMaxConnections()
public java.lang.String getDeleteConfirmationMessage()
Row
getDeleteConfirmationMessage
in class Row
public int getMinConnections()
public int getOrphanTimeout()
public int getOwnerId()
public Field getOwnerIdField()
getOwnerIdField
in interface IOwner
IOwner
public java.lang.String getPassword()
public java.lang.String getProperties()
public java.lang.String getSystem()
public java.lang.String getUrl()
public static java.lang.String getURLFormatForDriver(java.lang.String driverClass)
public java.lang.String getUserId()
getUserId
in interface ILogin
public java.lang.String getUserMessageForOperation(int changeCount, int mode)
getUserMessageForOperation
in class Row
(see Row constants to find the modes.
public java.lang.Object handleAction(java.lang.String action, ExecutingContext ec) throws CMException
handleAction
in interface IActionObject
handleAction
in class Row
CMException
public int insert(SQLContext context) throws CMException
insert
in class Row
CMException
public boolean isActionApplicable(java.lang.String action, ExecutingContext ec) throws CMException
isActionApplicable
in interface IActionObject
isActionApplicable
in class Row
CMException
public boolean isFieldApplicable(Field field, ExecutingContext ec) throws CMException
Row
isFieldApplicable
in class Row
field
- The field which may or may not be applicable
CMException
public boolean isFieldRequired(Field field, ExecutingContext pContext)
Row
isFieldRequired
in class Row
field
- The whose required status is being testedpContext
- The current executing context which may be nullpublic boolean isInitializeDerivedFieldEnabled(java.lang.String fieldName)
Row
isInitializeDerivedFieldEnabled
in class Row
public static boolean isShared(java.lang.String alias)
public boolean isValidConnection()
protected void populate(java.sql.ResultSet pResults, java.util.List pPhysicalNames, java.sql.ResultSetMetaData pMetaData, SQLContext pContext) throws CMException
populate
in class Row
pResults
- The result set containing data which will be used to
populate this Row. The cursor must be pointing to the row in
the result set which will be used to populate this Row object.pMetaData
- The result set's metadata.
CMException
public ConnectionRow setAlias(java.lang.String newValue) throws CMException
CMException
public ConnectionRow setCleanUpTimeout(int newValue) throws CMException
CMException
protected void setConnectionClassInternal(java.lang.Class newConnClass) throws CMException
CMException
public ConnectionRow setDriver(java.lang.String newValue) throws CMException
CMException
public ConnectionRow setMaxConnections(int newValue) throws CMException
CMException
public ConnectionRow setMinConnections(int newValue) throws CMException
CMException
public ConnectionRow setOrphanTimeout(int newValue) throws CMException
CMException
public ConnectionRow setOwnerId(int newValue) throws CMException
CMException
public void setPassword(java.lang.String newValue) throws CMException
setPassword
in interface ILogin
CMException
public ConnectionRow setProperties(java.lang.String newValue) throws CMException
CMException
public ConnectionRow setUrl(java.lang.String newValue) throws CMException
CMException
public void setUserId(java.lang.String newValue) throws CMException
setUserId
in interface ILogin
CMException
public Row statusChanged(Field pField, ExecutingContext ec) throws CMException
statusChanged
in class Row
pField
- The field whose status has changedec
- The current executing context
CMException
public int update(java.sql.Connection conn, ExecutingContext ec) throws CMException
update
in class Row
conn
- The connection to use for the update
CMException
public boolean validate(ExecutingContext ec) throws CMException
validate
in class Row
ec
- current context in which application is executing
CMException
public ValidationExceptionCollection verifyConnection()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |