Expresso 5-6

Uses of Interface
com.jcorporate.expresso.core.dataobjects.DataObject

Packages that use DataObject
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.dbobj Ancestor objects for all Database Objects and Schemas.  
com.jcorporate.expresso.core.misc Miscellaneous objects for file manipulation, running OS processes, etc 
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.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 
 

Uses of DataObject in com.jcorporate.expresso.core.dataobjects
 

Classes in com.jcorporate.expresso.core.dataobjects that implement DataObject
 class BaseDataObject
          A base class that provides some functionality for all Data Objects
 class SynchronizedDataObject
          This class provides a threadsafe access to a dataobject.
 

Fields in com.jcorporate.expresso.core.dataobjects declared as DataObject
protected  DataObject DefaultDataField.owner
          A link to the DataObject that contains me.
 

Methods in com.jcorporate.expresso.core.dataobjects that return DataObject
 DataObject NestableDataObject.getNestedFromFieldName(String fieldName)
          Retrieves a nested dataobject based upon the public field name that the DataObject publishes.
 DataObject[] NestableDataObject.getAllNested()
          Retrieve an array of all nested data objects.
 DataObject DataField.getOwner()
          Returns a handle to the DataObject that is the container for this Data Field
static DataObject SynchronizedDataObject.newInstance(DataObject wrappedObject)
          Call this to wrap your data object in a threadsafe wrapper.
static DataObject DataObjectFactory.createDataObject(Class clazz, String dataContext, int uid)
          Typesafe way of creating a data object that doesn't implement Defineable
static DataObject DataObjectFactory.createDataObject(Class clazz, String dataContext, String definition, int uid)
          Typesafe way of creating a dataobject
 DataObject DefaultDataField.getOwner()
          Returns a handle to the DataObject that is the container for this Data Field
 

Methods in com.jcorporate.expresso.core.dataobjects with parameters of type DataObject
 void DataField.setOwner(DataObject newOwner)
          Sets the owner of a given DataObject
 void DataExecutorInterface.add(DataObject valueObject)
          Takes a DataObject and adds it to the underlying data source
 void DataExecutorInterface.delete(DataObject valueObject)
          Takes a DataObject and deletes it from the underlying data source
 void DataExecutorInterface.update(DataObject valueObject, boolean updateChangedFieldsOnly)
          Takes a DataObject and updates it to the underlying data source
 boolean DataExecutorInterface.retrieve(DataObject valueObject)
          Takes a DataObject and retrieves it from the underlying data source
 void DataExecutorInterface.updateAll(DataObject valueObject, boolean updateChangedCache)
          Takes a DataObject and updates it to the underlying data source
 void DataExecutorInterface.deleteAll(DataObject valueObject, boolean deleteChangedCache)
          Takes a DataObject and deletes it from the underlying data source
 void DataExecutorInterface.runStoreProcedure(DataObject valueObject)
          Takes a DataObject and run it from the underlying data source
static DataObject SynchronizedDataObject.newInstance(DataObject wrappedObject)
          Call this to wrap your data object in a threadsafe wrapper.
 List DataQueryInterface.searchAndRetrieve(DataObject criteria, String sortOrder)
          Performs a datasource search so that the criteria set in the DataObject is used.
 List DataQueryInterface.searchAndRetrieve(DataObject criteria)
          Performs a datasource search so that the criteria set in the DataObject is used.
 boolean DataQueryInterface.find(DataObject criteria)
          Finds a single record based upon the criteria specified by the DataObject
static DefaultDataField DefaultDataField.getInstance(DataFieldMetaData metaData, DataObject parentObject)
          create new object for this field
 void DefaultDataField.setOwner(DataObject newOwner)
          Sets the owner of a given DataObject
 

Constructors in com.jcorporate.expresso.core.dataobjects with parameters of type DataObject
DefaultDataField(DataFieldMetaData metaData, DataObject parentObject)
          Creates a new DefaultDataField object.
 

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

Classes in com.jcorporate.expresso.core.dataobjects.jdbc that implement DataObject
 class JDBCDataObject
          Base class for JDBC-based data objects.
 class JoinedDataObject
          DataObject for use with 1:1 joins between database objects.
 

Methods in com.jcorporate.expresso.core.dataobjects.jdbc that return DataObject
 DataObject JoinedDataField.getOwner()
           
 DataObject JoinedDataObject.getNestedFromFieldName(String fieldName)
          Retrieves a nested dataobject based upon the public field name that the DataObject publishes.
 DataObject[] JoinedDataObject.getAllNested()
          Retrieve an array of all nested data objects.
 

Methods in com.jcorporate.expresso.core.dataobjects.jdbc with parameters of type DataObject
 String JDBCUtil.formatDateTime(DataObject theObject, String fieldName)
          Given the value of a date/time or date/time field, return the value formatted as appropriate for the current DBMS.
 String JDBCUtil.formatDateTime(DataObject theObject, String fieldName, boolean surroundWithQuotes)
          Given the value of a date/time or datetime field, return the value formatted as appropriate for the current DBMS.
 Date JDBCUtil.getDateField(DataObject theObject, String fieldName)
          Helper function that helps convert any string values from the database's format
