com.sri.emo
Class EmoSchema

java.lang.Object
  com.jcorporate.expresso.kernel.ComponentBase
      com.jcorporate.expresso.kernel.ContainerComponentBase
          com.jcorporate.expresso.core.dbobj.Schema
              com.sri.common.ComponentSchema
                  com.sri.emo.EmoSchema

All Implemented Interfaces:

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

public class EmoSchema
extends ComponentSchema

Register the Schemas for entire web application. This schema tells Expresso what database table objects need to be generated or check when the schema is read for the first time.

See Also:

Serialized Form

Field Summary

static String	EMO_GROUP
static String[]	REMOVED_REG_FIELDS
static String	TREEVIEW_NESTING_LIMIT name of setup value for how many levels deep a tree fetches by default

Constructor Summary

EmoSchema()
Default constructor.

Method Summary

protected void	addSetupValues(InstallLog theLog, String dbName) Add specific setup values.
String	getDefaultComponentCode() Returns the default component code for this schema.
String	getDefaultDescription() Returns the default description for this schema.
String	getMessageBundlePath() Return the path, relative to the classpath, of the MessageBundle file for this schema.
String	getVersion() Method to return the current version number of an application Schema.
WizardRepository	getWizardRepository(String dataContext) Return an instance of the WizardRepository to retrieve what you need.
org.picocontainer.PicoContainer	initializeApplicationContainer() Initialize the application container.
void	otherSetup(InstallLog theLog, String dbName) Perform any additional setup/intialize functions required by this schema.
protected void	setDefaultReadWriteGroups(String dbName)

Methods inherited from class com.sri.common.ComponentSchema

addAllSchemaElementsToContainer, getApplicationContainer, locate, setApplicationContainer

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

Field Detail

EMO_GROUP

public static final String EMO_GROUP

See Also:

Constant Field Values

REMOVED_REG_FIELDS

public static final String[] REMOVED_REG_FIELDS

TREEVIEW_NESTING_LIMIT

public static final String TREEVIEW_NESTING_LIMIT

name of setup value for how many levels deep a tree fetches by default

See Also:

Constant Field Values

Constructor Detail

EmoSchema

public EmoSchema()
          throws DBException

Default constructor. Adds references to all the dbobjects and controllers.

Throws:

DBException

Method Detail

getMessageBundlePath

public String getMessageBundlePath()

Return the path, relative to the classpath, of the MessageBundle file for this schema. This is where it's message files are stored.

Overrides:

getMessageBundlePath in class Schema

Returns:

java.lang.String

getDefaultDescription

public String getDefaultDescription()

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

Overrides:

getDefaultDescription in class Schema

Returns:

java.lang.String

getDefaultComponentCode

public String getDefaultComponentCode()

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

Overrides:

getDefaultComponentCode in class Schema

Returns:

java.lang.String

otherSetup

public void otherSetup(InstallLog theLog,
                       String dbName)
                throws DBException

Perform any additional setup/intialize functions required by this schema. This is where applications can set up default values for lookup tables, reference values, etc. Subclass does not extend this method if it is not needed.

Overrides:

otherSetup in class Schema

Parameters:

theLog - The installation log

dbName - The database context to execute this process against.

Throws:

DBException - If there's a database communication error

addSetupValues

protected void addSetupValues(InstallLog theLog,
                              String dbName)
                       throws DBException

Add specific setup values.

Parameters:

theLog - InstallLog the installation log.

dbName - String the database name.

Throws:

DBException - upon error.

setDefaultReadWriteGroups

protected void setDefaultReadWriteGroups(String dbName)
                                  throws DBException

Throws:

DBException

getWizardRepository

public WizardRepository getWizardRepository(String dataContext)

Return an instance of the WizardRepository to retrieve what you need.

Parameters:

dataContext - the data context to retrieve for.

Returns:

WizardRepository instance.

getVersion

public String getVersion()

Method to return the current version number of an application Schema.

Overrides:

getVersion in class Schema

Returns:

the Version you define for your system.

initializeApplicationContainer

public org.picocontainer.PicoContainer initializeApplicationContainer()

Initialize the application container.

Specified by:

initializeApplicationContainer in interface ComponentSPI

Overrides:

initializeApplicationContainer in class ComponentSchema

Returns:

PicoContainer