org.tentackle.persist.wurblet

Class DbModelWurblet

java.lang.Object

org.wurbelizer.wurblet.AbstractWurblet

org.tentackle.wurblet.ModelWurblet

org.tentackle.persist.wurblet.DbModelWurblet

All Implemented Interfaces:

org.wurbelizer.wurblet.Wurblet

Direct Known Subclasses:

AssertRemote, ClassVariables, DbDeleteBy, DbIsReferencing, DbSelectList, DbSelectUnique, DbUpdateBy, Declare, MethodsImpl, PdoCache, PdoCopy, PdoDeleteBy, PdoIsReferencing, PdoRelations, PdoSelectList, PdoSelectUnique, PdoUpdateBy, RemoteMethod

public class DbModelWurblet
extends ModelWurblet

Adds persistence-specific stuff.

Author:

harald

Field Summary

Fields inherited from class org.wurbelizer.wurblet.AbstractWurblet

container, out, source

Constructor Summary

Constructors

Constructor and Description
DbModelWurblet()

Method Summary

Modifier and Type	Method and Description
String	aas(String str) Utility method to generate argument list.
String	acs(String str, String appendStr) Adds a string to a comma separated list.
String	as(String str) Utility method to always get a non-null string.
void	assertEntityIsPersistable() Asserts that SQL statements can be executed for that entity.
String	buildInvocationParameters() Builds the string of invocation parameters.
String	buildInvocationParameters(boolean limit, boolean offset) Builds the string of invocation parameters.
String	buildMethodParameters() Builds the string of method parameters.
String	buildMethodParameters(boolean limit, boolean offset) Builds the string of method parameters.
String	createJdbcGetterName(org.tentackle.model.Attribute attribute) Creates the "getXXXX" method name for ResultSetWrapper.
String	createJdbcSetterName(org.tentackle.model.Attribute attribute) Creates the "setXXXX" method name for PreparedStatementWrapper.
String	createOrderBy() Creates the order by clause.
String	createOrderBy(List<WurbletParameter> sortKeys) Creates the order by clause.
String	createRelationArgString(org.tentackle.model.Relation relation, boolean select) Creates the argument string for select- or delete statement of a relation.
String	createRelationDeleteCode(org.tentackle.model.Relation relation) Creates the java code to delete a relation.
String	createRelationLinkCode(org.tentackle.model.Relation relation) Creates the java code to set the link of a relation.
String	createRelationSelectCode(org.tentackle.model.Relation relation) Creates the java code to select a relation.
String	createRelationSetFirstArgMethodName(org.tentackle.model.Relation relation) Creates the set-first-arg method name (useful only in object relations).
String	createRelationUpdateReferenceCode(org.tentackle.model.Relation relation) Creates the java code to update the reference of a relation.
String	createStatementId() Creates the name of a statement id. Because statement ids are final, the name is in uppercase.
Set<ComponentJoin>	getComponentJoins() Gets the component joins.
org.tentackle.model.Attribute	getContextAttribute() Gets the context attribute.
List<org.tentackle.model.AttributeSorting>	getDefaultSorting() Goes up the inheritance tree until a default sorting is found.
List<WurbletParameter>	getDefaultSortKeys() Gets the default sorting keys.
List<org.tentackle.model.Relation>	getEagerRelations() The TT persistence layer provides an optimized select for a single eager relations via a Join.
String	getJdbcCode(org.tentackle.model.Attribute attribute, String modelCode) Creates java code applicable to the JDBC layer from model variable access code. Applies .toExternal() if attribute is an application specific type.
org.tentackle.model.DataType	getJdbcDataType(org.tentackle.model.Attribute attribute) Gets the effective DataType used agains Tentackle's JDBC wrapper layer.
List<org.tentackle.model.Relation>	getJoinedRelations() Gets the non-component joined relations.
String	getModelCode(org.tentackle.model.Attribute attribute, String jdbcCode) Creates java code applicable to the application model from JDBC variable access code. Applies .toInternal() if attribute is an application specific type.
List<String>	getRelationArgs(org.tentackle.model.Relation relation, boolean select) Gets the relation arguments for delete or select methods.
boolean	isAttracked() Returns whether the entity is attracked or fulltracked.
boolean	isClassIdRequiredInWhereClause() Returns whether the classid needs to be inluded in the WHERE-clause.
boolean	isClassIdRequiredInWhereClause(org.tentackle.model.Entity entity) Returns whether the classid needs to be inluded in the WHERE-clause.
boolean	isEntityPersistable() Returns whether SQL statements can be executed for that entity.
boolean	isFullTracked() Returns whether the entity is fulltracked.
boolean	isRelationTransient(org.tentackle.model.Relation relation) Returns whether the relation is transient.
boolean	isTracked() Returns whether the entity is tracked.
boolean	isWithDefaultSorting() Returns whether default sorting is configured for the entity.
String	pcs(String str, String prependStr) Prepends a string to a comma separated list.
void	run() Overridden to process some arguments.

