de.ipcon.db

Class BOEnvironmentBuilder

java.lang.Object

de.ipcon.db.BOEnvironmentBuilder

public class BOEnvironmentBuilder
extends java.lang.Object

This class handles importing/creating of initial data for the various BO classes of projects in(to) the project's database. The DBMan creates an instance of this class and will call the build() method.

Data may either be created by hardcoded initEnvironment() methods in the BO class itself and/or via external scripts in the "<prjdir>/bo/resources" directory of the project.

First initEnvironment() methods are searched in the following order; The first one found will be called:

1. initEnvironment(Transaction tx, boolean isAuthoritativeServer)
2. initEnvironment(Transaction tx, DBManLocalI dbman)
3. initEnvironment(Transaction tx)

Only on the authoritative server after that the resources directory will be searched for import files named <EntityName>.initialdata.xml and the included scripts will be called and import the included data. When the module system is used a file InitialdataIndex has been created instead and will list all the *.initialdata.xml that are to be used.

1. For every Entity in the Schema or every *.initialdata.xml listed in the InitialdataIndex, build() will call getInitialdataImportScript, ...).
2. It will create and set up the "script part" for each of the initialdata files and return it.
4. Then the "script part" of the *.initialdata.xml files will be executed. The actual "script part" in the *.initialdata.xml normally consists only of a call to "start()" (which is defined "globally" in script-commons.xml which can be provided by the project, otherwise a default script is used). If the script element is not given a default (consisting only of "start()") will be used.
5. The (standard) script-commons start() currently creates a CVSImporter with a CVSConfiguration using the XML configuration data provided in the .initialdata.xml.
6. The CVSImporter calls its eachRecord() method with the closure defined in the script-commons for every "data" line/record in the *.initialdata.xml. A CVSDataSet is created for/from every line and provides various pre-filled variables ("mapping" for example) to the closure.
7. The (standard) closure then tries to find out if an object matching the current line/record already exists in the DB and respectively creates or updates it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BOEnvironmentBuilder.Column
static class	BOEnvironmentBuilder.Data
static class	BOEnvironmentBuilder.Script

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
static java.lang.String	TXPROPERTY_NODENUMBER

Constructor Summary

Constructors

Constructor and Description
BOEnvironmentBuilder()

Method Summary

Modifier and Type	Method and Description
void	build(DBManLocalI dbman, java.util.Map<java.lang.String,java.lang.Object> varsForTx) Loads all defined entities.
static void	buildForTesting(TestTransaction tx, java.util.List classesDataIsWantedFor)
static void	buildForTesting(TestTransaction tx, java.util.List classesDataIsWantedFor, java.lang.Long nodeNumber)
java.lang.String	getCommons_beanshell()
java.lang.String	getCommons_groovy()
BOEnvironmentBuilder.Data	getData()
BOEnvironmentBuilder.Script	getScript()
void	handleBeanshellE(electric.xml.Element el)
void	handleDataE(electric.xml.Element el)
void	handleGroovyE(electric.xml.Element el)
void	handleScriptE(electric.xml.Element el)
void	initScriptCommons(SchemaI schema)
void	setCommons_beanshell(java.lang.String $69)
void	setCommons_groovy(java.lang.String $68)
void	setData(BOEnvironmentBuilder.Data $67)
void	setScript(BOEnvironmentBuilder.Script $66)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

TXPROPERTY_NODENUMBER

public static final java.lang.String TXPROPERTY_NODENUMBER

See Also:

Constant Field Values

Constructor Detail

BOEnvironmentBuilder

public BOEnvironmentBuilder()

Method Detail

handleGroovyE

public void handleGroovyE(electric.xml.Element el)

handleBeanshellE

public void handleBeanshellE(electric.xml.Element el)

handleScriptE

public void handleScriptE(electric.xml.Element el)

handleDataE

public void handleDataE(electric.xml.Element el)

buildForTesting

public static void buildForTesting(TestTransaction tx,
                                   java.util.List classesDataIsWantedFor)

Parameters:

classesDataIsWantedFor - a list of the classes for which data should be imported. Entries may be any mix of classnames as Strings or Classes themselves

buildForTesting

public static void buildForTesting(TestTransaction tx,
                                   java.util.List classesDataIsWantedFor,
                                   java.lang.Long nodeNumber)

build

public void build(DBManLocalI dbman,
                  java.util.Map<java.lang.String,java.lang.Object> varsForTx)

Loads all defined entities. If running on the authoritative server, then the initialdata.xml files are loaded and for each an importscript is created. After all scripts have been created and initialized, they are executed (maybe several times) until all initialdata is loaded into a transaction. This handling will create and initialize the script to execute first for all entities and execute them afterwards. Afterwards (or for non authoritative servers directly), the initEnvironment methods are called on each of the entity classees. The transaction used for initialization is saved at the end.

Parameters:

dbman - the DBMan instance that needs its data initialized.

tx - the Transaction that should be used.

initScriptCommons

public void initScriptCommons(SchemaI schema)

getScript

public BOEnvironmentBuilder.Script getScript()

setScript

public void setScript(BOEnvironmentBuilder.Script $66)

getData

public BOEnvironmentBuilder.Data getData()

setData

public void setData(BOEnvironmentBuilder.Data $67)

getCommons_groovy

public java.lang.String getCommons_groovy()

setCommons_groovy

public void setCommons_groovy(java.lang.String $68)

getCommons_beanshell

public java.lang.String getCommons_beanshell()

setCommons_beanshell

public void setCommons_beanshell(java.lang.String $69)