protected  com.jcorporate.expresso.core.dataobjects.jdbc.JDBCUtil.DateReturnFormat JDBCUtil.formatDateTimeInternal(DataObject theObject, String fieldName)
          This class combines the old getFieldDate() with quoteIfNeeded() to format the Date-Time fields appropriately for storage.
 String JDBCUtil.makeLimitationStub(DBConnection theConnection, DataObject theObj)
          Creates the limitation syntax optimisation stub to embed inside the SQL command that performs search and retrieve.
 void JDBCExecutor.add(DataObject valueObject)
          Takes a DataObject and adds it to the underlying data source
 void JDBCExecutor.delete(DataObject valueObject)
          Takes a DataObject and deletes it from the underlying data source.
 void JDBCExecutor.update(DataObject valueObject, boolean updateChangedFieldsOnly)
          Takes a DataObject and updates it to the underlying data source
 boolean JDBCExecutor.retrieve(DataObject valueObject)
          Retrieves the object with keys specified by the valueObject parameter.
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.
 void JDBCExecutor.updateAll(DataObject valueObject, boolean updateChangedCache)
          Takes a DataObject and updates all to the underlying data source
 void JDBCExecutor.deleteAll(DataObject valueObject, boolean deleteChangedCache)
          Takes a DataObject and deletes it from the underlying data source.
protected  String JDBCExecutor.buildPreparedStoreProcedureSQL(DataObject oneObjectType)
          Helper Function to build a prepared statement's SQL for running STore Procedure statement.
 void JDBCExecutor.runStoreProcedure(DataObject valueObject)
          Run a store procedure identify by the object with keys specified by the valueObject parameter.
 List JDBCQuery.searchAndRetrieve(DataObject criteria, String sortOrder)
           
 List JDBCQuery.searchAndRetrieve(DataObject criteria)
           
 boolean JDBCQuery.find(DataObject criteria)
           
static JoinedDataField JoinedDataField.getInstance(JoinedDataObject owner, DataObject localObj, String localField, DataObject remoteObj, String foreignField)
          Construct a new JoinedDataField object
 void JoinedDataField.setOwner(DataObject newOwner)
           
 

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

Classes in com.jcorporate.expresso.core.dbobj that implement DataObject
 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 DBObject
          DBObjects are the core of Expresso's object-relational mapping.
 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
 

Uses of DataObject in com.jcorporate.expresso.core.misc
 