Methods inherited from class org.tentackle.wurblet.ModelWurblet

appendCommaSeparated, createListRelationDeleteMethodName, createRelationSelectMethodName, deriveClassNameForEntity, getAllParameters, getArgs, getEntity, getExpression, getExpressionParameters, getExtraParameters, getJoins, getMethodName, getMethodParameters, getModelDirName, getModelName, getOption, getOptionArgs, getPdoClassName, getSortingParameters, isAttributeDerived, isContextIdAttributeValid, isGenerified, isIdAttribute, isIdOrSerialAttribute, isPartOfInheritanceHierarchy, isPdo, isRemote, isSerialAttribute, isSetGetRequired, isWithSorting, orderByInheritanceLevelAndClassId, prependCommaSeparated, setRemote

Methods inherited from class org.wurbelizer.wurblet.AbstractWurblet

cleanup, getClassName, getContainer, getGuardName, getPackageName, getSuperClassName, setContainer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DbModelWurblet

public DbModelWurblet()

Method Detail

run

public void run()
         throws org.wurbelizer.wurbel.WurbelException

Overridden to process some arguments.

 --context=<key> defines the context id (--context= turns off default context)
 --tracked return a TrackedArrayList instead of an ArrayList (if not [TRACKED] given in model)
 --attracked (same as tracked but generate is...Modified per attribute)
 --fulltracked (same as attracked but keep last persisted values as well)
 --untracked to disable [TRACKED, ATTRACKED or FULLTRACKED] from model
 --makevalidcontext sets the context from the object instead of context
 --makevalidcontext=- turns off the default makeValidContext
 --or use OR instead of AND for multiple keys
 

Specified by:

run in interface org.wurbelizer.wurblet.Wurblet

Overrides:

run in class ModelWurblet

Throws:

org.wurbelizer.wurbel.WurbelException - if running the wurblet failed

isTracked

public boolean isTracked()

Returns whether the entity is tracked.

Returns:

true if tracked (TRACKED, ATTRACKED or FULLTRACKED)

isAttracked

public boolean isAttracked()

Returns whether the entity is attracked or fulltracked.

Returns:

true if attracked (ATTRACKED or FULLTRACKED)

isFullTracked

public boolean isFullTracked()

Returns whether the entity is fulltracked.

Returns:

true if FULLTRACKED

getContextAttribute

public org.tentackle.model.Attribute getContextAttribute()

Gets the context attribute.

Returns:

the context attribute, null if none

isClassIdRequiredInWhereClause

public boolean isClassIdRequiredInWhereClause(org.tentackle.model.Entity entity)

Returns whether the classid needs to be inluded in the WHERE-clause.

Parameters:

entity - the entity

Returns:

true if include classid

isClassIdRequiredInWhereClause

public boolean isClassIdRequiredInWhereClause()

Returns whether the classid needs to be inluded in the WHERE-clause.

Returns:

true if include classid

isEntityPersistable

