com.jcorporate.expresso.core
Class ExpressoSchema

java.lang.Object
  com.jcorporate.expresso.kernel.ComponentBase
      com.jcorporate.expresso.kernel.ContainerComponentBase
          com.jcorporate.expresso.core.dbobj.Schema
              com.jcorporate.expresso.core.ExpressoSchema

All Implemented Interfaces:

ComponentLifecycle, Containable, Describable, ExpressoComponent, com.jcorporate.expresso.services.controller.RegistrationFactory, Serializable

public final class ExpressoSchema

extends Schema

Standard Schema object for the Expresso framework. It provides 'tie ins' for all the classes within the framework. You use your own Schema derived from com.jcorporate.expresso.core.dbobj.Schema when creating your own application

Since:

Expresso 1.0

Author:

Michael Nash

See Also:

Serialized Form

Constructor Summary

ExpressoSchema()
Constructor

Method Summary

protected void	constructControllers() Adds the appropriate controllers to the schema
protected void	constructDBObjects() Adds all the Expresso DbObjects
protected void	constructSetupValues() Adds the setup values for this schema to the schema's definition
String	getDefaultComponentCode() Returns the default component code for this schema.
String	getDefaultDescription() Returns the default description for this schema.
String	getMessageBundlePath() Returns the path to the messages bundle property file
String	getVersion() Gets the current version of this Framework
void	otherSetup(InstallLog installLog, String dataContext) Runs additional setup operations for the Expresso Schema

Methods inherited from class com.jcorporate.expresso.core.dbobj.Schema

add, add, addController, addController, addController, addController, addDBObject, addDBObject, addDBObject, addDBObject, addDBObject, addJob, addReportPage, addReportPage, addServlet, addSetup, addSetup, configure, contains, destroy, getConfig, getControllerList, getDataContext, getDBName, getDBObjMap, getInstance, getJobs, getLoginController, getMembers, getMetadataLocation, getRegistrationController, getReports, getRequestingUser, getServlets, getSetupDefault, getSetupValue, getStartController, getString, getTests, initialize, instantiate, otherSetup, populateSchemaData, reconfigure, requiresVersion, setDataContext, setDBName, setRequestingUser, setSetupValue, setupDefaultValues, setupDefaultValuesWithException

Methods inherited from class com.jcorporate.expresso.kernel.ContainerComponentBase

getContainerImplementation, locateComponent, setContainerImplementation

Methods inherited from class com.jcorporate.expresso.kernel.ComponentBase

getMetaData, getParent, setMetaData, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jcorporate.expresso.kernel.ExpressoComponent

getMetaData, getParent, setParent

Constructor Detail

ExpressoSchema

public ExpressoSchema()
               throws DBException

Constructor

Throws:

DBException - if there's an error building the object

Method Detail

getDefaultComponentCode

public String getDefaultComponentCode()

Returns the default component code for this schema. Useful for automated component testing/installation

Overrides:

getDefaultComponentCode in class Schema

Returns:

the component code string. In this case there is no component code so it returns an empty string.

getDefaultDescription

public String getDefaultDescription()

Returns the default description for this schema. Useful for automated component testing/installation

Overrides:

getDefaultDescription in class Schema

Returns:

the name of the schema

getMessageBundlePath

public String getMessageBundlePath()

Returns the path to the messages bundle property file

Overrides:

getMessageBundlePath in class Schema

Returns:

the path to the messages bundle

getVersion

public String getVersion()

Gets the current version of this Framework

Overrides:

getVersion in class Schema

Returns:

the current version in string format

otherSetup

public void otherSetup(InstallLog installLog,
                       String dataContext)
                throws DBException

Runs additional setup operations for the Expresso Schema

Overrides:

otherSetup in class Schema

Parameters:

installLog - The 'logger' to send informational output to.

dataContext - the datacontext to work with.

Throws:

DBException - upon database access error

constructControllers

protected void constructControllers()

Adds the appropriate controllers to the schema

constructDBObjects

protected void constructDBObjects()

Adds all the Expresso DbObjects

constructSetupValues

protected void constructSetupValues()
                             throws DBException

Adds the setup values for this schema to the schema's definition

Throws:

DBException - upon database access error