Methods in com.jcorporate.expresso.core.misc with parameters of type DataObject
 ArrayList RecordPaginator.searchAndRetrieve(DataObject 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.
 

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

Classes in com.jcorporate.expresso.ext.dbobj that implement DataObject
 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
 

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

Classes in com.jcorporate.expresso.ext.dbobj.regobj that implement DataObject
 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 DataObject in com.jcorporate.expresso.ext.xml.dbobj
 

Classes in com.jcorporate.expresso.ext.xml.dbobj that implement DataObject
 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 DataObject
 DataObject XMLDBObject.getDBObject()
           
 DataObject XMLImportDocument.getDBObject()
           
 

Methods in com.jcorporate.expresso.ext.xml.dbobj with parameters of type DataObject
 void XMLDBObject.setDBObject(DataObject newDBObject)
           
 

Constructors in com.jcorporate.expresso.ext.xml.dbobj with parameters of type DataObject
XMLDBObject(DataObject newDBObject)
          Default constructor
XMLImportDocument(DataObject newDBObject)
          XMLImportDocument constructor.
 

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

Methods in com.jcorporate.expresso.services.controller.dbmaint that return DataObject
protected  DataObject DynamicCmd.getDataObject()
          Retrieve the data object
protected  DataObject DynamicCmd.retrieveMyDBObject()
          Retrieves the DBObject as specified in the criteria key fields passed to the DBMaint controller.
protected  DataObject DynamicCmd.getMyDataObject()
          Retrieves an instance of my dataobject instance.
 

Methods in com.jcorporate.expresso.services.controller.dbmaint with parameters of type DataObject
protected  void UpdateBase.saveBlobFields(DataObject myDBObj)
          Saves updated BLOB fields to the database table if there are any.
protected  void DynamicCmd.setFields(DataObject myDBObj, String fieldPairs)
          Sets the fields in the production environment.
protected  void DynamicCmd.showEditLink(String fieldName, String oneFieldValue, DataObject currentRecord, Output myElement)
          Show the edit link as often used by the List state or updateupdate state.
protected  void DynamicCmd.showBlobViewLink(String fieldName, DataObject dbobj, Input myElement, String controller)
          Create a link that is nested to myElement that is for displaying a BLOB field.
protected  void DynamicCmd.showEditLink(String fieldName, String oneFieldValue, DataObject currentRecord, Output myElement, String controller)
          Write a hyperlink command that allows edit of the current key
protected  String DynamicCmd.getKeyParameter(DataObject srcDBObj)
          Create a key parameter for locating the DBObject.
protected  void DynamicCmd.setMyDataObject(DataObject myDBObj)
          Set the 'myDBObj' variable which is, in turn, used by the rest of the DBMaint controller.
 

Uses of DataObject in com.jcorporate.expresso.services.controller.ui
 

Methods in com.jcorporate.expresso.services.controller.ui that return DataObject
 DataObject AutoControllerElement.parseBlock(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form.
 DataObject AutoControllerElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form, and unlike the ParseBlock, there is no DBOBject name prefix attached to the parameter names.
 DataObject AutoControllerElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec, boolean validate)
           
 DataObject[] AutoControllerElement.parseBlocks(ControllerRequest request, DataObject[] theObjects, ErrorCollection ec)
          Parses the appropriate DBObject from the block.
 DataObject DefaultAutoElement.parseBlock(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form.
 DataObject[] DefaultAutoElement.parseBlocks(ControllerRequest request, DataObject[] theObjects, ErrorCollection ec)
          Parses the appropriate DBObject from the block.
 DataObject DefaultAutoElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec, boolean validate)
          Parses a dbobject
 DataObject DefaultAutoElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form, and unlike the ParseBlock, there is no DBOBject name prefix attached to the parameter names.
 

Methods in com.jcorporate.expresso.services.controller.ui with parameters of type DataObject
 Input AutoControllerElement.renderDBObjectField(ControllerResponse response, DataObject dbobj, String fieldName, String defaultValue, boolean readOnly)
          Renders an Input in a update method per field name.
 Block AutoControllerElement.createDBObjectBlock(ControllerRequest request, ControllerResponse response, DataObject dbobj)
          Creates a DBObject Block that contains all the non-secret fields for the DBObject.
 Block AutoControllerElement.createDBObjectBlock(ControllerRequest request, ControllerResponse response, String title, DataObject dbobj)
          Creates a DBObject Block that contains all the non-secret fields for the DBObject.
 DataObject AutoControllerElement.parseBlock(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form.
 DataObject AutoControllerElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form, and unlike the ParseBlock, there is no DBOBject name prefix attached to the parameter names.
 DataObject AutoControllerElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec, boolean validate)
           
 DataObject[] AutoControllerElement.parseBlocks(ControllerRequest request, DataObject[] theObjects, ErrorCollection ec)
          Parses the appropriate DBObject from the block.
 String AutoControllerElement.parseSingleInput(ControllerRequest request, DataObject dbobj, String fieldName, String parameterName, ErrorCollection ec)
          Takes the Controller Request and appropriately parses a string for a particular field.
 Block DefaultAutoElement.createDBObjectBlock(ControllerRequest request, ControllerResponse response, DataObject dbobj)
          Creates a DBObject Block that contains all the non-secret fields for the DBObject.
 Block DefaultAutoElement.createDBObjectBlock(ControllerRequest request, ControllerResponse response, String title, DataObject dbobj)
          Creates a DBObject Block that contains all the non-secret fields for the DBObject.
 DataObject DefaultAutoElement.parseBlock(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form.
 DataObject[] DefaultAutoElement.parseBlocks(ControllerRequest request, DataObject[] theObjects, ErrorCollection ec)
          Parses the appropriate DBObject from the block.
 DataObject DefaultAutoElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec, boolean validate)
          Parses a dbobject
 DataObject DefaultAutoElement.parseDBObject(ControllerRequest request, DataObject oneObject, ErrorCollection ec)
          Convienence method if you only expect one DBObject to be returned from a particular form, and unlike the ParseBlock, there is no DBOBject name prefix attached to the parameter names.
 String DefaultAutoElement.parseSingleInput(ControllerRequest request, DataObject dbobj, String fieldName, String parameterName, ErrorCollection ec)
          Takes the Controller Request and appropriately parses a string for a particular field.
 Input DefaultAutoElement.renderDBObjectField(ControllerResponse response, DataObject dbobj, String fieldName, String cachedValue, boolean readOnly)
          Renders a DBOBject Field as either an Input or an Output.
protected  Input DefaultAutoElement.renderReadOnlyInput(ControllerResponse response, Input oneField, DataObject dbobj, String fieldName, String oneFieldValue)
          Modifies an already instantiated Input to be a finished read only control.
protected  void DefaultAutoElement.renderReadWriteBlob(ControllerResponse response, Input oneField, DataObject dbobj, String fieldName, String oneFieldValue, String oneFieldSize)
          Modifies an already instantiated Input to be a finished Input control specifically for a blob field.
protected  Input DefaultAutoElement.renderReadWriteInput(ControllerResponse response, Input oneField, DataObject dbobj, String fieldName, String oneFieldValue, String oneFieldSize)
          Modifies an already instantiated Input to be a finished Input control
 

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

Classes in com.jcorporate.expresso.services.dbobj that implement DataObject
 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.