public boolean isEntityPersistable()

Returns whether SQL statements can be executed for that entity.

Returns:

true if persistable

assertEntityIsPersistable

public void assertEntityIsPersistable()
                               throws org.wurbelizer.wurbel.WurbelException

Asserts that SQL statements can be executed for that entity.

Throws:

org.wurbelizer.wurbel.WurbelException - if not

getDefaultSorting

public List<org.tentackle.model.AttributeSorting> getDefaultSorting()

Goes up the inheritance tree until a default sorting is found.

Returns:

the sorting, null if none

getDefaultSortKeys

public List<WurbletParameter> getDefaultSortKeys()

Gets the default sorting keys.

Returns:

the sorting keys, empty if no "order by"

isWithDefaultSorting

public boolean isWithDefaultSorting()

Returns whether default sorting is configured for the entity.

Returns:

true if sorting enabled

getComponentJoins

public Set<ComponentJoin> getComponentJoins()
                                     throws org.wurbelizer.wurbel.WurbelException

Gets the component joins.

Returns:

the joins, empty if none

Throws:

org.wurbelizer.wurbel.WurbelException - if a join could not be created

getJoinedRelations

public List<org.tentackle.model.Relation> getJoinedRelations()

Gets the non-component joined relations.

Returns:

the non-component joined relations

createOrderBy

public String createOrderBy(List<WurbletParameter> sortKeys)
                     throws org.wurbelizer.wurbel.WurbelException

Creates the order by clause.

Parameters:

sortKeys - the sorting keys

Returns:

the order by clause, null if unsorted

Throws:

org.wurbelizer.wurbel.WurbelException - if failed

createOrderBy

public String createOrderBy()
                     throws org.wurbelizer.wurbel.WurbelException

Creates the order by clause.

Returns:

the order by clause, null if unsorted

Throws:

org.wurbelizer.wurbel.WurbelException - if failed

createStatementId

public String createStatementId()
                         throws org.wurbelizer.wurbel.WurbelException

Creates the name of a statement id.
Because statement ids are final, the name is in uppercase.

Returns:

the id string

Throws:

org.wurbelizer.wurbel.WurbelException - if guardname could not be determined

buildMethodParameters

public String buildMethodParameters(boolean limit,
                                    boolean offset)
                             throws org.wurbelizer.wurbel.WurbelException

Builds the string of method parameters.

Parameters:

limit - optional limit rows

offset - optional skip rows

Returns:

the method parameters

Throws:

org.wurbelizer.wurbel.WurbelException - if failed

buildMethodParameters

public String buildMethodParameters()
                             throws org.wurbelizer.wurbel.WurbelException

Builds the string of method parameters.

Returns:

the method parameters

Throws:

org.wurbelizer.wurbel.WurbelException - if failef

buildInvocationParameters

public String buildInvocationParameters(boolean limit,
                                        boolean offset)

Builds the string of invocation parameters.

Parameters:

limit - optional limit rows

offset - optional skip rows

Returns:

the invocation parameters

buildInvocationParameters

public String buildInvocationParameters()

Builds the string of invocation parameters.

Returns:

the invocation parameters

acs

public String acs(String str,
                  String appendStr)

Adds a string to a comma separated list.

Parameters:

str - the string

appendStr - the string to append

Returns:

the new string

pcs

public String pcs(String str,
                  String prependStr)

Prepends a string to a comma separated list.

Parameters:

str - the string builder

prependStr - the string to prepend

Returns:

the new string

aas

public String aas(String str)

Utility method to generate argument list.

Parameters:

str - the argument string

Returns:

comma + str if str not empty or null, the empty string otherwise

as

public String as(String str)

Utility method to always get a non-null string.

Parameters:

str - the source string

Returns:

the string or the empty string if str is null

getJdbcDataType

public org.tentackle.model.DataType getJdbcDataType(org.tentackle.model.Attribute attribute)
                                             throws org.wurbelizer.wurbel.WurbelException

