Expresso 5-6

Uses of Class
com.jcorporate.expresso.core.dbobj.DBObject

Packages that use DBObject
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.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.dbobj Ancestor objects for all Database Objects and Schemas.  
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.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.dbobj Common database objects - used in many different applications 
 

Uses of DBObject in com.jcorporate.expresso.core.controller
 

Methods in com.jcorporate.expresso.core.controller with parameters of type DBObject
 void ControllerRequest.populate(DBObject myDBObj)
          Convenience method to populate a dbobject from the parameters supplied, by looking for parameters with the same name as the field name in the db object
 void ControllerRequest.validateDBObject(DBObject oneObject, ErrorCollection ec)
          Convenience method that retrieves parameters/field values and populates a specified db object.
 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.
 void ControllerResponse.addAutoInput(String fieldName, DBObject dbobj, String defaultValue)
          addAutoInput is a convenience method that creates a new Input object based on the specified field parameters and adds the input object to this controller object.
 void ControllerResponse.addAutoInput(DBObject myDBObj)
          Convenience method to add an input for every non-secret field in a db object to the current response, using the default values and valid values provided by the db object itself
 void ControllerResponse.addAutoInputRenameField(String fieldName, String renameFieldTo, DBObject dbobj, String defaultValue)
          addAutoInputRenameField is a convenience method that creates a new Input object based on the specified field parameters and adds the input object to this controller object.
 

Uses of DBObject in com.jcorporate.expresso.core.dataobjects.jdbc
 

Methods in com.jcorporate.expresso.core.dataobjects.jdbc with parameters of type DBObject
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  void JDBCExecutor.buildStoreProcedureCallableStatement(DBObject criteria, CallableStatement myCallableStatement)
          Build and return a FastStringBuffer ring consisting of an SQL 'where' clause using the current field values as criteria for the search.
 

Uses of DBObject in com.jcorporate.expresso.core.db
 

Methods in com.jcorporate.expresso.core.db with parameters of type DBObject
 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.
protected  void TableCreator.createIndices(DBObject dbObj, DBConnection providedConn, boolean shouldComplain)
          create indices, using provided connection if any, and complaining upon failure if specified
 

Uses of DBObject in com.jcorporate.expresso.core.dbobj
 

Subclasses of DBObject in com.jcorporate.expresso.core.dbobj
 class AuditedSecuredDBObject
          AuditedSecuredDBObject is an extension of SecuredDBObject that always writes an audit entry to the AuditLog table.
 class AutoDBObject
          This class provides convenience methods by querying the database table it is set to and automatically setting up it's own fields that way.
 class DBSequence
          DBSequence is a special DBObject that wraps a database sequence.
 class HistAuditSecuredDBObject
          HistAuditSecuredDBObject is an object that is audited (as in the AuditedSecuredDBObject) and is also archived in a history table that stores the entire record on either ADD or UPDATE.
 class RowSecuredDBObject
          subclass this for support of row-level Authorization.
 class SecuredDBObject
          A database object can be stored in a table (or tables), can be retrieved, and various other operations Specific database objects extend this object
 

Methods in com.jcorporate.expresso.core.dbobj that return DBObject
 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.

 DBObject MultiDBObject.assembleObject(String shortName)
          Deprecated. v. 5.5+; 9/04; use getDBObject() instead
abstract  DBObject DBSequence.getThisDBObj()
          NOTE: Subclass must override.
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.

static DBObject DBObject.getThisDBbj(DataTransferObject dto)
          Constructor method that takes a DataTransferObject and builds a full fledged DBObject out of it.
 DBObject AutoDBObject.getThisDBObj()
          getThisDBObj method comment.
 

Methods in com.jcorporate.expresso.core.dbobj with parameters of type DBObject
 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
 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
 void MultiDBObject.addDBObj(DBObject oneDBObj, String shortName)
           
 String MultiDBObject.selectFieldString(DBObject oneObj, String fieldName)
          Build an appropriate String for use in the select part of an SQL statement
 boolean Schema.contains(DBObject dbObject)
          Checks if a particular dbobject resides in a given schema.
