org.molgenis.generators

Class GeneratorHelper

java.lang.Object

org.molgenis.generators.GeneratorHelper

public class GeneratorHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
GeneratorHelper(MolgenisOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
static String	escapeXml(String nonXml)
static String	firstToLower(String string) Convert string with first character to lowercase.
static String	firstToUpper(String string) Convert string with first character to uppercase.
Vector<Field>	getAddFields(Entity e)
Vector<Field>	getAddFields(Entity e, boolean includeKey) Get the fields that participate in an insert (so excluding automatic fields).
Vector<Field>	getAllFields(Entity e)
Vector<Field>	getAllFields(Entity e, String type)
Vector<Unique>	getAllKeys(Entity e)
String	getCppJavaType(Field field) Get the cpp type for a field.
String	getCppType(Field field) Get the cpp type for a field.
Vector<Field>	getDbFields(Entity e, String type) The table fields of this entity
String	getDefault(Model model, Field field) Creates a default value based on the default values set in the model.
FieldType	getFieldType(Model model, Field field)
String	getHsqlType(Field field)
String	getImports(Model m, Entity e, String subpackage, String suffix)
String	getJavaAssignment(Field field, String value)
static String	getJavaName(String name) First character to upercase.
static String	getJavaName(String name, boolean doFirstToUpper)
Vector<Field>	getKeyFields(Entity e)
Vector<Field>	getKeyFields(List<Unique> keys) Return all secondary key fields.
Vector<Field>	getKeyFields(Unique u)
String	getMysqlType(Model model, Field field) Get the mysql type of a field: VARCHAR, INT, etc.
String	getOracleType(Model model, Field field)
Vector<Field>	getSecondaryKeyFields(Entity e)
Vector<Unique>	getSecondaryKeys(Entity e) Return all secondary keys for an entity
String	getSetType(Model model, Field field) Java setter type of the field, e.g.
List<Entity>	getSubclasses(Entity superclass, Model m)
List<Entity>	getSuperclasses(Entity subclass, Model m)
Vector<Unique>	getTableKeys(Entity e) A table can only contain the keys for columns that are actually in the table.
String	getType(Field field) Get the java type for a field.
String	getTypeFieldName()
Vector<Field>	getUpdateFields(Entity e)
Vector<Field>	getViewFields(Entity e, String type) The queryable fields of the entity (in case of inheritance from the view join)
Field	getXrefField(Model model, Field e)
String	getXsdType(Model model, Field field)
boolean	isPrimaryKey(Field f, Entity e)
String	parseQueryOperator(String label)
String	pluralOf(String string)
String	toCsv(List<String> elements) Convert a list of string to comma separated values.
static String	toLower(String string) Convert string to full lowercase
static String	toUpper(String string) Convert string to full uppercase

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratorHelper

public GeneratorHelper(MolgenisOptions options)

Method Detail

firstToUpper

public static String firstToUpper(String string)

Convert string with first character to uppercase.

Parameters:

string -

Returns:

string with first character in uppercase.

firstToLower

public static String firstToLower(String string)

Convert string with first character to lowercase.

Parameters:

string -

Returns:

string with first character in lowercase.

toUpper

public static String toUpper(String string)

Convert string to full uppercase

Parameters:

string -

Returns:

uppercase string

toLower

public static String toLower(String string)

Convert string to full lowercase

Parameters:

string -

Returns:

lowercase string

getType

public String getType(Field field)
               throws Exception

Get the java type for a field.

Returns:

the java type or UKNOWN

Throws:

Exception

getCppType

public String getCppType(Field field)
                  throws Exception

Get the cpp type for a field.

Returns:

the java type or UKNOWN

Throws:

Exception

getCppJavaType

public String getCppJavaType(Field field)
                      throws Exception

Get the cpp type for a field.

Returns:

the java type or UKNOWN

Throws:

Exception

getSetType

public String getSetType(Model model,
                Field field)
                  throws Exception

Java setter type of the field, e.g. getString() returns "String".

Parameters:

model -

field -

Returns:

setter type

Throws:

Exception

getDefault

public String getDefault(Model model,
                Field field)
                  throws Exception

Creates a default value based on the default values set in the model. If no defaultValue is provided and if the field is not "automatic" then the default value is set to "null" so the user has to decide.

Parameters:

model - Meta model

field - Meta model of a field (question: couldn't we ask the field for this??)

Returns:

the default value as String

Throws:

Exception

getJavaAssignment

public String getJavaAssignment(Field field,
                       String value)
                         throws MolgenisModelException

Throws:

MolgenisModelException

toCsv

public String toCsv(List<String> elements)

Convert a list of string to comma separated values.

Parameters:

elements -

Returns:

csv

getMysqlType

public String getMysqlType(Model model,
                  Field field)
                    throws Exception

Get the mysql type of a field: VARCHAR, INT, etc.

Parameters:

model -

field -

Returns:

string that represents the mysql value of a fieldtype.

Throws:

Exception

getOracleType

public String getOracleType(Model model,
                   Field field)
                     throws Exception

Throws:

Exception

getXsdType

public String getXsdType(Model model,
                Field field)
                  throws Exception

Throws:

Exception

getHsqlType

public String getHsqlType(Field field)
                   throws Exception

Throws:

Exception

getAddFields

public Vector<Field> getAddFields(Entity e)
                           throws Exception

Throws:

Exception

getAddFields

public Vector<Field> getAddFields(Entity e,
                         boolean includeKey)
                           throws Exception

Get the fields that participate in an insert (so excluding automatic fields).

Parameters:

e -

includeKey -

Returns:

vector of fields that are not automatic values

Throws:

Exception

getAllFields

public Vector<Field> getAllFields(Entity e)
                           throws Exception

Throws:

Exception

getAllFields

public Vector<Field> getAllFields(Entity e,
                         String type)
                           throws Exception

Throws:

Exception

getDbFields

public Vector<Field> getDbFields(Entity e,
                        String type)
                          throws Exception

The table fields of this entity

Throws:

Exception

getViewFields

public Vector<Field> getViewFields(Entity e,
                          String type)
                            throws Exception

The queryable fields of the entity (in case of inheritance from the view join)

Parameters:

e -

type -

Throws:

Exception

getUpdateFields

public Vector<Field> getUpdateFields(Entity e)
                              throws Exception

Throws:

Exception

isPrimaryKey

public boolean isPrimaryKey(Field f,
                   Entity e)
                     throws MolgenisModelException

Throws:

MolgenisModelException

getKeyFields

public Vector<Field> getKeyFields(Entity e)
                           throws MolgenisModelException

Throws:

MolgenisModelException

getAllKeys

public Vector<Unique> getAllKeys(Entity e)
                          throws MolgenisModelException

Throws:

MolgenisModelException

getSecondaryKeys

public Vector<Unique> getSecondaryKeys(Entity e)
                                throws MolgenisModelException

Return all secondary keys for an entity

Parameters:

e - entity

Returns:

list of unique

Throws:

MolgenisModelException

getKeyFields

public Vector<Field> getKeyFields(List<Unique> keys)
                           throws MolgenisModelException

Return all secondary key fields. If two secondary keys share a field, its only returned once.

Parameters:

keys - list of Unique definitions

Returns:

vector of fields that are part of a unique constraint

Throws:

MolgenisModelException

getSecondaryKeyFields

public Vector<Field> getSecondaryKeyFields(Entity e)
                                    throws MolgenisModelException

Throws:

MolgenisModelException

getKeyFields

public Vector<Field> getKeyFields(Unique u)
                           throws MolgenisModelException

Throws:

MolgenisModelException

getTableKeys

public Vector<Unique> getTableKeys(Entity e)
                            throws MolgenisModelException

A table can only contain the keys for columns that are actually in the table. In subclass_per_table mapping this requirement is not satisfied. These keys are ommited, and a warning is shown that these keys are not enforced.

Parameters:

e -

Returns:

Vector of Unique (singular or complex keys)

Throws:

MolgenisModelException

getXrefField

public Field getXrefField(Model model,
                 Field e)
                   throws Exception

Throws:

Exception

getFieldType

public FieldType getFieldType(Model model,
                     Field field)
                       throws Exception

Throws:

Exception

getJavaName

public static String getJavaName(String name)

First character to upercase. And also when following "_";

Parameters:

name -

Returns:

getJavaName

public static String getJavaName(String name,
                 boolean doFirstToUpper)

getSubclasses

public List<Entity> getSubclasses(Entity superclass,
                         Model m)

getSuperclasses

public List<Entity> getSuperclasses(Entity subclass,
                           Model m)

pluralOf

public String pluralOf(String string)

parseQueryOperator

public String parseQueryOperator(String label)

escapeXml

public static String escapeXml(String nonXml)

getImports

public String getImports(Model m,
                Entity e,
                String subpackage,
                String suffix)
                  throws MolgenisModelException

Throws:

MolgenisModelException

getTypeFieldName

public String getTypeFieldName()