Gets the effective DataType used agains Tentackle's JDBC wrapper layer.

Parameters:

attribute - the model attribute

Returns:

the data type

Throws:

org.wurbelizer.wurbel.WurbelException - if type is misconfigured

createJdbcSetterName

public String createJdbcSetterName(org.tentackle.model.Attribute attribute)
                            throws org.wurbelizer.wurbel.WurbelException

Creates the "setXXXX" method name for PreparedStatementWrapper.

Parameters:

attribute - the model attribute

Returns:

the method name

Throws:

org.wurbelizer.wurbel.WurbelException - if type is misconfigured

createJdbcGetterName

public String createJdbcGetterName(org.tentackle.model.Attribute attribute)
                            throws org.wurbelizer.wurbel.WurbelException

Creates the "getXXXX" method name for ResultSetWrapper.

Parameters:

attribute - the model attribute

Returns:

the method name

Throws:

org.wurbelizer.wurbel.WurbelException - if type is misconfigured

getModelCode

public String getModelCode(org.tentackle.model.Attribute attribute,
                           String jdbcCode)
                    throws org.wurbelizer.wurbel.WurbelException

Creates java code applicable to the application model from JDBC variable access code.
Applies .toInternal() if attribute is an application specific type. Otherwise jdbcCode is returned unchanged.

Parameters:

attribute - the attribute

jdbcCode - the jdbc code

Returns:

the code the model code

Throws:

org.wurbelizer.wurbel.WurbelException - if some model error

getJdbcCode

public String getJdbcCode(org.tentackle.model.Attribute attribute,
                          String modelCode)
                   throws org.wurbelizer.wurbel.WurbelException

Creates java code applicable to the JDBC layer from model variable access code.
Applies .toExternal() if attribute is an application specific type. Otherwise modelCode is returned unchanged.

Parameters:

attribute - the attribute

modelCode - the jdbc code

Returns:

the code the model code

Throws:

org.wurbelizer.wurbel.WurbelException - if some model error

isRelationTransient

public boolean isRelationTransient(org.tentackle.model.Relation relation)

Returns whether the relation is transient.

Parameters:

relation - the relation

Returns:

true if transient modifier required

getRelationArgs

public List<String> getRelationArgs(org.tentackle.model.Relation relation,
                                    boolean select)

Gets the relation arguments for delete or select methods.

Parameters:

relation - the relation

select - is true if args for select-method, else delete-method

Returns:

the arguments for select/delete methods

createRelationArgString

public String createRelationArgString(org.tentackle.model.Relation relation,
                                      boolean select)

Creates the argument string for select- or delete statement of a relation.

Parameters:

relation - the relation.

select - is true if for selectStatement, else deleteStatement

Returns:

the arg string

createRelationSelectCode

public String createRelationSelectCode(org.tentackle.model.Relation relation)

Creates the java code to select a relation.

Parameters:

relation - the relation

Returns:

the java code

createRelationUpdateReferenceCode

public String createRelationUpdateReferenceCode(org.tentackle.model.Relation relation)

Creates the java code to update the reference of a relation.

Parameters:

relation - the relation

Returns:

the java code

createRelationSetFirstArgMethodName

public String createRelationSetFirstArgMethodName(org.tentackle.model.Relation relation)

Creates the set-first-arg method name (useful only in object relations).

Parameters:

relation - the relation

Returns:

the set-method name

createRelationDeleteCode

public String createRelationDeleteCode(org.tentackle.model.Relation relation)

Creates the java code to delete a relation.

Parameters:

relation - the relation

Returns:

the java code

createRelationLinkCode

public String createRelationLinkCode(org.tentackle.model.Relation relation)

Creates the java code to set the link of a relation.

Parameters:

relation - the relation

Returns:

the java code

getEagerRelations

public List<org.tentackle.model.Relation> getEagerRelations()

The TT persistence layer provides an optimized select for a single eager relations via a Join.

Returns:

the eager relations, empty list if no optimization possible or no eagers at all