|
Expresso 5-6 | ||||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||||
| Packages that use DBException | |
| com.jcorporate.expresso.core | The sub-packages to this package define the core objects of Expresso, where items such as DBObject are defined. |
| com.jcorporate.expresso.core.controller | This package contains the object defining the "Controller" object, an important component of Expresso that should be used to encapsulate all user interaction sequences. |
| com.jcorporate.expresso.core.dataobjects | The DataObjects package contains a set of interfaces and base classes that give the ability to provide a unified object approach to various data sources. |
| com.jcorporate.expresso.core.dataobjects.jdbc | This package contains implementations and helper classes of DataObjects that pertain to JDBC data sources only. |
| com.jcorporate.expresso.core.db | Database Java Objects for establishing database connections and connection pooling Also contains all Exceptions used for Data Access while working with Expresso. |
| com.jcorporate.expresso.core.db.datasource | DataSource components for establishing database connections and connection pooling via JNDI Also contains all Exceptions used for Data Source while working with Expresso. |
| com.jcorporate.expresso.core.db.exception | Specific database exceptions, subclassing DBException |
| com.jcorporate.expresso.core.dbobj | Ancestor objects for all Database Objects and Schemas. |
| com.jcorporate.expresso.core.job | Classes that define "Jobs" or server-side tasks that are run asynchronously to the user's web browser. |
| com.jcorporate.expresso.core.logging | This package contains the objects that form Expresso's interface to the log4j logging system, including a custom appender to write to Expresso database-based log. |
| com.jcorporate.expresso.core.misc | Miscellaneous objects for file manipulation, running OS processes, etc |
| com.jcorporate.expresso.core.security | This package contains Expresso's security system, switchable from "weak" security (e.g. minimal-strength encryption) to "strong" security. |
| com.jcorporate.expresso.core.servlet | Base classes for all JavaCorporate servlets. |
| com.jcorporate.expresso.core.utility | Package to contain all of the 'utility' programs in Expresso - these are applications that run from the command line (e.g. not servlets) |
| com.jcorporate.expresso.ext.controller | Controllers that are optional to Expresso. |
| com.jcorporate.expresso.ext.dbobj | Contains database object definitions for download files functionality and self-Registered User functionality. |
| com.jcorporate.expresso.ext.dbobj.regobj | Example database objects for use in the built in registration system |
| com.jcorporate.expresso.ext.ldap | This package contains the LDAP-aware implementation of the UserInfo interface. |
| com.jcorporate.expresso.ext.xml.dbobj | Contains database objects for configuring XSL transformations of XML output from Controller objects. |
| com.jcorporate.expresso.services.controller.dbmaint | This package contains the various State objects that make up the "Model" of the DBMaint controller. |
| com.jcorporate.expresso.services.controller.ui | Objects that provide an automatic user interface rendering capability to the system |
| com.jcorporate.expresso.services.dbobj | Common database objects - used in many different applications |
| com.jcorporate.expresso.services.html | HTML objects - used to build HTML pages by servlets to define their user interface. |
| com.jcorporate.expresso.services.test | Contains classes that assist in unit testing using JUnit and Cactus testing. |
| Uses of DBException in com.jcorporate.expresso.core |
| Methods in com.jcorporate.expresso.core that throw DBException | |
void |
ExpressoSchema.otherSetup(InstallLog installLog,
String dataContext)
Runs additional setup operations for the Expresso Schema |
protected void |
ExpressoSchema.constructSetupValues()
Adds the setup values for this schema to the schema's definition |
| Constructors in com.jcorporate.expresso.core that throw DBException | |
ExpressoSchema()
Constructor |
|
| Uses of DBException in com.jcorporate.expresso.core.controller |
| Methods in com.jcorporate.expresso.core.controller that throw DBException | |
void |
Controller.setupDefaultValues(String dbName)
Allows for DBCreate to set up proper default values for views, etc. |
void |
ControllerRequest.validateDBField(String dbFieldName,
DBObject oneObject,
ErrorCollection ec)
Convenience method that retrieves the validates against that one database object field. |
void |
ControllerRequest.validateField(String dbFieldName,
String reqFieldName,
DBObject oneObject,
ErrorCollection ec)
Convenience method that retrieves the validates against that one database object field. |
User |
ControllerRequest.getUserInfo()
get requesting user |
static boolean |
DBController.isAllowed(ControllerRequest request,
DBController controller,
String newState)
for the given controller class and state, can the user in this request access this state? |
| Uses of DBException in com.jcorporate.expresso.core.dataobjects |
| Subclasses of DBException in com.jcorporate.expresso.core.dataobjects | |
class |
DataException
Base class exception for the dataobjects framework. |
class |
DuplicateKeyException
Exception that gets thrown when there's a duplicate key in the table. |
| Methods in com.jcorporate.expresso.core.dataobjects that throw DBException | |
DataField |
SynchronizedDataObject.getDataField(String fieldName)
Returns the object embedded within the field keyed by the fieldName parameter |
Iterator |
SynchronizedDataObject.getKeyFieldListIterator()
Retrieve iterator of all keys |
void |
SynchronizedDataObject.add()
Adds the record to the defined data source. |
void |
SynchronizedDataObject.update()
Updates the record to the defined datasource |
void |
SynchronizedDataObject.delete()
Deletes this defined record. |
void |
SynchronizedDataObject.clear()
Clears all currently loaded fields |
void |
SynchronizedDataObject.checkField(String fieldName,
String fieldValue)
Check that a given value is valid for a given field. |
List |
SynchronizedDataObject.getValidValuesList(String fieldName)
Retrieve a list of valid value object for this particular dbobject |
void |
SynchronizedDataObject.setMaxRecords(int newMax)
Specify a maximum number of records to be retrieved in any subsequent searchAndRetrieve() call. |
void |
SynchronizedDataObject.setOffsetRecord(int newOffset)
Specifies the number of records that should be skipped over before any data from the ResultSet
is retrieved in any subsequent
searchAndRetrieve() call. |
ArrayList |
SynchronizedDataObject.searchAndRetrieveList(String sortOrder)
Performs a datasource search so that the criteria set in the DataObject is used. |
ArrayList |
SynchronizedDataObject.searchAndRetrieveList()
Performs a datasource search so that the criteria set in the DataObject is used. |
boolean |
SynchronizedDataObject.find()
Finds a single record based upon the criteria specified by the DataTransferObject |
int |
SynchronizedDataObject.count()
Just like find, but only retrieves the count, not the records themselves. |
String |
SynchronizedDataObject.getField(String fieldName)
Retrieve the field value as a String |
void |
Securable.isAllowed(String requestedFunction)
Throws a Security Exception if the user given by the earlier setRequestingUid() function does not have permission for the given function.. |
DataField |
DataObject.getDataField(String fieldName)
Returns the object embedded within the field keyed by the fieldName parameter. |
void |
DataObject.add()
Adds the record to the defined data source. |
void |
DataObject.update()
Updates the record to the defined datasource |
void |
DataObject.delete()
Deletes this defined record. |
void |
DataObject.clear()
Clears all currently loaded fields |
String |
DataObject.getField(String fieldName)
Retrieve the field value as a String |
void |
DataObject.checkField(String fieldName,
String fieldValue)
Check that a given value is valid for a given field. |
List |
DataObject.getValidValuesList(String fieldName)
Retrieve a list of valid value object for this particular dbobject |
void |
DataObject.setMaxRecords(int newMax)
Specify a maximum number of records to be retrieved in any subsequent searchAndRetrieve() call. |
void |
DataObject.setOffsetRecord(int newOffset)
Specifies the number of records that should be skipped over before any data from the ResultSet
is retrieved in any subsequent
searchAndRetrieve() call. |
ArrayList |
DataObject.searchAndRetrieveList(String sortOrder)
Performs a datasource search so that the criteria set in the DataObject is used. |
ArrayList |
DataObject.searchAndRetrieveList()
Performs a datasource search so that the criteria set in the DataObject is used. |
boolean |
DataObject.find()
Finds a single record based upon the criteria specified by the DataTransferObject |
int |
DataObject.count()
Just like find, but only retrieves the count, not the records themselves. |
boolean |
DataObjectMetaData.isAllowsNull(String fieldName)
Returns whether the field allows null values or not. |
void |
DataObjectMetaData.setAttribute(String fieldName,
String attribName,
Object attribValue)
|
Object |
DataObjectMetaData.getAttribute(String fieldName,
String attribName)
Gets an Object attribute from the field's metatdata |
String |
DataObjectMetaData.getDescription(String fieldName)
Return the long description of a field, if available |
String |
DataObjectMetaData.getLength(String fieldName)
Return the length of a field |
int |
DataObjectMetaData.getLengthInt(String fieldName)
Return the length of a field as an integer |
int |
DataObjectMetaData.getPrecision(String fieldName)
Retrieve the precision of a particular field |
String |
DataObjectMetaData.getLookupObject(String fieldName)
Get a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
String |
DataObjectMetaData.getType(String fieldName)
Return the type of a field - this method returns the internal Expresso type |
boolean |
DataObjectMetaData.isMultiValued(String fieldName)
Method called to determine if a particular field is multi-valued, that is does it have a set of specific values and descriptions |
boolean |
DataObjectMetaData.isReadOnly(String fieldName)
Is a given field readOnly - these fields are not offered for entry when a form is produced by the generic database maintenance servlet |
boolean |
DataObjectMetaData.isSecret(String fieldName)
Is a given field 'secret' - these fields are not shown when a list is produced by the generic database maintenance servlet (DBMaint). |
boolean |
DataObjectMetaData.isVirtual(String fieldName)
Is a given field virtual? |
| Uses of DBException in com.jcorporate.expresso.core.dataobjects.jdbc |
| Subclasses of DBException in com.jcorporate.expresso.core.dataobjects.jdbc | |
class |
JDBCUtil
This class provides utility functions that are common across the jdbc. |
| Methods in com.jcorporate.expresso.core.dataobjects.jdbc that throw DBException | |
void |
JDBCDataObject.setDBName(String newOther)
Set the database name/context for this db object. |
protected DBObjectDef |
JDBCDataObject.constructNewMetaData()
Construction method to allow for specialized metadata with specialized fields other than DBObjectDef. |
String |
JDBCDataObject.selectFieldString(String fieldName)
Build an appropriate String for use in the select part of an SQL statement by doing the |
String |
JDBCDataObject.quoteIfNeeded(String fieldName,
String rangeString)
Return the value of this field, placing double quotes around it if the field's datatype requires it. |
void |
JDBCDataObject.setConnection(DBConnection newConnection)
Set a specific DB connection for use with this db object. |
void |
JDBCDataObject.setConnection(DBConnection newConnection,
String setupTablesContext)
Set a specific DB connection for use with this db object. |
DBConnection |
JDBCDataObject.createAndExecuteSearch(ArrayList retrievedFieldList)
Refactoring to split the execution of a query statement into the query part and the load part. |
void |
JDBCDataObject.loadFromConnection(JDBCDataObject myObj,
DBConnection myConnection,
ArrayList retrievedFieldList)
Fills the given constructed data object with data from the connection given the field order specified in retrievedFieldList. |
ArrayList |
JDBCDataObject.getDistinctFieldArrayList()
Get a special ArrayList object list of all
of the fields in this object that are set to distinct |
Iterator |
JDBCDataObject.getFieldsToRetrieveIterator()
Get a special Iterator object list of all
of the fields in this object that are set to retrieve
Author Yves henri Amaizo |
String |
JDBCDataObject.buildWhereClause(boolean useAllFields)
Build and return a string consisting of an SQL 'where' clause using the current field values as criteria for the search. |
protected FastStringBuffer |
JDBCDataObject.buildWhereClauseBuffer(boolean useAllFields,
FastStringBuffer allocatedBuffer)
Build and return a FastStringBuffer ring consisting of an SQL 'where' clause using the current field values as criteria for the search. |
String |
JDBCDataObject.getCustomStringFieldValue(DBConnection connection,
String oneFieldName)
This convenience method retrieve through the resultSet.MetaData the date value of field define as date or time DBObject |
DBConnection |
JDBCDataObject.createAndRunStoreProcedure(ArrayList retrievedFieldList)
Refactoring to split the execution of a query statement into the query part and the load part. |
protected void |
JDBCDataObject.addInParam(String inFieldName)
Add a new field to the list of fields that are part of this object's list of input parameters. |
protected void |
JDBCDataObject.addOutParam(String outFieldName)
Add a new field to the list of fields that are part of this object's list of output parameter. |
void |
JDBCDataObject.setTargetStoreProcedure(String theStoreProcedure)
Set the target store procedure for this DBObject. |
void |
JDBCDataObject.runStoredProcedure()
Run a particular store procedure in the database into this object's fields |
protected ArrayList |
JDBCDataObject.runStoredProcedureAndRetrieveList()
Run a particular store procedure in the database into this object's fields |
boolean |
JoinedDataObjectMetaData.isAllowsNull(String fieldName)
Retrieves whether the value is null |
void |
JoinedDataObjectMetaData.setAttribute(String fieldName,
String attribName,
Object attribValue)
Sets the attribute for the particular field |
Object |
JoinedDataObjectMetaData.getAttribute(String fieldName,
String attribName)
Retrieve the attribute for the field |
String |
JoinedDataObjectMetaData.getDescription(String fieldName)
Get the unlocalized description for a field name |
String |
JoinedDataObjectMetaData.getLength(String fieldName)
Return the length of a field |
int |
JoinedDataObjectMetaData.getLengthInt(String fieldName)
Return the length of a field as an integer |
int |
JoinedDataObjectMetaData.getPrecision(String fieldName)
Retrieve the precision of a particular field |
String |
JoinedDataObjectMetaData.getLookupObject(String fieldName)
Get a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
String |
JoinedDataObjectMetaData.getType(String fieldName)
Return the type of a field - this method returns the internal Expresso type |
boolean |
JoinedDataObjectMetaData.isMultiValued(String fieldName)
Method called to determine if a particular field is multi-valued, that is does it have a set of specific values and descriptions |
boolean |
JoinedDataObjectMetaData.isReadOnly(String fieldName)
Is a given field readOnly - these fields are not offered for entry when a form is produced by the generic database maintenance servlet |
boolean |
JoinedDataObjectMetaData.isSecret(String fieldName)
Is a given field 'secret' - these fields are not shown when a list is produced by the generic database maintenance servlet (DBMaint). |
boolean |
JoinedDataObjectMetaData.isVirtual(String fieldName)
Is a given field virtual? |
void |
JoinedDataObjectMetaData.setForeignKey(String shortName,
String foreignKey,
String shortName2,
String primaryKey,
int joinType)
Sets how the various dataobjects are connected, key-wise |
protected String |
JDBCExecutor.buildPreparedUpdateSQL(DataObject oneObjectType,
boolean updateChangedFieldsOnly)
Helper function to build a prepared update statement for batch updates. |
protected String |
JDBCExecutor.buildPreparedDeleteSQL(DataObject oneObjectType,
boolean deleteWithSetFieldsOnly)
Helper function to build a prepared delete statement for batch deletes. |
protected String |
JDBCExecutor.buildPreparedAddSQL(DataObject oneObjectType,
boolean addChangedFieldsOnly)
Helper Function to build a prepared statement's SQL for an ADD statement. |
protected String |
JDBCExecutor.prepareForStorage(DataFieldMetaData oneField,
DBObject theObj)
Format the field for storage into a prepared statement. |
protected String |
JDBCExecutor.prepareForStorage(DataFieldMetaData oneField,
DBObject theObj,
boolean dateFormatted)
Format the field for storage into a prepared statement. |
protected String |
JDBCExecutor.buildPreparedStoreProcedureSQL(DataObject oneObjectType)
Helper Function to build a prepared statement's SQL for running STore Procedure statement. |
DataField |
JoinedDataObject.getDataField(String fieldName)
Returns the object embedded within the field keyed by the fieldName parameter |
void |
JoinedDataObject.setMaxRecords(int newMax)
Set the maximum number of records to receive |
void |
JoinedDataObject.setOffsetRecord(int newOffset)
Specifies the number of records that should be skipped over before any data from the ResultSet is retrieved in any subsequent
searchAndRetrieve() call. |
List |
JoinedDataObject.getValidValuesList(String fieldName)
Retrieve a list of valid value object for this particular dbobject |
void |
JoinedDataObject.add()
Adds records to all joined tables based upon the values input. |
void |
JoinedDataObject.checkField(String fieldName,
String fieldValue)
Retrieve a list of valid value object for this particular dbobject |
boolean |
JoinedDataObject.checkAllowed(String requestedFunction)
See if the current user has permission to perform the permissions |
void |
JoinedDataObject.clear()
Clears all currently loaded fields |
int |
JoinedDataObject.count()
Retrieves the count of any particular join based upon the field values of the data object. |
void |
JoinedDataObject.delete()
Deletes the join. |
boolean |
JoinedDataObject.find()
Find the object. |
ArrayList |
JoinedDataObject.searchAndRetrieveList(String sortOrder)
Simple query method for querying dataobjects. |
ArrayList |
JoinedDataObject.searchAndRetrieveList()
Retrieve an unsorted array of DataObjects representing the results of the join fields |
protected String |
JoinedDataObject.selectFieldString(JDBCDataObject oneObj,
String fieldName)
Build an appropriate String for use in the select part of an SQL statement |
void |
JoinedDataObject.update()
Update the current join to the database. |
void |
JoinedDataObject.addOrUpdate(JDBCDataObject testObject)
Determine if a record with these fields exists already - if so, update. |
void |
JoinedDataObject.isAllowed(String requestedFunction)
Check if the function is allowed. |
protected String |
JoinedDataObject.buildSelectFieldsString()
Builds the part of the query that is for describing the fields/names to be selected |
protected String |
JoinedDataObject.buildOrderByString(String sortKeys)
Create the 'ORDER BY' clause in the select statement. |
protected String |
JoinedDataObject.buildWhereClauseBuffer(boolean useAllFields,
FastStringBuffer myStatement)
Build and return a string consisting of an SQL 'where' clause using the current field values as criteria for the search. |
String |
JoinedDataObject.getField(String fieldName)
Retrieve the field value as a String |
void |
JoinedDataObject.setConnection(DBConnection newConnection)
Set a specific DB connection for use with this JoinedDataObject. |
void |
JoinedDataObject.setConnection(DBConnection newConnection,
String setupTablesContext)
Set a specific DB connection for use with this JoinedDataObject. |
| Uses of DBException in com.jcorporate.expresso.core.db |
| Methods in com.jcorporate.expresso.core.db that throw DBException | |
static TypeMapper |
TypeMapper.getInstance(String dataContext)
Retrieves an instance of the type mapper. |
int |
TypeMapper.getJavaSQLType(String fieldType)
Return a java.sql.Types integer that maps to the field type listed |
String |
TypeMapper.getTypeForDB(String expressoType)
Map a type used in Expresso to an appropriate database-specific type, utilizing the default type mapping followed by the custom type mapping(s) for this context (if any) |
String |
TypeMapper.getTypeForExpresso(int sqlType)
Map a type used in SQL to an appropriate expresso-specific type |
protected void |
TypeMapper.initializeTypes(String dataContext)
Initialize the mappings between java types, expresso types, and SQL types. |
protected DBConnection |
DBConnectionPool.buildNewConnection()
Creates a new database connection. |
protected DBConnection |
DBConnectionPool.createNewConnection()
Creates a new connection to the data source |
void |
DBConnectionPool.clean()
Clean the connection pool - see if any connections have been idle more than the allowed number of seconds . |
void |
DBConnectionPool.disconnectAll()
Disconnect all of the current connections. |
void |
DBConnectionPool.executeExclusiveUpdate(String theSQL)
This allows an exclusive updated to be done to a database. |
DBConnection |
DBConnectionPool.getConnection()
Find an available connection in the default connection pool, if any. |
DBConnection |
DBConnectionPool.getConnection(String connectionDescrip)
Get a connection from the pool. |
static boolean |
DBConnectionPool.supportsTransactions(String connName)
Does this database connection support commit/rollback? |
boolean |
DBConnectionPool.supportsTransactions()
Does this database connection support commit/rollback? |
static DBConnectionPool |
DBConnectionPool.getInstance(String dataContext)
Version of getInstance that can only get an already initialized connection pool to an alternate database |
ArrayList |
DBConnectionPool.getPoolList()
Return the entire pool of connections as a Vector |
void |
DBConnectionPool.setMaxConnections(int newMax)
Sets the maximum number of connections for this pool |
void |
DBConnectionPool.setTimeOutInterval(int newInterval)
Set the number of seconds that a connection must remain idle before it is considered "timed out" and cleared. |
static void |
DBConnectionPool.reInitialize()
Close all existing connections & empty the pools |
void |
DBConnectionPool.setLimitationPosition(int pos)
programmatically sets the limitation optimisation insertion position |
void |
DBConnection.connectionSetup(String newDBDriverType,
String newDBDriver,
String newDBURL,
String newDBConnectFormat)
Sets up the connection whether JDBC or JNDI Datasources |
void |
DBConnection.checkTimeOut()
Checks if this connectino has timed out. |
void |
DBConnection.clear()
Clear all result sets and statements associated with this connection |
void |
DBConnection.commit()
Send a COMMIT to the database, closing the current transaction If the database driver claims it doesn't support transactions, then we skip this. |
void |
DBConnection.connect(String newLogin,
String newPassword)
Connect to the database, ready to execute statements |
void |
DBConnection.connect(JndiDataSource newJndiDS)
Connect to the database, ready to execute statements |
void |
DBConnection.disconnect()
Close the connection to the database |
void |
DBConnection.execute()
Execute the actual query Queries executed by this method are expected to return a result - use executeUpdate for queries that do not. |
void |
DBConnection.execute(String theSQL)
One-step execute that sets the query on the fly NOTE: Do not use for UPDATE or DELETE, use executeUpdate instead This method throws DBException if no result set is returned |
void |
DBConnection.executeUpdate(String theSQL)
One-step executeUpdate - for statements that don't return a result set No result set is expected from this method, but the getUpdateCount() method can be called to see how many rows were affected |
void |
DBConnection.executeProcedure()
Execute the actual store procedure in callableStatment Store procedures method are expected to return a result - use executeUpdate for queries that do not. |
boolean |
DBConnection.first()
Scroll to the first record in the result set |
boolean |
DBConnection.getAutoCommit()
Return the state of the auto-commit flag |
String |
DBConnection.getCatalog()
Return the Catalog for the current connection |
Clob |
DBConnection.getClob(int fieldNum)
Retrieves a BLOB object from the result set. |
Clob |
DBConnection.getClob(String fieldName)
Retrieves a BLOB object from the result set. |
BigDecimal |
DBConnection.getBigDecimal(int fieldNum)
Retrieves a BigDecimal object from the resultset |
Blob |
DBConnection.getBlob(int fieldNum)
Retrieves a BLOB object from the result set. |
Blob |
DBConnection.getBlob(String fieldName)
Retrieves a BLOB object from the result set. |
InputStream |
DBConnection.getBinaryStream(String fieldName)
Retrieves a Large object as a binary stream. |
InputStream |
DBConnection.getBinaryStream(int fieldNum)
Retrieves a Large object as a binary stream. |
byte[] |
DBConnection.getBytes(int fieldNum)
Get the BLOB bytes for this particular dataset row. |
DatabaseMetaData |
DBConnection.getDBMetaData()
Return the DatabaseMetaData for the connection |
boolean |
DBConnection.supportsTransactions()
Checks if the Database Metadata claims that this database supports transactions. |
double |
DBConnection.getDouble(int fieldNum)
Fetch the given field of the current row as a double |
Hashtable |
DBConnection.getFields(String tableName)
Deprecated. Use getFieldsMap() instead |
HashMap |
DBConnection.getFieldsMap(String tableName)
Get a hashtable that contains a set of field/type values for the given table |
int |
DBConnection.getInt(int fieldNum)
Fetch the given field of the current row as an integer |
long |
DBConnection.getLong(int fieldNum)
Fetch the given field of the current row as a long |
String |
DBConnection.getString(int fieldNum)
Return the value in the numbered field as a string, trimming off any trailing whitespace |
String |
DBConnection.getStringNoTrim(int fieldNum)
Return the numbered field as a string, not trimming any trailing spaces |
String |
DBConnection.getString(String fieldName)
Return the value in the named field as a string, trimming off any trailing whitespace |
String |
DBConnection.getStringNoTrim(String fieldName)
Return the value in the named field as a string |
Date |
DBConnection.getTimestamp(String fieldName)
Return the value in the named field as a string, trimming off any trailing whitespace |
Date |
DBConnection.getTimestamp(int fieldNum)
Return the value in the named field as a string, trimming off any trailing whitespace |
Date |
DBConnection.getTime(String fieldName)
Return the value in the named field as a string, trimming off any trailing whitespace |
Date |
DBConnection.getTime(int fieldNum)
Return the value in the named field as a string, trimming off any trailing whitespace |
Date |
DBConnection.getDate(String fieldName)
Return the value in the named field as a string, trimming off any trailing whitespace |
Date |
DBConnection.getDate(int fieldNum)
Return the value in the named field as a string, trimming off any trailing whitespace |
int |
DBConnection.getTransactionMode()
Return the Database current transaction mode set. |
boolean |
DBConnection.isClosed()
When this connection has lost its connection to the server, tell whether or not it is available to be re-allocated |
boolean |
DBConnection.next()
Scroll to the next record in the result set |
void |
DBConnection.rollback()
Roll back the current transaction, as if it were never requested. |
void |
DBConnection.setAutoCommit(boolean b)
Set auto-commit on or off for this connection. |
void |
DBConnection.setDateTimeType(String newDateTimeType)
setDateTimeType method allows the default database type of "datetime" to be overridden for databases where this is not the type for date and time values (e.g. |
void |
DBConnection.setTransactionIsolation(int isolationMode)
Set Database transaction isolation mode. |
void |
DBConnection.setTransactionMode(int transactionMode)
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBConnection.setTransactionCommittedMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBConnection.setTransactionUncommittedMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBConnection.setTransactionRepeatableMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBConnection.setTransactionSerializableMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBInitializer.close(DBConnection myConnection)
|
void |
TableCreator.createTable(DBObject dbObj)
Create the table needed by this DB Object in the database. |
protected FastStringBuffer |
TableCreator.createTableSQLDefinition(DBObject dbObj,
FastStringBuffer sqlStatement)
Create the SQL statement to create the table. |
Vector |
TableCreator.createAsNeeded(Schema oneSchema,
String dataContext)
Try to do a search on each DBObject member - if we fail we know the table does not exist. |
protected com.jcorporate.expresso.core.db.config.JDBCConfig |
TableCreator.getJDBCConfig(String dataContext)
Protected method to get JDBC Configurations whether running Expresso Runtime or not. |
protected void |
TableCreator.createIndices(DBObject dbObj,
DBConnection providedConn,
boolean shouldComplain)
create indices, using provided connection if any, and complaining upon failure if specified |
void |
DBTransaction.startTransaction()
Sets up the transaction operation on an identitied DBConnectionPool |
void |
DBTransaction.startTransaction(boolean immortal)
Sets up the transaction operation on an identitied DBConnectionPool |
void |
DBTransaction.clear()
Clear all result sets and statements associated with this connection |
void |
DBTransaction.commit()
Send a COMMIT to the database, closing the current transaction If the database driver claims it doesn't support transactions, then we skip this. |
boolean |
DBTransaction.isClosed()
When this connection has lost its connection to the server, tell whether or not it is available to be re-allocated |
void |
DBTransaction.rollback()
Roll back the current transaction, as if it were never requested. |
void |
DBTransaction.release()
Releases the DBConnection back into the parent DBConnectionPool. |
void |
DBTransaction.setTransactionReadOnlyMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBTransaction.setTransactionDirtyMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBTransaction.setTransactionRestrictiveMode()
Set EXPRESSO transaction mode for the current DBConnection. |
void |
DBTransaction.setTransactionExclusiveMode()
Set EXPRESSO transaction mode for the current DBConnection. |
| Constructors in com.jcorporate.expresso.core.db that throw DBException | |
DBConnection(String newDBDriver,
String newDBURL,
String newDBConnectFormat)
Constructor Create a new connection object |
|
DBConnection(com.jcorporate.expresso.core.db.config.JDBCConfig newConfigJdbc)
Constructor Create a new connection object |
|
DBConnection(String newDBDriverType,
String newDBDriver,
String newDBURL,
String newDBConnectFormat)
Constructor Create a new connection object |
|
DBInitializer()
Constructor |
|
DBInitializer(String newDBName)
Constructor |
|
DBTransaction()
Constructor Create a new connection object |
|
DBTransaction(DBConnectionPool pool)
Constructor Create a new connection object |
|
DBTransaction(String transactionDataContext)
Constructor Create a new connection object |
|
| Uses of DBException in com.jcorporate.expresso.core.db.datasource |
| Subclasses of DBException in com.jcorporate.expresso.core.db.datasource | |
class |
DSException
Date Source Interface |
| Methods in com.jcorporate.expresso.core.db.datasource that throw DBException | |
Connection |
DataSourceInterface.getConnection()
Get database connection from datasource defined in JNDI |
| Uses of DBException in com.jcorporate.expresso.core.db.exception |
| Subclasses of DBException in com.jcorporate.expresso.core.db.exception | |
class |
ConnectionPoolException
Exception that is thrown by the ConnectionPool |
class |
DBRecordChangedException
|
class |
DBRecordNotFoundException
|
class |
PoolFullException
Exception that is thrown when the DBConnectionPool is full. |
| Uses of DBException in com.jcorporate.expresso.core.dbobj |
| Methods in com.jcorporate.expresso.core.dbobj that throw DBException | |
String |
DBIndex.constructSQL()
Constructs a SQL CREATE INDEX statement for use in the DBCreate sequence |
String |
LOBSupport.getCLOB(DBObject baseObject,
String fieldName)
Deprecated. |
String |
LOBSupport.getCLOB(DBObject baseObject,
String fieldName,
DBConnection theConnection)
Deprecated. Retrieves the CLOB data for the specified DBObject and the specified fieldName |
void |
LOBSupport.setCLOB(DBObject baseObject,
String fieldName,
String theData,
DBConnection theConnection)
Deprecated. Writes a LONG Character string to the database. |
byte[] |
LOBSupport.getBLOB(DBObject baseObject,
String fieldName,
DBConnection theConnection)
Deprecated. Returns a single stream for a LOB object. |
void |
LOBSupport.setBLOB(DBObject baseObject,
String fieldName,
byte[] theData,
DBConnection theConnection)
Deprecated. Updates the underlying table with a BLOB object. |
void |
LOBSupport.setBLOB(DBObject baseObject,
String fieldName,
InputStream theData,
int dataLength,
DBConnection theConnection)
Deprecated. Updates the underlying table with a BLOB object. |
protected void |
LOBSupport.prepSelectResultSet(DBObject baseObject,
String fieldName,
DBConnection theConnection)
Deprecated. Internal helper function that does the guts of the work |
protected PreparedStatement |
LOBSupport.prepUpdate(DBObject baseObject,
String fieldName,
DBConnection theConnection)
Deprecated. Internal helper function to prepare a LOB update |
protected void |
LOBSupport.finalizeUpdate(DBConnection theConnection)
Deprecated. |
void |
HistAuditSecuredDBObject.add()
On the add method, always write an entry to the history table. |
void |
HistAuditSecuredDBObject.update()
On the update method, always write an entry to the history table. |
void |
SecuredDBObject.add()
If the user is allowed to add, invoke the superclass add |
boolean |
SecuredDBObject.checkAllowed(String requestedFunction)
See if the current user has permission to perform the permissions |
void |
SecuredDBObject.delete()
Delete a record from the target table |
boolean |
SecuredDBObject.find()
Just like retrieve, but works with any fields, not just the key field. |
void |
SecuredDBObject.isAllowed(String requestedFunction)
See if the current user of this DB object is allowed to perform the requested function, given the function's code. |
void |
SecuredDBObject.retrieve()
Get a particular record from the database into this object's fields Assumes that the key fields are set to the key of the object to be retrieved |
void |
SecuredDBObject.search()
Find a set of keys of all of the objects that match the current search critieria in the fields Assumes that the fields are populated with search criteria instead of data NOTE: Criteria in 'text' type colums is ignored (SQL Server limitation) |
ArrayList |
SecuredDBObject.searchAndRetrieveList()
Find a set of records of all of the objects that match the current search critieria in the fields and retrieve the list of all records that match this criteria NOTE: Criteria in 'text' type colums is ignored (SQL Server limitation) |
ArrayList |
SecuredDBObject.searchAndRetrieveList(String sortKeys)
Find a set of records of all of the objects that match the current search critieria in the fields and retrieve the list of all records that match this criteria NOTE: Criteria in 'text' type colums is ignored (SQL Server limitation) |
void |
SecuredDBObject.update()
Update the database with the new info |
protected String |
SecuredDBObject.getString(String stringCode,
Object[] args)
Convenience method to get a local language string from within any SecuredDBObject by using the user's language perferences automatically |
static SecuredDBObject |
SecuredDBObject.instantiate(String className)
Convenience factory method to create a SecuredDBObject object from it's name |
protected String |
SecuredDBObject.getString(String stringCode)
Convenience method of the above with no arguments |
protected String |
SecuredDBObject.getString(String stringCode,
String arg1)
Convenience method of the above without array arguments |
protected String |
SecuredDBObject.getString(String stringCode,
String arg1,
String arg2)
Convenience method of the above without array arguments |
protected String |
SecuredDBObject.getString(String stringCode,
String arg1,
String arg2,
String arg3)
Convenience method of the above without array arguments |
protected String |
SecuredDBObject.getString(String stringCode,
String arg1,
String arg2,
String arg3,
String arg4)
Convenience method of the above without array arguments |
void |
SecuredDBObject.copyAttributes(DBObject returnObj)
this method should make sure that the 'returnObj' object is properly initialized with copied UID and data context as this (parent) object |
int |
SecuredDBObject.count()
Security check on count |
void |
SecuredDBObject.deleteAll()
Security check on deleteAll |
boolean |
SecuredDBObject.canRequesterRead()
determine if getRequestingUid has rights to read this kind of object (not just this particular object, but ALL INSTANCES of this kind of object) |
boolean |
SecuredDBObject.canRequesterAdd()
determine if getRequestingUid has rights to add this kind of object (not just this particular object, but ALL INSTANCES of this kind of object) |
boolean |
SecuredDBObject.canRequesterDelete()
determine if getRequestingUid has rights to delete this kind of object (not just this particular object, but ALL INSTANCES of this kind of object) |
boolean |
SecuredDBObject.canRequesterUpdate()
determine if getRequestingUid has rights to update this kind of object (not just this particular object, but ALL INSTANCES of this kind of object) |
void |
MultiDBObject.setOffsetRecord(int newOffset)
Specifies the number of records that should be skipped over before any data from the ResultSet
is retrieved in any subsequent
searchAndRetrieve() call. |
boolean |
MultiDBObject.buildFromClause()
Build a string consisting of an SQL 'from' clause using the customFromClause, the foreign-key or the join definitions. |
int |
MultiDBObject.count(String expr)
Just like find, but only retrieves the count, not the records themselves. |
int |
MultiDBObject.count()
Just like find, but only retrieves the count, not the records themselves. |
void |
MultiDBObject.addDBObj(String dbobjClassName,
String shortName)
Add a DB Object to the objects being used for this multidbobj query. |
void |
MultiDBObject.addDBObj(DBObject oneDBObj,
String shortName)
|
String |
MultiDBObject.buildWhereClause(boolean useAllFields)
Build and return a string consisting of an SQL 'where' clause using the current field values as criteria for the search. |
protected String |
MultiDBObject.buildWhereClauseBuffer(boolean useAllFields,
FastStringBuffer myStatement)
Build and return a string consisting of an SQL 'where' clause using the current field values as criteria for the search. |
protected String |
MultiDBObject.buildWhereClauseBuffer(boolean useAllFields,
FastStringBuffer myStatement,
String dboAlias)
Build and return a string consisting of an SQL 'where' clause using the current field values as criteria for the search. |
void |
MultiDBObject.clear()
Insert the method's description here. |
DBObject |
MultiDBObject.getDBObject(String shortName)
This returns the encapsulated instance of the 'model' DBObject that was provided in 'addDBObj()'; After a searchAndRetrieveList(), each MultiDBObject in the list has, encapsulated, an object of each type which was previously added as a model. |
String |
MultiDBObject.getField(String shortName,
String fieldName)
Get the actual DBField value specified by fieldname Creation date: (9/18/00 11:37:10 AM) |
String |
MultiDBObject.getFieldDecimalFormatted(String shortName,
String fieldName,
String formatPattern)
|
float |
MultiDBObject.getFieldFloat(String shortName,
String fieldName)
|
double |
MultiDBObject.getFieldDouble(String shortName,
String fieldName)
Returns a double object author Peter Pilgrim |
BigDecimal |
MultiDBObject.getFieldBigDecimal(String shortName,
String fieldName)
Returns a BigDecimal object author Peter Pilgrim |
Date |
MultiDBObject.getFieldDate(String shortName,
String fieldName)
|
int |
MultiDBObject.getFieldInt(String shortName,
String fieldName)
|
long |
MultiDBObject.getFieldLong(String shortName,
String fieldName)
|
protected MultiDBObject |
MultiDBObject.getThisMultiDBObj()
Construct a new MultiDBObject |
List |
MultiDBObject.searchAndRetrieveList(String sortKeyString)
Search and retrieve in a particular order |
List |
MultiDBObject.searchAndRetrieveList()
Search and retrieve in a particular order |
void |
MultiDBObject.setDBName(String newOther)
Set the database name/context for this multi db object. |
void |
MultiDBObject.setFieldsToRetrieve(String shortName,
String fieldNames)
Specify a select list of fields to retrieve from a particular DBObject component |
void |
MultiDBObject.setFieldsToRetrieveToNone(String shortName)
Specify to retrieve NO fields from a particular DBObject component author Zaz Harris, SRI International |
void |
MultiDBObject.setFieldDistinct(String shortName,
String fieldName,
boolean flag)
Specify a field to be retieved uniquely froma component DBObject |
void |
MultiDBObject.setField(String shortName,
String fieldName,
String fieldValue)
Insert the method's description here. |
void |
MultiDBObject.setForeignKey(String shortName,
String foreignKey,
String shortName2,
String primaryKey)
Insert the method's description here. |
void |
MultiDBObject.setInnerJoin(String leftShortName,
String leftColumn,
String rightShortName,
String rightColumn)
Builds a 'FROM' clause using the 'INNER JOIN' syntax. |
void |
MultiDBObject.setLeftJoin(String leftShortName,
String leftColumn,
String rightShortName,
String rightColumn)
Builds a 'FROM' clause using the 'LEFT JOIN' syntax. |
void |
MultiDBObject.setRightJoin(String leftShortName,
String leftColumn,
String rightShortName,
String rightColumn)
Builds a 'FROM' clause using the 'LEFT JOIN' syntax. |
void |
MultiDBObject.setMaxRecords(int newMax)
Specify a maximum number of records to be retrieved in any subsequent searchAndRetrieve() call. |
protected void |
MultiDBObject.setupFields()
Method to set up the fields for this database object. |
String |
MultiDBObject.selectFieldString(DBObject oneObj,
String fieldName)
Build an appropriate String for use in the select part of an SQL statement |
List |
MultiDBObject.makeDirectQueryList(String sqlQuery,
int fieldCount)
Execute custom SQL query |
DBObject |
MultiDBObject.assembleObject(String shortName)
Deprecated. v. 5.5+; 9/04; use getDBObject() instead |
boolean |
MultiDBObject.isFieldNull(String shortName,
String fieldName)
|
void |
Schema.add(Job oneJob)
Deprecated. See the addJob(Class) method instead since Expresso 5.6 |
void |
Schema.add(String schemaClass,
String setupCode,
String descrip,
String defaultValue)
Deprecated. since 3/04; use addSetup() instead |
void |
Schema.addSetup(String schemaClass,
String setupCode,
String descrip,
String defaultValue)
Add a new setup value to the named schema; will not change value if one already exists in Setup table |
void |
Schema.addSetup(String setupCode,
String descrip,
String defaultValue)
Add a new setup value to this schema for THIS schema; will not change value if one already exists in Setup table |
void |
Schema.otherSetup(InstallLog installLog,
String dataContext)
preferable way of performaing other setup. |
void |
Schema.otherSetup(String dbName)
Deprecated. 5.5+; 10/04. use otherSetup(log, dbcontext) instead |
void |
Schema.setDBName(String newOther)
Deprecated. Since Expresso 5.6 Use setDataContext(String) instead. |
void |
Schema.setDataContext(String newOther)
Set the database name/context for this schema. |
void |
Schema.setupDefaultValuesWithException(String dbName)
Go through each DBobject and each Controller in the schema and call default-populate methods. |
void |
Schema.populateSchemaData(String dbName)
Allow populations of sample data where all tables must be set up first. |
protected void |
Schema.requiresVersion(String versionString,
String schemaClassName)
Method for a schema to define a dependance on another schema with a particular version - e.g. if eContent requires expresso 3.11, it can call this method to ensure that's the version it's being run with |
static Schema |
Schema.instantiate(String className)
Convenience method to create a Schema object from it's name |
List |
RowSecuredDBObject.getAdministrateGroups()
|
List |
RowSecuredDBObject.getGroups()
find any existing permission groups for this object. |
void |
RowSecuredDBObject.setPermissions(String group,
int perm)
set the group and permissions for this object; owner id is taken from getRequestingUid() before permissions can be set, caller's permission to change permissions is tested |
void |
RowSecuredDBObject.setPermissions(int perm)
set the permissions for this object; group bits are ignored; only owner & "other" permissions apply with this method owner id is taken from getRequestingUid() |
RowPermissions |
RowSecuredDBObject.getPermissions()
finds row permissions for the target row of this DBObject. if no row permissions are already persisted, the returned permissions object will be constructed and keyed to generating object, but all permissions will be false |
List |
RowSecuredDBObject.getReadGroups()
|
boolean |
RowSecuredDBObject.isRowAllowed(String requestedFunction)
determine if this function is allowed for this requesting user |
boolean |
RowSecuredDBObject.isRowAllowed(String requestedFunction,
Collection items)
iterate through collection, testing each row's privileges remove any row which does not have privileges; (do not throw security exception, just remove row) |
List |
RowSecuredDBObject.getWriteGroups()
|
void |
RowSecuredDBObject.add()
we override not to check permissions (which is done at the table level by superclass) but rather to add default permissions |
void |
RowSecuredDBObject.add(String group,
int permissions)
|
void |
RowSecuredDBObject.addGroupPerm(String group,
int perm)
add permissions for a group; will only ADD permissions, not replace will add row or update existing row (logical OR of bits) as necessary |
boolean |
RowSecuredDBObject.canRequesterAdministrate()
|
boolean |
RowSecuredDBObject.canRequesterRead()
determine if getRequestingUid has rights to read this row |
boolean |
RowSecuredDBObject.canRequesterWrite()
|
String |
RowSecuredDBObject.defaultGroup()
|
void |
RowSecuredDBObject.delete(boolean deleteDetails)
delete row. always delete permission records too |
void |
RowSecuredDBObject.deleteAll()
check that all objects can be deleted; must retrieve all objects to check individually |
boolean |
RowSecuredDBObject.find()
find object on criteria provided in fields |
int |
RowSecuredDBObject.ownerID()
|
void |
RowSecuredDBObject.removeGroup(String group)
remove a permissions group |
void |
RowSecuredDBObject.retrieve()
retrieve object on criteria provided in fields |
ArrayList |
RowSecuredDBObject.searchAndRetrieveList()
search on criteria provided in fields, and after search phase iterate through collection, testing each row's privileges remove any row which does not have privileges; (do not throw security exception, just remove row) |
ArrayList |
RowSecuredDBObject.searchAndRetrieveList(String sortKeys)
search on criteria provided in fields, and after search phase iterate through collection, testing each row's privileges remove any row which does not have privileges; (do not throw security exception, just remove row) sort results by sortKeys |
void |
RowSecuredDBObject.update()
before allowing update, check permission |
protected void |
RowSecuredDBObject.checkDeleteDetailPerm(DBObject obj)
check delete privilege for all detail records; different than superclass because we must set uid |
protected void |
RowSecuredDBObject.checkKeyLength()
// warn if key of this row may be too long |
void |
DBSequence.add()
|
void |
DBSequence.clear()
|
void |
DBSequence.createTable()
Create the sequence in the database. |
void |
DBSequence.delete()
|
boolean |
DBSequence.find()
|
long |
DBSequence.getNext()
|
abstract DBObject |
DBSequence.getThisDBObj()
NOTE: Subclass must override. |
void |
DBSequence.retrieve()
|
void |
DBSequence.search()
|
Vector |
DBSequence.searchAndRetrieve()
|
Vector |
DBSequence.searchAndRetrieve(String sortKeyString)
|
protected void |
DBSequence.setupFields()
make sure that you override the setupFields() method and supply the proper setup parameters. |
void |
DBSequence.update()
Not allowed... |
void |
DBSequence.verify()
Does nothing...I am not sure what do to verify a sequence. |
void |
DBObjectDef.addField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
void |
DBObjectDef.setDefaultValue(String fieldName,
String fieldValue)
Sets the default value for a particular field |
void |
DBObjectDef.addDetail(String objName,
String keyFieldsLocal,
String keyFieldsForeign)
Specify a new "detail" db object, and the fields in this object they specify the fields in the related object |
void |
DBObjectDef.addField(String fieldName,
String fieldType,
int fieldSize,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version of addfield supplies the allowNull flags and a description of the field to be used when reporting errors to the user. |
void |
DBObjectDef.addField(String fieldName,
String fieldType,
int fieldSize,
boolean allowNull,
String descriptionKey,
String fieldDescription)
Add a field with more details: This version of addfield supplies the allowNull flags and a description of the field to be used when reporting errors to the user. |
boolean |
DBObjectDef.allowsNull(String fieldName)
Returns whether the field allows null values or not. |
void |
DBObjectDef.setMask(String fieldName,
String newMask)
Sets the field's regular expression validation mask. |
void |
DBObjectDef.setAttribute(String fieldName,
String attribName,
Object attribValue)
|
Object |
DBObjectDef.getAttribute(String fieldName,
String attribName)
Gets an Object attribute from the field's metatdata |
Iterator |
DBObjectDef.getAttributesIterator(String fieldName)
|
void |
DBObjectDef.addKey(String keyFieldName)
Add a new field to the list of fields that are part of this object's key. |
void |
DBObjectDef.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
String fieldDescription)
Add a new virtual field to the definition of this object. |
void |
DBObjectDef.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
String descriptionKey,
String fieldDescription)
Add a new virtual field to the definition of this object. |
void |
DBObjectDef.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
void |
DBObjectDef.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String descriptionKey,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
void |
DBObjectDef.setCharset(String newCharSet)
Set a characterset for a particular field. |
String |
DBObjectDef.getDescription(String fieldName)
Return the long description of a field, if available |
String |
DBObjectDef.getLength(String fieldName)
Return the length of a field |
int |
DBObjectDef.getLengthInt(String fieldName)
|
int |
DBObjectDef.getPrecision(String fieldName)
|
String |
DBObjectDef.getLookupObject(String fieldName)
Get a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
String |
DBObjectDef.getType(String fieldName)
Return the type of a field - this method returns the internal Expresso type |
boolean |
DBObjectDef.isMultiValued(String fieldName)
Method called to determine if a particular field is multi-valued, that is does it have a set of specific values and descriptions |
boolean |
DBObjectDef.isReadOnly(String fieldName)
Is a given field readOnly - these fields are not offered for entry when a form is produced by the generic database maintenance servlet |
boolean |
DBObjectDef.isSecret(String fieldName)
Is a given field 'secret' - these fields are not shown when a list is produced by the generic database maintenance servlet (DBMaint). |
boolean |
DBObjectDef.isVirtual(String fieldName)
Is a given field virtual? |
void |
DBObjectDef.setLookupObject(String fieldName,
String objectName)
Set a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
void |
DBObjectDef.setMultiValued(String fieldName)
Set this field to be multi-valued - e.g. there is a specific list of values that are valid for this field. |
void |
DBObjectDef.setReadOnly(String fieldName)
Set a field as read-only - these fields are not offered for update when a form is produced by the generic database maintenance servlet (DBMaint). |
void |
DBObjectDef.setSecret(String fieldName)
Set a field as 'secret' - these fields are not shown when a list is produced by the generic database maintenance servlet. |
void |
DBObjectDef.setStringFilter(String fieldName,
String filterMethod)
Set a filter for a particular field. |
void |
DBObjectDef.setTargetTable(String theTable)
Set the target table for this DBObject. |
void |
DBObjectDef.setTargetDbSchema(String theSchema)
Set the target database schema for this DBObject. |
void |
DBObjectDef.setTargetDbCatalog(String theCatalog)
Set the target database schema for this DBObject. |
void |
DBObjectDef.addTransition(Transition t)
?????? |
Iterator |
DBObjectDef.getTransitionsIterator()
???????????? |
boolean |
DBObjectDef.isAllowsNull(String fieldName)
Returns whether the field allows null values or not. |
void |
DBObjectDef.setTargetStoreProcedure(String theStoreProcedure)
Set the target store procedure for this DBObject. |
void |
DBObjectDef.addInParam(String inFieldName)
Add a new field to the list of fields that are part of this object's list of input parameters. |
void |
DBObjectDef.addOutParam(String outFieldName)
Add a new field to the list of fields that are part of this object's list of output parameter. |
int |
DBObjectDef.getOutParamFieldsCount()
This convenience method counts DBFields belonging to this
DBObject that are set to retrieve.
|
void |
MultiDBObjectTransaction.setDBName(String newOther)
Set the database name/context for this multi db object. |
void |
DBObject.add()
Add a new record to the target table. |
int |
DBObject.loadFromConnection(DBConnection connection)
Hand a dbobject a connection that contains fields corresponding to what the dbobject expects, and it'll set itself. |
void |
DBObject.cacheIsChangedComparison()
reset 'original' value and isChanged flags on all fields, establishing a baseline for comparison. |
protected void |
DBObject.addDetail(String objName,
String keyFieldsLocal,
String keyFieldsForeign)
Specify a new "detail" db object, and the fields in this object they specify the fields in the related object |
protected void |
DBObject.addField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
protected void |
DBObject.addField(String fieldName,
String fieldType,
int fieldSize,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version of addfield supplies the allowNull flags and a description of the field to be used when reporting errors to the user. |
void |
DBObject.addIfNeeded()
Determine if a record with this key exists already - if not, add a new record. |
protected void |
DBObject.addIndex(String indexName,
String fieldNames,
boolean isUnique)
Add an index to the table. |
protected void |
DBObject.addKey(String keyFieldName)
Add a new field to the list of fields that are part of this object's key. |
void |
DBObject.addOrUpdate()
Determine if a record with these fields exists already - if so, update. |
protected void |
DBObject.addTransition(Transition t)
????? |
protected void |
DBObject.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
protected void |
DBObject.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
int fieldPrecision,
boolean allowNull,
String descripKey,
String fieldDescription)
Add a field with more details: This version allows the user to specify a precision, for fields that use both a size and precision. |
protected void |
DBObject.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
String fieldDescription)
Add a new virtual field to the definition of this object. |
protected void |
DBObject.addVirtualField(String fieldName,
String fieldType,
int fieldSize,
String descripKey,
String fieldDescription)
Add a new virtual field to the definition of this object. |
double |
DBObject.average(String fieldName)
Find the average of the values in the specified field of records selected by the DBObject selection criteria. |
void |
DBObject.basicAdd()
A "simplified"e; version of add that can be used to do a basic INSERT statement into this table. |
boolean |
DBObject.checkAllowed(String function)
No security is applied at the DBObject level, only at the level of SecuredDBObjects. |
protected void |
DBObject.checkAllReferredToBy()
Extended by subclasses to make calls to ReferredToBy as needed. |
protected void |
DBObject.checkAllRefs()
Extended by subclasses to make calls to checkRef as needed. |
void |
DBObject.checkAllRefsPublic()
Public interface to checkAllRefs() |
void |
DBObject.checkField(String fieldName,
String fieldValue)
Check that a given value is valid for a given field. |
protected void |
DBObject.checkRef(String foreignKeyNames,
DBObject refObject,
String errorMessage)
Convenience method for checking a reference where blank is *not* allowed in the foreign key; This test can be turned off if you add an Expresso setup (configuration) entry, 'isCheckRelationalIntegrity' set to false |
protected void |
DBObject.checkRef(String foreignKeyNames,
DBObject refObject,
String errorMessage,
boolean allowBlank)
Verify referential integrity from the given list of fields to the key fields in the given DB Object. |
void |
DBObject.clear()
Set all fields to empty value & clear the last result set & clear sort keys and customWhereClause |
void |
DBObject.clearDistinctFields()
This convenience method clears all the distinct flags of DBFields belonging to this
DBObject
author Peter Pilgrim |
void |
DBObject.clearFieldsToRetrieve()
This convenience method clears all the fileds to be retrieved DBFields belonging to this
DBObject
author Yves Henri Amaizo |
protected boolean |
DBObject.containsWildCards(String fieldValue)
See if this field value contains wild cards (e.g. pattern matching criteria for the database). |
int |
DBObject.count()
Just like find, but only retrieves the count, not the records themselves. |
void |
DBObject.delete()
Delete this record from the target table. |
void |
DBObject.delete(boolean deleteDetails)
Delete this record, optionally deleting any associated detail records. |
void |
DBObject.deleteAll()
Delete all of the records specified by the current search criteria. |
void |
DBObject.deleteAll(boolean oneByOne)
Delete all of the records specified by the current search criteria. |
protected void |
DBObject.deleteDetails(DBConnection detailConnection)
If this DB object has associated detail objects, locate the appropriate related detail records and delete them as well. |
protected void |
DBObject.checkDeleteDetailPerm(DBObject obj)
extracted for subclasses checking |
boolean |
DBObject.find()
A lot like retrieve, but works with any fields, not just the key field. |
String |
DBObject.formatDateTime(String fieldName)
Given the value of a date/time or date/time field, return the value formatted as appropriate for the current DBMS. |
Iterator |
DBObject.getAttributesIterator(String fieldName)
Get an iterator for all of the attributes specified for a field |
Enumeration |
DBObject.getDetails()
Get a list of all db objects that are specified as being "details" to this db object. |
int |
DBObject.getDistinctFieldCount()
This convenience method counts DBFields belonging to this
DBObject that are set to distinct. |
String[] |
DBObject.getDistinctFields()
This convenience method iterates through all the fields belonging to this DBObject
returns an array of field names ( String )
that are set to distinct. |
String |
DBObject.getField(String fieldName)
Get the string value of a field in this object as a string |
boolean |
DBObject.getFieldBoolean(String fieldName)
Boolean typesafe getField |
Date |
DBObject.getFieldDate(String fieldName)
Return the value of a field as a Date object |
String |
DBObject.getFieldDecimalFormatted(String fieldName,
String formatPattern)
Return the value of a field as a Date object |
float |
DBObject.getFieldFloat(String fieldName)
Get the primitive float value of a field in this object. we use the locale specified
in the properties file directly to determine how to parse the field |
double |
DBObject.getFieldDouble(String fieldName)
Get the primitive double value of a field in this object. we use the locale specified
in the properties file directly to determine how to parse the field |
BigDecimal |
DBObject.getFieldBigDecimal(String fieldName)
Get the BigDecimal value of a field in this object.
|
byte |
DBObject.getFieldByte(String fieldName)
Get the primitive byte value of a field in this object.
|
byte[] |
DBObject.getFieldByteArray(String fieldName)
Get the primitive byteArray value of a field in this object.
|
short |
DBObject.getFieldShort(String fieldName)
Get the primitive integer value of a field in this object.
|
int |
DBObject.getFieldInt(String fieldName)
Get the primitive integer value of a field in this object.
|
long |
DBObject.getFieldLong(String fieldName)
Get the prmitive long value of a field in this object.
|
void |
DBObject.saveBinaryField(String fieldName,
byte[] incomingData)
Deprecated. since Expresso 5.6. Use LobField directly or com.jcorporate.expresso.services.dbobj.MediaDBObject for BLOB storage since they all require much less memory as well as provides more dynamic database support. |
int |
DBObject.getFieldsToRetrieveCount()
This convenience method counts DBFields belonging to this
DBObject that are set to retrieve. |
Object[] |
DBObject.getIndexArray()
Deprecated. since 5.6, Use ((DBObjectDef)getMetaData()).getIndexArray() instead |
Iterator |
DBObject.getKeyFieldListIterator()
Get a list of all of the fields in this object This iterator is not thread safe. |
String |
DBObject.getLength(String fieldName)
Return the length of a field |
int |
DBObject.getLengthInt(String fieldName)
Get the length of this field as an integer |
String |
DBObject.getLookupObject(String fieldName)
Get a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
String |
DBObject.getMax(String fieldName,
boolean whereClause)
Get the Maximum value in the table of a particular field Contributed by Madan Mohanrao Kulkarni [kulsmadya@rediffmail.com] |
String |
DBObject.getMax(String fieldName)
Get the Maximum value in the table of a particular field Contributed by Madan Mohanrao Kulkarni [kulsmadya@rediffmail.com] |
String |
DBObject.getMyKeys()
Get a string consisting of the values of each key field for this object appended together with a | between them. |
int |
DBObject.getPrecision(String fieldName)
Get the precision of thie field, if one was specified |
String |
DBObject.getSerializedForm(DBField theField)
This function is called whenever the DBField is about to be written to the database. |
protected DBObject |
DBObject.getThisDBObj()
This will return a new object of the type of the subclass. |
DBObject |
DBObject.newInstance()
get a new instance of this object, with some basic attributes copied, like the local connection of the transaction Generally speaking, DO NOT OVERRIDE THIS METHOD. |
protected void |
DBObject.copyAttributes(DBObject returnObj)
called by newInstance(), this method should make sure that the newly created object is properly initialized |
static DBObject |
DBObject.getThisDBbj(DataTransferObject dto)
Constructor method that takes a DataTransferObject and builds a full fledged DBObject out of it. |
DataTransferObject |
DBObject.getDataTransferObject()
Gets the data transfer object usually for serialization purposes |
void |
DBObject.setDataTransferObject(DataTransferObject dto)
fill fields with values found in dto; REPLACES any data field already present. |
String |
DBObject.getValidValueDescrip(String fieldName)
This is a convenience method which will return a ValidValue description for a multi-valued field. |
List |
DBObject.getValidValuesList(String fieldName)
Retrieve a list of valid value object for this particular dbobject |
Vector |
DBObject.getValidValues(String fieldName)
New method to replace getValues with a structure of valid values and descriptions. |
Vector |
DBObject.getValues()
Method to return a Vector of ValidValue Template method--not implemented in this superclass. |
protected Vector |
DBObject.getValuesDefault(String valueField,
String descripField)
Basic version of getValidValues that stores/retrieves the valid values in a Cache. |
protected Vector |
DBObject.getValuesDefault(String valueField,
String descripField,
String whereClause)
Basic filtered version of getValidValues that stores/retrieves the valid values in a Cache. |
protected Vector |
DBObject.getValuesDefault(String valueField,
String descripField,
String whereClause,
String sortKeyString)
Basic version of getValidValues that stores/retrieves the valid values in a Cache. |
protected Vector |
DBObject.getISOValuesDefault(String valueField,
String descripField)
Basic version of getValidValues with supports internationalisation (i18n) that stores/retrieves the valid values in a locale dependent Caches Valid values are store inside cache with a key name that equals myClassName+"." |
protected Vector |
DBObject.getISOValuesDefault(String valueField,
String descripField,
String whereClause)
Basic filtered version of getValidValues with supports internationalisation (i18n) that stores/retrieves the valid values in a locale dependent Caches Valid values are store inside cache with a key name that equals myClassName+"." |
protected Vector |
DBObject.getISOValuesDefault(String valueField,
String descripField,
String whereClause,
String sortKeyString)
Basic version of getValidValues with supports internationalisation (i18n) that stores/retrieves the valid values in a locale dependent Caches. |
boolean |
DBObject.haveAllKeys()
See if we have a value for each of the key fields |
protected void |
DBObject.initialize()
Sets up metadata for the dbobject via call to setupFields(). |
boolean |
DBObject.isDistinct()
This method iterates through all the DBFields belonging
DBObject returns true if any of them are
set a distinct.
|
boolean |
DBObject.isFieldNull(String fieldName)
Tells whether a particular field is null or not. |
boolean |
DBObject.isEmpty()
Return true if every field in this object is empty or null. |
boolean |
DBObject.isFieldDistinct(String fieldName)
Convenience method to check if a field is distinct or not within this database object. |
boolean |
DBObject.isFieldsToRetrieve()
This method iterates through all the DBFields belonging
DBObject returns true if any of them are
between the retrieve fields.
|
boolean |
DBObject.isFieldToRetrieve(String fieldName)
Convenience method to check if a field is field to be retrieve or not within this database object. |
boolean |
DBObject.isMultiValued(String fieldName)
Deprecated. since 5.6, use getJDBCMetaData().isMultiValued(String) |
boolean |
DBObject.isReadOnly(String fieldName)
Deprecated. since 5.6, use getJDBCMetaData().isReadOnly(String) |
boolean |
DBObject.isSecret(String fieldName)
Deprecated. since 5.6, use getJDBCMetaData().isSecret(String) |
boolean |
DBObject.isVirtual(String fieldName)
Deprecated. since 5.6, use getJDBCMetaData().isVirtual(String) |
double |
DBObject.max(String fieldName)
Find the maximum of the values in the specified field of records se;lected by the DBObject selection criteria. |
double |
DBObject.min(String fieldName)
Find the minimum of the values in the specified field of records selected by the DBObject selection criteria. |
protected void |
DBObject.notifyListeners(String eventCode)
Used by internal caching to ensure that caches are cleared when an update is made. |
void |
DBObject.populateDefaultValues()
populateDefaultValues is called by the schema object to allow a table to populate itself with any desired values. |
protected void |
DBObject.referredToBy(DBObject refObject,
String foreignKeyNames,
String errorMessage)
The reverse of the checkRef method - if this object is referred to by some other object, and we are changing our own key (only allowed by deleting) then check the other table to make sure our key is not being used by it! |
void |
DBObject.removeFromCache(DBObject theDBObj)
Remove a specific object from that object's cache. |
void |
DBObject.retrieve()
Get a particular record from the database into this object's fields Key fields for this object must be set; throws otherwise |
boolean |
DBObject.retrieveFromCache()
Retrieve this object from cache, if possible. |
void |
DBObject.search()
Find a set of keys of all of the objects that match the current search critieria in the fields. |
void |
DBObject.search(String sortKeyString)
Second form of search: takes a list of sort keys & calls regular search. |
ArrayList |
DBObject.searchAndRetrieveList()
Find a set of records of all of the objects that match the current search critieria in the fields and retrieve the list of all records that match this criteria NOTE: Criteria in 'text' type colums is ignored (SQL Server limitation) SIDE-EFFECT: custom 'where' clause is set to null. |
ArrayList |
DBObject.searchAndRetrieveList(String sortKeyString)
Search and retrieve in a particular order |
void |
DBObject.setCharset(String newCharSet)
Set a characterset for a particular field. |
boolean |
DBObject.getCheckZeroUpdate()
Gets the check zero update flags for this DBObject. |
void |
DBObject.setCheckZeroUpdate(boolean newFlag)
Turn on or off the facility to verify that when an update is made that at least one record got updated. |
void |
DBObject.setConnection(DBConnection newConnection)
Set a specific DB connection for use with this db object. |
void |
DBObject.setConnection(DBConnection newConnection,
String setupTablesContext)
Set a specific DB connection for use with this db object. |
protected void |
DBObject.setDefaultValue(String fieldName,
String fieldValue)
Define a "default" value for a field - to be used for the field when the user does not specify a value. |
void |
DBObject.setDescription(String newDescription)
Set the description of this object |
void |
DBObject.setField(String fieldName,
byte fieldValue)
Byte primitive integer Typesafe version of setField. |
void |
DBObject.setField(String fieldName,
byte[] fieldValue)
Byte primitive integer Typesafe version of setField. |
void |
DBObject.setField(String fieldName,
short fieldValue)
Short primitive integer Typesafe version of setField. |
void |
DBObject.setField(String fieldName,
int fieldValue)
Integer primitive Typesafe version of setField. |
void |
DBObject.setField(String fieldName,
long fieldValue)
Long primitive Typesafe version of setField.
|
void |
DBObject.setField(String fieldName,
double fieldValue)
Double primitive Typesafe version of setField.
|
void |
DBObject.setField(String fieldName,
BigDecimal fieldValue)
BigDecimal object Typesafe version of setField.
|
void |
DBObject.setField(String fieldName,
boolean fieldValue)
Boolean typesafe version of setField |
protected String |
DBObject.getBooleanFieldValue(boolean fieldValue)
Internal refactoring for getting what a boolean field should be set to. |
void |
DBObject.setField(String fieldName,
String fieldValue)
Set the given field to a given value. |
void |
DBObject.setField(String fieldName,
Date fieldValue)
Date object Typesafe version of setField.
|
void |
DBObject.setFieldDistinct(String fieldName,
boolean flag)
Convenience method to set a field to be distinct or not within this database object. |
void |
DBObject.setFieldsToRetrieve(String fieldNames)
Convenience method to set the fields to be retrieved within this database object. |
void |
DBObject.setKeys(String keyValues)
Set the values for each of the key fields of this object from a /-delimited string |
void |
DBObject.setLookupObject(String fieldName,
String objectName)
Set a field's lookup object - this is the name of another database object that can be used to look up valid values for this object. |
protected void |
DBObject.setMask(String fieldName,
String newMask)
Set a "mask", or regular expresso to be matched, for the named field. |
void |
DBObject.setMaxRecords(int newMax)
Specify a maximum number of records to be retrieved in any subsequent searchAndRetrieve() call. |
protected void |
DBObject.setMultiValued(String fieldName)
Set this field to be multi-valued - e.g. there is a specific list of values that are valid for this field. |
protected void |
DBObject.setName(String theName)
Set the name of this object - this name is used to identify the db object with a more human-readable description |
void |
DBObject.setOffsetRecord(int newOffset)
Specifies the number of records that should be skipped over before any data from the ResultSet
is retrieved in any subsequent
searchAndRetrieve() call. |
void |
DBObject.setReadOnly(String fieldName)
Set a field as read-only - these fields are not offered for update when a form is produced by the generic database maintenance servlet (DBMaint). |
void |
DBObject.setSchema(Schema schema)
Specify which schema this DB object belongs to. |
void |
DBObject.setSecret(String fieldName)
Set a field as 'secret' - these fields are not shown when a list is produced by the generic database maintenance servlet. |
String |
DBObject.setStringFilter(String fieldName,
String filterMethod)
Set a filter for a particular field, permanently for all instances of this class. |
String |
DBObject.getStringFilter(String fieldName)
get the current filter for a particular field. |
void |
DBObject.setTargetTable(String theTable)
Set the target table for this DBObject. |
void |
DBObject.setTargetDbSchema(String theDbSchema)
Set the target table for this DBObject. |
protected void |
DBObject.setupFields()
Method to set up the fields for this database object. |
protected double |
DBObject.sqlAggrFunction(String func,
String fieldName)
This allows the invocation of the SQL AVG, MIN, MAX and SUM aggregate functions on one of the DB's columns (the DBObject fieldname is supplied). |
double |
DBObject.sum(String fieldName)
Find the sum of the values in the specified field of records selected by the DBObject selection criteria. |
void |
DBObject.update()
Update the database with the new info. |
void |
DBObject.update(boolean updateChangedFieldsOnly)
Update the database with the new info. |
void |
DBObject.updateAll()
Update all of the records specified by the current search criteria. |
void |
DBObject.updateAll(boolean oneByOne)
Update the database with the new info. |
void |
DBObject.verify()
Verify that this object is working correctly by selecting all records, running a validation on each of them. |
DataField |
DBObject.getDataField(String fieldName)
Same as getField, but works with the DataObject interface for now. |
void |
DBObject.setStringFiltersOnAll(String filter)
set string filters to the given filter on ALL fields that are quoted text fields |
boolean |
DBObject.isChanged()
summarize DataField.isChanged() for all fields. |
Vector |
LookupInterface.getValues()
Method to return a Vector of ValidValue This method may be implemented by objects that want to provide a list of valid values for other DB objects. |
void |
CacheUtils.addUnmodifiedToCache(DBObject theDBObj)
Adds a non-modified object to the cache. |
void |
CacheUtils.addToCache(DBObject theDBObj)
When using basic caching, this method is used to add a new DB object to the cache, where it is later used when retrieveing data instead of going directly to the database. |
String |
DBField.setFilterMethod(String newMethod)
Set's the name of the filter method to be used |
void |
DBField.setDefaultMask()
Set the field's default mask according to it's type |
void |
DBField.setFilterClass(Class filterClass)
Set's the name of the filter class to be used used in conjuction with get/setFilterMethod |
static NextNumber |
NextNumber.getInstance()
Factory Method returns a constructed instance of the NextNumber Manager. |
protected long |
NextNumber.getMax(String db,
DBObject callingObject,
String oneField)
Gets the maximum value for a particular object and field Used if there's no value loaded in memory or state. |
abstract void |
NextNumber.registerField(String db,
DBObject callingDBObject,
String fieldName)
Register a field for next number information. |
abstract long |
NextNumber.getNext(String db,
DBObject callingDBObject,
String fieldName)
Get the nextnumber for this dbobject. |
protected String |
NextNumber.getKey(DBObject callingDBObject,
String fieldName)
Builds the key string for lookup within the dbobject hashmap. |
void |
AuditedSecuredDBObject.add()
The add method writes an entry to the AuditLog with the ADD code. |
void |
AuditedSecuredDBObject.delete()
The Delete method first writes an entry to the AuditLog table, then deletes the object. |
void |
AuditedSecuredDBObject.update()
The update method first writes an entry to the AuditLog, then updates the DBObject. |
DBObject |
AutoDBObject.getThisDBObj()
getThisDBObj method comment. |
void |
AutoDBObject.setTargetTable(String theTable)
Set the target table for this AutoDBObject - this causes the object to set itself up with the fields from the database as it's fields. |
protected void |
AutoDBObject.setupFields()
setupFields method. |
void |
NextNumberImpl.initialize(String db,
DBObject callingObject)
Initializes hash entries for all auto-inc fields in a particular DBOBject. |
void |
NextNumberImpl.registerField(String db,
DBObject callingDBOBject,
String fieldName)
Register a field for next number information. |
protected void |
NextNumberImpl.checkParams(String db,
DBObject callingObject,
String fieldName)
All parameters are fully checked to avoid potential NullPointerExceptions |
long |
NextNumberImpl.getNext(String db,
DBObject callingDBObject,
String fieldName)
Get the nextnumber for this dbobject. |
| Constructors in com.jcorporate.expresso.core.dbobj that throw DBException | |
HistAuditSecuredDBObject()
Construct an audit secured DBObject |
|
HistAuditSecuredDBObject(DBConnection theConnection)
Constructor |
|
SecuredDBObject()
Constructor |
|
SecuredDBObject(DBConnection newConnection)
Constructor that sets the connection on create |
|
SecuredDBObject(DBConnection newConnection,
String setupTablesContext)
Constructor that sets a connection as the object is created - typically this is used when a particular DBConnection is required for the purposes of maintaining a database transaction. |
|
SecuredDBObject(ControllerRequest request)
Constructor that sets user ID and data context from request |
|
SecuredDBObject(int newUid)
Constructor: Specify a DB connection AND user |
|
SecuredDBObject(DBConnection theConnection,
int theUser)
Constructor: Specify a DB connection AND user id |
|
SecuredDBObject(RequestContext request)
For using DBObjects within Controllers. |
|
SecuredDBObject(String dbKey,
int theUser)
Alternate form of constructor, specifying the db name/context and the user at once |
|
MultiDBObject()
MultiDBObject constructor. calls setupFields. |
|
MultiDBObject(ControllerRequest request)
MultiDBObject constructor which sets dbname from request |
|
RowSecuredDBObject()
Constructor without parameters. |
|
RowSecuredDBObject(DBConnection theConnection,
int theUser)
Constructor: Specify a DB connection AND user id. |
|
RowSecuredDBObject(int theUser)
Creates a new RowSecuredDBObject object. |
|
RowSecuredDBObject(RequestContext request)
Creates a new RowSecuredDBObject object. |
|
DBSequence()
DBSequence constructor comment. |
|
DBSequence(DBConnection theConnection)
Creation date: (4/7/00 2:45:10 PM) |
|
DBSequence(int uid)
|
|
MultiDBObjectTransaction()
MultiDBObjectTransaction constructor comment. |
|
DBObject()
Default Constructor. |
|
DBObject(DBConnection newConnection)
Constructor that sets a connection as the object is created - typically this is used when a particular DBConnection is required for the purposes of maintaining a database transaction. |
|
DBObject(DBConnection newConnection,
String setupTablesContext)
Constructor that sets a connection as the object is created - typically this is used when a particular DBConnection is required for the purposes of maintaining a database transaction. |
|
DBObject(RequestContext request)
For using DBObjects within Controllers. |
|
DBObject(String newdbKey)
Initialize this DBObject and set the db/context to the specified key |
|
DBField(String myName,
String myType,
int mySize,
int newPrecision,
boolean myAllowNull,
String myDescrip)
Constructor: A DBField is initialized knowing it's name, type, size, description and whether or not it can accept null or empty values |
|
DBField(String myName,
String myType,
int newPrecision,
boolean myAllowNull,
String myDescrip)
constructor for types with no size |
|
AuditedSecuredDBObject()
Constructor |
|
AuditedSecuredDBObject(DBConnection theConnection)
AuditedSecuredDBObject Constructor Constructor. |
|
AutoDBObject()
AutoDBObject constructor comment. |
|
AutoDBObject(DBConnection newConnection)
AutoDBObject constructor comment. |
|
AutoDBObject(int uid)
Initialize an AutoDBObject with a uid. |
|
| Uses of DBException in com.jcorporate.expresso.core.job |
| Methods in com.jcorporate.expresso.core.job that throw DBException | |
JobQueue |
Job.getJobQueueEntry()
Return the job queue entry that caused this job to begin |
protected String |
Job.getDataContext()
Retrieve the data context of the job |
protected boolean |
Job.hasParameters()
Does this job have parameters? |
protected List |
Job.getJobParameterList()
Returns a List of the parameters given to the job |
protected String |
Job.getJobParameter(String paramCode)
Convenience method to get the job parameters one by one as needed. |
| Uses of DBException in com.jcorporate.expresso.core.logging |
| Methods in com.jcorporate.expresso.core.logging that throw DBException | |
static String |
Log.clear()
Deprecated. Delete all current database log entries |
| Uses of DBException in com.jcorporate.expresso.core.misc |
| Methods in com.jcorporate.expresso.core.misc that return DBException | |
DBException |
OSProcess.getException()
?? |
| Methods in com.jcorporate.expresso.core.misc that throw DBException | |
static String |
DateTime.getDateTimeForDB()
Get a date/time field formatted for insertion into a database Value of the date/time is the current date and time |
static String |
DateTime.getDateTimeForDB(String dbContext)
Get a date/time field formatted for insertion into a database Value of the date/time is the current date and time |
static String |
DateTime.getDateTimeForDB(int year,
int month,
int day,
int hour,
int min,
int sec,
String context)
Get a date/time field formatted for insertion into a database Value of the date/time is the current date and time |
static String |
DateTime.getDateTimeForDB(Date date,
String context)
Get a date/time field formatted for insertion into a database |
static String |
DateTime.getDateTimeForDB(int year,
int month,
int day,
int hour,
int min,
int sec)
Get a date/time field formatted for insertion into a database Value of the date/time is the current date and time |
static String |
DateTime.getDateTimeForDB(Date date)
Get a date/time field formatted for insertion into a database (default context) |
static String |
DateTime.getTimeForDB()
Get a time field formatted for insertion into a database Value of the time is the current time |
static String |
DateTime.getTimeForDB(int hour,
int min,
int sec)
Get atime field formatted for insertion into a database |
static String |
DateTime.getTimeForDB(Date date)
Get a time field formatted for insertion into a database |
static String |
DateTime.getTimeForDB(Date date,
String context)
Takes into account for the database context. |
static String |
DateTime.getDateForDB()
Get a date field formatted for insertion into a database Value of the date is the current date author Yves Henri AMAIZO |
static String |
DateTime.getDateForDB(int year,
int mon,
int day)
Get a date field formatted for insertion into a database author Yves Henri AMAIZO |
static String |
DateTime.getDateForDB(Date date)
Get a time field formatted for insertion into a database author Yves Henri AMAIZO |
static String |
DateTime.getDateForDB(Date date,
String context)
Takes into account for the database context. |
int |
OSProcess.getExitValue()
Retrieve the operating system exit value. |
void |
OSProcess.runProcess()
Run the process on the server, timing out when required |
static void |
EventHandler.flush()
|
static void |
ConfigManager.dbUninitialize()
Remove our database pool(s) Closes all connections so that Hypersonic can handle multiple test suites from multiple VM's thrown at it as long as each test suite calls dbUninitialize in the teardown method. |
static void |
ConfigManager.load(String theConfigDir)
"Second stage" configuration. |
ArrayList |
RecordPaginator.searchAndRetrieve(DataObject searchCriteria,
String sortKey)
Returns a search and retrieve list from the DBObject who's criteria you have set. |
List |
RecordPaginator.searchAndRetrieve(MultiDBObject searchCriteria,
String sortKey)
Returns a search and retrieve list from the DBObject who's criteria you have set. |
protected void |
RecordPaginator.setPageLimitAttribute(DataObject dbObj)
Sets the size of the page limit. |
protected void |
RecordPaginator.setPageLimitAttribute(MultiDBObject dbObj)
Sets the size of the page limit. |
| Uses of DBException in com.jcorporate.expresso.core.security |
| Methods in com.jcorporate.expresso.core.security that throw DBException | |
void |
UserInfo.add()
Adds the current UserInfo object into the repository |
void |
UserInfo.delete()
Deletes the current UserInfo object from the repository |
boolean |
UserInfo.find()
Find a UserInfo object in the repository that matches the non-empty properties filled in the current UserInfo object |
String |
UserInfo.getAccountStatus()
Retrieve the current account status. |
Vector |
UserInfo.getAllUsers()
Returns a Vector of all the UserInfo objects in the repository |
String |
UserInfo.getCreateDate()
Returns the date that this UserInfo object was created |
String |
UserInfo.getEmail()
Returns the email address for this user |
String |
UserInfo.getEmailAuthCode()
Returns the email auth code previously set for this user |
String |
UserInfo.getEmailValCode()
Retrieve the validation code required for authorization by email |
String |
UserInfo.getField(String fieldName)
Deprecated. Use the direct getLoginName, getEmail, getPassword, etc. methods instead |
Vector |
UserInfo.getGroups()
Return a vector of the group names that this user belongs to |
String |
UserInfo.getLoginName()
Returns the login name of this user |
String |
UserInfo.getPassword()
Returns the password for this user |
boolean |
UserInfo.getRegComplete()
Returns the status of whether extended registration has been completed or not Valid values are "Y" or "N" |
String |
UserInfo.getRegistrationDomain()
Returns the unique integer for the registration domain that this user belongs to |
int |
UserInfo.getUid()
Returns the user id for this user |
String |
UserInfo.getUpdateDate()
Returns the date that this UserInfo object was last modified |
String |
UserInfo.getUserName()
Returns the descriptive string for this user |
boolean |
UserInfo.passwordEquals(String testPassword)
Checks if the given password equals what we have on file. |
void |
UserInfo.retrieve()
Retrieves the current user from the repository |
void |
UserInfo.sendAuthEmail()
|
void |
UserInfo.sendFollowUpEmail()
|
void |
UserInfo.setAccountStatus(String accountStatus)
Sets the current status of the account - "A" (active), "D" (disabled), "I" (inactive) |
void |
UserInfo.setDBName(String newDBName)
Sets the DB context |
void |
UserInfo.setEmail(String email)
Sets the email address |
void |
UserInfo.setEmailValCode(String code)
Sets the code required for auth. via email |
void |
UserInfo.setLoginName(String loginName)
Sets the login name |
void |
UserInfo.setPassword(String password)
Sets the password |
void |
UserInfo.setRegComplete(boolean status)
Sets the extended registration complete flag - "Y" or "N" |
void |
UserInfo.setRegistrationDomain(String id)
Sets the registration domain |
void |
UserInfo.setUid(int uid)
Sets the user UID |
void |
UserInfo.setUserName(String name)
Sets the user name |
void |
UserInfo.update()
Update the user in the repository with modified properties |
String |
UserInfo.getPrimaryGroup()
the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission |
String |
UserInfo.hashEncodePassword(String password)
this returns an appropriately hashed password. |
void |
User.add()
Adds this user to the underlying storage mechanism (SQL-DB, LDAP, etc.) |
void |
User.addNotify(UserInfo uif)
Used when a UserInfo Object adds itself outside of the 'User' class. |
boolean |
User.checkEmailAuthCode(String emailAuthCode)
This method just checks to make sure that the submitted emailAuthCode matches the real code. |
void |
User.clear()
Uncaches the underlying UserInfo implementation object |
void |
User.delete()
Calls back registered listeners so they can cleanup and then deletes the user |
void |
User.deleteNotify(UserInfo uif)
Used for when a UserInfo implementation deletes itself outside of the User Interface |
boolean |
User.find()
Find a user matching the values of the properties that have been set |
String |
User.getAccountStatus()
Returns the current status of the account. |
Vector |
User.getAllUsers()
Returns a list of all the Users in the database. |
String |
User.getEmail()
Returns the email address of the user |
String |
User.getEmailAuthCode()
Here we generate an authorization code that would be hard for someone to guess. |
String |
User.getEmailValCode()
Returns the code required for authorization via email |
Vector |
User.getGroups()
Return a vector of the group names that this user belongs to |
List |
User.getGroupsList()
Return a List of the group names that this user belongs to |
String |
User.getLoginName()
Returns the string that the user needs to use to login. |
String |
User.getPassword()
Returns the password string for the user. |
UserInfo |
User.getNotLoggedInUser()
Returns the static constant notLogged in user. |
protected UserInfo |
User.constructNotLoggedInUser()
|
boolean |
User.getRegComplete()
Whether registration has been completed beyond the basic user info |
String |
User.getRegistrationDomain()
Returns the unique integer for the registration domain that this user belongs to |
String |
User.getUidString()
Returns the unique integer used as a key to identify the user |
int |
User.getUid()
|
UserInfo |
User.getUserInfo()
Return the UserInfo object Normally you would not use this directly, except in special cases where you need to get to the UserInfo object. |
String |
User.getDisplayName()
Returns a descriptiptive, longer name for the user this is NOT THE UNIQUE LOGIN NAME. |
Vector |
User.getValidValues(String fieldName)
Returns the possible values for the multivalued properties |
Vector |
User.getValues()
|
void |
User.notify(String subject,
String message)
Send this user a notification via e-mail. |
void |
User.notify(String subject,
String message,
boolean htmlFormat)
Notify the user with the optional parameter of using html format |
void |
User.notify(String subject,
String message,
boolean htmlFormat,
ByteArrayDataSource[] attachments)
Notify the user with the optional parameter of using html format with virtual raw data attachments. |
boolean |
User.passwordEquals(String tryPassword)
passwordEquals - feed it a password and it will tell you if the hash of it matches the one on file. |
void |
User.postLogin()
Called by the various objects that can log in a user to do post-login tasks |
void |
User.retrieve()
|
void |
User.sendAuthEmail()
|
void |
User.sendFileTo(String subject,
String message,
Vector fileNames)
Send this user an e-mail with file attachments. |
void |
User.sendFollowUpEmail()
|
void |
User.setAccountStatus(String accountStatus)
Sets the current status of the account |
void |
User.setDBName(String newDBName)
Switches data contexts for the User Object |
void |
User.setEmail(String email)
Sets the email address for the user |
void |
User.setEmailValCode(String code)
Sets the validation code for authorization via email |
void |
User.setLoginName(String loginName)
Sets the name to be used by this user to login |
void |
User.setPassword(String password)
Sets the password to be used by the user. |
void |
User.setRegComplete(boolean status)
Sets the status of whether the extended registration has been completed or not |
void |
User.setRegistrationDomain(String domain)
Sets the registration domain that this user belongs to |
void |
User.setUid(int uid)
Sets the uid, used for finding... |
void |
User.setUid(String uid)
Sets the user id. |
void |
User.setDisplayName(String name)
Sets a long, descriptive name for the user |
void |
User.update()
This method is called to update the properties of an User object. |
void |
User.updateNotify(UserInfo uif)
Used to notify UserListeners that a UserInfo object has modified itself outside of the User object. |
boolean |
User.isAdmin()
determine if this user is admin |
static boolean |
User.isAdmin(int id)
determine if this user is admin WARNING: assumes dbname = 'default' |
static int |
User.getAdminId()
determine admin id (usually '3') WARNING: assumes dbname = 'default' |
static User |
User.getAdmin(String dbName)
Retrieves the User instance of the current user. |
static int |
User.getAdminId(String dbname)
determine admin id (usually '3') |
String |
User.getPrimaryGroup()
the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission |
static int |
User.getIdFromLogin(String login,
String myDBname)
utility |
static User |
User.getUserFromId(int uid,
String dataContext)
Pull up the User object associated with the integer id |
static String |
User.getLoginFromId(int uid,
String dataContext)
utility |
static User |
User.getUser(ControllerRequest request)
Convenience routine to find current user. |
boolean |
User.isMember(String candidategroupname)
determine whether this user is in this group |
void |
UserListener.addedUser(User user)
This method is called just after a new user is added Creation date: (5/12/2001 2:26:17 PM) |
void |
UserListener.deletedUser(User user)
This method is called just before a user is deleted Creation date: (5/12/2001 2:26:17 PM) |
void |
UserListener.loggedOffUser(User user)
This method is called just before a user is logged off Creation date: (5/12/2001 2:26:17 PM) |
void |
UserListener.loggedOnUser(User user)
This method is called just after a user is logged on Creation date: (5/12/2001 2:26:17 PM) |
void |
UserListener.modifiedUser(User user)
This method is called just after a user is modified Creation date: (5/12/2001 2:26:17 PM) |
void |
MapBasedUserInfo.add()
|
void |
MapBasedUserInfo.delete()
|
boolean |
MapBasedUserInfo.find()
|
String |
MapBasedUserInfo.getAccountStatus()
Retrieve the current account status. |
Vector |
MapBasedUserInfo.getAllUsers()
Unsupported operation |
String |
MapBasedUserInfo.getCreateDate()
|
String |
MapBasedUserInfo.getEmail()
|
String |
MapBasedUserInfo.getEmailAuthCode()
|
String |
MapBasedUserInfo.getEmailValCode()
|
String |
MapBasedUserInfo.getField(String fieldName)
Deprecated. Use the direct getLoginName, getEmail, getPassword, etc. |
Vector |
MapBasedUserInfo.getGroups()
Currently unsupported. |
String |
MapBasedUserInfo.getLoginName()
|
String |
MapBasedUserInfo.getPassword()
|
String |
MapBasedUserInfo.getPrimaryGroup()
|
String |
MapBasedUserInfo.hashEncodePassword(String password)
this returns an appropriately hashed password. |
boolean |
MapBasedUserInfo.getRegComplete()
|
String |
MapBasedUserInfo.getRegistrationDomain()
|
int |
MapBasedUserInfo.getUid()
|
String |
MapBasedUserInfo.getUpdateDate()
|
String |
MapBasedUserInfo.getUserName()
|
Vector |
MapBasedUserInfo.getValues()
Unsupported Operation |
boolean |
MapBasedUserInfo.passwordEquals(String testPassword)
Checks if the given password equals what we have on file. |
void |
MapBasedUserInfo.retrieve()
|
void |
MapBasedUserInfo.sendAuthEmail()
Not Implemented |
void |
MapBasedUserInfo.sendFollowUpEmail()
Not Implemented |
void |
MapBasedUserInfo.setAccountStatus(String accountStatus)
|
void |
MapBasedUserInfo.setDBName(String newDBName)
|
void |
MapBasedUserInfo.setEmail(String email)
|
void |
MapBasedUserInfo.setEmailValCode(String code)
Sets the code required for auth. |
void |
MapBasedUserInfo.setLoginName(String loginName)
|
void |
MapBasedUserInfo.setPassword(String password)
|
void |
MapBasedUserInfo.setRegComplete(boolean status)
|
void |
MapBasedUserInfo.setRegistrationDomain(String id)
|
void |
MapBasedUserInfo.setUid(int uid)
|
void |
MapBasedUserInfo.setUserName(String name)
|
void |
MapBasedUserInfo.update()
There should be no copying and detaching from the datasource. |
| Uses of DBException in com.jcorporate.expresso.core.servlet |
| Methods in com.jcorporate.expresso.core.servlet that throw DBException | |
boolean |
DBServlet.requireLogin(HttpServletRequest req,
HttpServletResponse res,
String nextURL)
Deprecated. does nothing but return false; |
abstract void |
InitServlet.loadLists()
This method is used to load "lists" and cache them in ConfigManager list cache. |
void |
DefaultInit.loadLists()
This method is used to load "lists" and cache them in ConfigManager list cache. |
| Uses of DBException in com.jcorporate.expresso.core.utility |
| Methods in com.jcorporate.expresso.core.utility that throw DBException | |
static void |
ReNameUtil.processDB(String configDir,
String db)
|
static void |
DBTool.deleteTable(String dbName,
String tableName)
Delete Table - Deletes a table from the specified db |
static void |
DBTool.deleteSchema(Page myPage,
String dbName,
Vector schemas)
Method wipes out more than one installed schema. |
static void |
DBTool.deleteSchema(Page myPage,
String dbName,
String schemaName)
Method to remove an installed schema. |
static List |
DBTool.compareTables(InstallLog theLog,
Vector allSchemas,
String dbName)
Reverse engineer the table for each db object for every known schema, then compare the fields in the database to the fields in the db object and report on the differences to the the log and to System.err todo why isn't this log passed in used? |
static void |
DBTool.createTables(InstallLog theLog,
Vector allSchemas,
String dataContext)
Create the tables required by the database objects in the list of schemas. |
static void |
DBTool.otherSetups(InstallLog theLog,
Vector allSchemas,
String dbName)
Method to perform any other additonal setup required by each schema |
static void |
DBTool.populateTables(InstallLog installLog,
Vector allSchemas,
String dbName)
This method goes through the schemas and populates tables with default values if they do not exist. |
static void |
DBTool.setupConfig(InstallLog installLog,
Vector allSchemas,
String dbName)
Method to set up the default Setup values for each schema. |
static void |
DBTool.setupSecurity(InstallLog theLog,
Vector allSchemas,
String dbName)
This method creates default security entries for all of the database objects and controller objects for the known schemas. |
void |
QueueJob.queueJob(Hashtable args)
Actually queue the requested job |
static void |
JobHandler.resetQ(String dbName)
Resets any 'running' jobs on startup to available. |
protected void |
JobHandler.resetCurrentJobs()
Marks all current running jobs as "Available" |
| Constructors in com.jcorporate.expresso.core.utility that throw DBException | |
RunURL(String URLString)
Constructor |
|
JobHandler(String dbName)
Constructor |
|
| Uses of DBException in com.jcorporate.expresso.ext.controller |
| Methods in com.jcorporate.expresso.ext.controller that throw DBException | |
Block |
RunSQL.getTableDefinition(String dataContext,
String def)
Builds a table definition and enters it into a block. |
protected boolean |
Download.isAllowed(ControllerRequest request,
DownloadFiles oneFile,
User myUser)
Is it allowed for this user to download this particular file? |
protected String |
Download.getFriendlyName(DownloadFiles oneDownloadFile)
Returns the friendly download name |
| Uses of DBException in com.jcorporate.expresso.ext.dbobj |
| Methods in com.jcorporate.expresso.ext.dbobj that throw DBException | |
void |
DownloadFiles.add()
Extends the usual add method to fetch a next number field |
void |
DownloadFiles.update()
|
void |
DownloadFiles.checkField(String fieldName,
String fieldValue)
Overrided to check to make sure that the entered file pathname points to a real file. |
void |
DownloadFiles.setupFields()
Define the table and fields for this object |
void |
ISOCountryCodes.populateDefaultValues()
This function populates the table with the current listing of ISO country codes |
Vector |
ISOCountryCodes.getValues()
|
boolean |
ISOCountryCodes.checkPostalCode(String testPostalCode)
Checks a postal code for proper formatting The iso country definition should already have been retrieved. |
protected void |
ISOCountryCodes. |