protected  void RowSecuredDBObject.checkDeleteDetailPerm(DBObject obj)
          check delete privilege for all detail records; different than superclass because we must set uid
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.
protected  void DBObject.checkDeleteDetailPerm(DBObject obj)
          extracted for subclasses checking
protected  void DBObject.copyAttributes(DBObject returnObj)
          called by newInstance(), this method should make sure that the newly created object is properly initialized
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 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.
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.
abstract  void NextNumber.reset(String db, DBObject callingObject)
          Clears the table on a particular dbobject.
protected  String NextNumber.getKey(DBObject callingDBObject, String fieldName)
          Builds the key string for lookup within the dbobject hashmap.
 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.
 void NextNumberImpl.reset(String db, DBObject callingObject)
          Clears the table on a particular dbobject.
 

Uses of DBObject in com.jcorporate.expresso.ext.dbobj
 

Subclasses of DBObject in com.jcorporate.expresso.ext.dbobj
 class AppIntegration
          AppIntegration Provide a point of integration between different Expresso-based applications.
 class AuditLog
          The AuditLog is a table that is written to by AuditedSecuredDBObjects and HistAuditSecuredDBObjects.
 class AuditLogL
          The AuditLogL object provides lookup values for the AuditLog table.
 class DownloadFiles
          This DBobject is used by the Download Controller to manage information about files available for download, security groups allowed to download which files, Download notes, and Mime Types settings.
 class DownloadLog
          DownloadLog Log the latest download of a file by a user
 class ISOCountryCodes
          This database table contains a list of all known ISO 3166-1 country codes.
 class PerfTests
          PerfTests List of URL's to execute and time, along with statistics on their execution time.
 class PerfTestSet
          PerfTestSet entries define "groups" of performance test entries.
 class PerfTestSetDet
          PerfTestSetDet entries define "groups" of performance test entries.
 class PerfTestStat
          PerfTestStat entries record the run time for each run of a test, for trend analysis
 class RegisteredUser
          Extention to the normal user object to record some additional information
 class RestrictedCountries
          Table for countries that are not permitted access to 'restricted' downloads Usually this pertains to Cryptographic source code that cannot be downloaded from the U.S. to Cuba for example.
 class RestrictedOverrides
          This class allows administrators to override selected registered users to grant or deny restricted download access.
 class ReverseLookupDomains
          Class that maintains a database of all known top level domain codes.
 class SingleDBUserInfo
          Deprecated. 10/4/2004 functionality can be handled by DefaultUserInfo with DBOTHERMAP method to map a table to a context
 

Methods in com.jcorporate.expresso.ext.dbobj that return DBObject
 DBObject ReverseLookupDomains.getThisDBObj()
           
 DBObject RestrictedCountries.getThisDBObj()
           
 DBObject RestrictedOverrides.getThisDBObj()
           
 DBObject AuditLog.getThisDBObj()
          Standard method to create a new copy of this particular database object
 DBObject AuditLogL.getThisDBObj()
          Standard method to create a new copy of this particular database object
 

Uses of DBObject in com.jcorporate.expresso.ext.dbobj.regobj
 

Subclasses of DBObject in com.jcorporate.expresso.ext.dbobj.regobj
 class Address
          Creation date: 2001-08-24 11:57:54
 class Contact
          Creation date: 2001-08-24 11:57:54
 class Person
          Creation date: 2001-08-24 11:57:54
 class Phone
          Creation date: 2001-08-24 11:57:54
 

Uses of DBObject in com.jcorporate.expresso.ext.xml.dbobj
 

Subclasses of DBObject in com.jcorporate.expresso.ext.xml.dbobj
 class ControllerXSLMap
          Entries here define the mapping between a specific user and browser type and Controller combination to the correct XSL stlyesheet to be used to transform the outputs of this controller.
 class UserAgent
          Entries here define the other VM's (even on other servers) that are also using this database, and with whom cache synchronizations should be attempted.
 

Methods in com.jcorporate.expresso.ext.xml.dbobj that return DBObject
 DBObject UserAgent.getThisDBObj()
          Standard method to return a new UserAgent object
 DBObject ControllerXSLMap.getThisDBObj()
          Standard method to return a new CacheSync object
 

