org.molgenis.generators

Class Generator

java.lang.Object

org.molgenis.generators.Generator

Direct Known Subclasses:

DatabaseConfigGen, DotDocGen, DotDocMinimalGen, DotDocModuleDependencyGen, EntitiesImporterGen, EntitiesValidatorGen, EntityModelDocGen, FileFormatDocGen, ForEachEntityGenerator, ForEachMatrixGenerator, JDBCMetaDatabaseGen, JpaDatabaseGen, JpaRepositorySourceGen, ObjectModelDocGen, PersistenceGen, TableDocGen, TextUmlGen

public abstract class Generator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	APP_DIR

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Methods

Modifier and Type	Method and Description
freemarker.template.Template	createTemplate(String path) Create a template for the generators to use.
Map<String,Object>	createTemplateArguments(MolgenisOptions options) Create default template arguments such as date, version etc.
abstract void	generate(Model model, MolgenisOptions options)
void	generate(Model model, MolgenisOptions options, String generatedPath)
abstract String	getDescription()
String	getDocumentationPath(MolgenisOptions options) Generate the path for the generated documentation code.
String	getExtension() Extension varies based on output type, i.e., .java, R, sql etc.
String	getHandWrittenPath(MolgenisOptions options)
String	getProjectPath(MolgenisOptions options) Path for the whole project
String	getSourcePath(MolgenisOptions options) Generate the path for the generated source code.
String	getWebserverPath(MolgenisOptions options) Path for the web sites

Methods inherited from class java.lang.Object

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

Field Detail

APP_DIR

protected final String APP_DIR

See Also:

Constant Field Values

Constructor Detail

Generator

public Generator()

Method Detail

generate

public abstract void generate(Model model,
            MolgenisOptions options)
                       throws Exception

Throws:

Exception

generate

public void generate(Model model,
            MolgenisOptions options,
            String generatedPath)
              throws Exception

Throws:

Exception

createTemplate

public freemarker.template.Template createTemplate(String path)
                                            throws Exception

Create a template for the generators to use.

Parameters:

path -

Throws:

Exception

createTemplateArguments

public Map<String,Object> createTemplateArguments(MolgenisOptions options)

Create default template arguments such as date, version etc.

getProjectPath

public String getProjectPath(MolgenisOptions options)

Path for the whole project

getWebserverPath

public String getWebserverPath(MolgenisOptions options)

Path for the web sites

getSourcePath

public String getSourcePath(MolgenisOptions options)

Generate the path for the generated source code. Depends on wether the result is a war or a jar file.

Parameters:

options -

Returns:

path string

getHandWrittenPath

public String getHandWrittenPath(MolgenisOptions options)

getDocumentationPath

public String getDocumentationPath(MolgenisOptions options)

Generate the path for the generated documentation code.

Parameters:

options -

Returns:

path string

getExtension

public String getExtension()

Extension varies based on output type, i.e., .java, R, sql etc. Should include the leading "."

getDescription

public abstract String getDescription()