Uses of DBObject in com.jcorporate.expresso.services.controller.dbmaint
 

Methods in com.jcorporate.expresso.services.controller.dbmaint that return DBObject
protected  DBObject DynamicCmd.getCurrentDBObj()
          Deprecated. Since Expresso 5.1 Use getDataObject() for compatibility with AutoDBObject, JoinedDataObject, etc. Will be removed in Expresso 5.2
 

Methods in com.jcorporate.expresso.services.controller.dbmaint with parameters of type DBObject
static Vector Lookup.getLookupValues(DBObject myDBObj, String fieldName, HTTPPersistentSession mySession)
          Performs the lookup.
 

Uses of DBObject in com.jcorporate.expresso.services.dbobj
 

Subclasses of DBObject in com.jcorporate.expresso.services.dbobj
 class CacheSync
          Entries here define the other VM's (even on other servers) that are also using this database, and with whom cache synchronizations should be attempted.
 class ChangeLog
           
 class ControllerDefault
          This class defines default limits on controllers.
 class ControllerSecurity
          Controller Security indicates which of the controllers contained in a schema can be accessed by which groups of users.
 class DBMessage
          A DBMessage is a string that is intercepted coming from the DBMS as an error or warning message.
 class DBObjImpl
          Deprecated. since Expresso 5.3 [never used]
 class DBObjLimit
          A DBObjLimit defines the number of records the standard maintenance servlet will display before it breaks a page.
 class DBObjSecurity
          

Database Object Security: What is this user allowed to do with a given database object

 class DBOtherMap
          DBOtherMap Tells about database objects that reside in Other Databases - e.g. somewhere other than the control database where this table is found.
 class DefaultUserInfo
          Default implementation of the UserInfo object.
 class Event
          Event
 class EventMail
          EventMail objects tell who is to be notified when an event is triggered
 class GroupMembers
          Group Member definitions table.
 class GroupNest
          Group Nesting
 class JobHandlerControl
          applies operations (commands) to all jobs running on a server.
 class JobHandlerRegistry
          keep list of job handlers
 class JobQueue
          Copyright 1999, 2000, 2001 Jcorporate Ltd.
 class JobQueueParam
          A JobQueueParam entry provides information to the job that is being queued that tell it how to run & what data to operate on.
 class JobSecurity
          JobSecurity.java Copyright 1999-2002 Jcorporate Ltd.
 class LogEntry
          LogEntry Log system events, errors, etc
 class MediaDBObject
          A MediaDBObject is a DBObject intended to be used for storage of media objects directly in the database.
 class MimeTypes
          This table provides for mapping between files and mime types.
 class RegistrationDBObject
          Whenever you create a DBObject to be used for Registration, you need to derive it from this class.
 class RegistrationDomain
          A registration domain defines a registration context.
 class RegistrationObjectMap
          This class associates each registration domain with one or more registration objects.
 class RowGroupPerms
          storage for read/write permissions for a group, concerning a given row in the database this object and its table are a complement to the RowPermissions object and table.
 class RowPermissions
          storage for read/write permissions concerning a given row in the database this table stores user & "other" permissions

this object and its table should be manipulated only through RowSecuredDBObject

 class SchemaList
          Schema list The schema list object lists the individual Schema classes for each application installed at this site.
 class SecurityDBObject
          

SecurityDBObject.java this object provides a means to control the DB context via Setup values.

 class Setup
          Copyright 1999, 2000, 2001 Jcorporate Ltd.
 class TmpUser
           
 class UserGroup
          UserGroup is a grouping of a number of users for security purposes.
 class UserPreference
          A User Preference is a stored value or attribute that is related to a particular user.
 class UserPreferenceDef
          This object defines the available user preference definitions.
 class UserPreferenceVal
          This object defines the available valid values for user preference definitions.
 class ValidationQueue
          This class stores each validation entry
 class ValidationQueueParam
          This class stores all the parameters associated with each validation entry
 


Expresso 5-6

Please see www.jcorporate.com for information about new Expresso releases.