org.nuiton.topia.templates

Class EntityDaoTransformer

java.lang.Object

org.nuiton.eugene.Template<I>

org.nuiton.eugene.Transformer<org.nuiton.eugene.models.object.ObjectModel,O>

org.nuiton.eugene.models.object.ObjectModelTransformer<org.nuiton.eugene.models.object.ObjectModel>

org.nuiton.eugene.java.ObjectModelTransformerToJava

org.nuiton.topia.templates.EntityDaoTransformer

All Implemented Interfaces:

org.nuiton.eugene.TemplateConfiguration

public class EntityDaoTransformer
extends org.nuiton.eugene.java.ObjectModelTransformerToJava

To generate all DAO related classes for a given entity.

Since:

2.5.4

Author:

tchemit

Plexus component:

role: "org.nuiton.eugene.Template" role-hint: "org.nuiton.topia.templates.EntityDaoTransformer"

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	allEntitiesFqn All entities fqn of the model (used to detect if an attribute is not an entity).
protected String	entityEnumName
protected String	entityEnumPackage
protected Map<String,Collection<org.nuiton.eugene.models.object.ObjectModelOperation>>	extraOperations Map of extra operations for DAO.
protected Map<org.nuiton.eugene.models.object.ObjectModelClass,Set<org.nuiton.eugene.models.object.ObjectModelClass>>	usages map of direct usages (values) for each entity (key).

Fields inherited from class org.nuiton.eugene.java.ObjectModelTransformerToJava

builder

Fields inherited from class org.nuiton.eugene.Transformer

outputModel, outputProperties, outputTemplate, previousTransformer

Fields inherited from class org.nuiton.eugene.Template

configuration, excludeTemplates, generatedPackages, model

Fields inherited from interface org.nuiton.eugene.TemplateConfiguration

PROP_CLASS_LOADER, PROP_DEFAULT_PACKAGE, PROP_ENCODING, PROP_EXCLUDE_TEMPLATES, PROP_GENERATED_PACKAGES, PROP_LAST_MODIFIED_SOURCE, PROP_OVERWRITE, PROP_VERBOSE, PROP_WRITER_REPORT

Constructor Summary

Constructors

Constructor and Description
EntityDaoTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generateAbstractDao(org.nuiton.eugene.models.object.ObjectModelClass clazz, String clazzName, String clazzFQN)
protected void	generateConcreteDao(org.nuiton.eugene.models.object.ObjectModelClass clazz, String clazzName, String clazzFQN)
protected void	generateDAOOperations(org.nuiton.eugene.models.object.ObjectModelClass result, Collection<org.nuiton.eugene.models.object.ObjectModelOperation> operations) Deprecated. will be removed ASAP in topia 3.0
protected void	generateDelete(org.nuiton.eugene.models.object.ObjectModelClass clazz, org.nuiton.eugene.models.object.ObjectModelClass result)
protected void	generateFindUsages(org.nuiton.eugene.models.object.ObjectModelClass clazz, org.nuiton.eugene.models.object.ObjectModelClass result, Set<org.nuiton.eugene.models.object.ObjectModelClass> usagesForclass)
protected void	generateGeneratedDao(org.nuiton.eugene.models.object.ObjectModelClass clazz, String clazzName, String clazzFQN)
protected void	generateNMultiplicity(String clazzName, org.nuiton.eugene.models.object.ObjectModelClass result, org.nuiton.eugene.models.object.ObjectModelAttribute attr)
protected void	generateNoNMultiplicity(String clazzName, org.nuiton.eugene.models.object.ObjectModelClass result, org.nuiton.eugene.models.object.ObjectModelAttribute attr, boolean isAssoc)
protected void	generateNotNull(org.nuiton.eugene.models.object.ObjectModelClass result, org.nuiton.eugene.models.object.ObjectModelClass clazz)
Collection<org.nuiton.eugene.models.object.ObjectModelOperation>	getDaoOperations(org.nuiton.eugene.models.object.ObjectModelClass clazz) Deprecated. Dao operation will not be generated anymore in a very close future
protected boolean	isGenerateAbstractDao(org.nuiton.eugene.models.object.ObjectModelClass input)
protected boolean	isGenerateConcreteDao(org.nuiton.eugene.models.object.ObjectModelClass input)
protected boolean	isGenerateGeneratedDao(org.nuiton.eugene.models.object.ObjectModelClass input)
void	transformFromClass(org.nuiton.eugene.models.object.ObjectModelClass clazz)
void	transformFromInterface(org.nuiton.eugene.models.object.ObjectModelInterface interfacez)
void	transformFromModel(org.nuiton.eugene.models.object.ObjectModel model)
protected void	warnOnLegacyClassDetected(String packageName, String legacyDaoName, String daoName, String daoGenerics, String superclassQualifiedName)

Methods inherited from class org.nuiton.eugene.java.ObjectModelTransformerToJava

addAnnotation, addAnnotation, addAnnotationParameter, addAttribute, addAttribute, addAttribute, addAttribute, addBlock, addComment, addConstant, addConstant, addConstantsFromDependency, addConstructor, addConstructor, addException, addException, addGeneratedAnnotation, addI18n, addImport, addImport, addImport, addInnerClassifier, addInterface, addInterface, addLiteral, addOperation, addOperation, addOperation, addParameter, addParameter, addStereotype, addTagValue, addTagValue, cloneAttribute, cloneClass, cloneClassifier, cloneClassifier, cloneEnumeration, cloneInterface, cloneOperation, cloneOperationSignature, cloneStereotypes, cloneTagValues, copyClassifier, createAbstractClass, createClass, createEnumeration, createInterface, debugOutputModel, generateI18nBlock, getConstantName, getConstantPrefix, getConstantPrefix, getFileInClassPath, getJavaBeanMethodName, getJavaBeanMethodName, initConstantPrefixFromModel, initOutputModel, initOutputTemplate, isInClassPath, isInClassPath, isInClassPath, setConstantPrefix, setDocumentation, setMaxMultiplicity, setMinMultiplicity, setNavigable, setOperationBody, setSuperClass, setSuperClass

Methods inherited from class org.nuiton.eugene.models.object.ObjectModelTransformer

transform, transformFromClassifier, transformFromElement, transformFromEnumeration

Methods inherited from class org.nuiton.eugene.Transformer

applyTemplate, getDefaultPackageName, getOutputModel, getOutputProperties, getOutputTemplate, init, initPreviousTransformer, transform

Methods inherited from class org.nuiton.eugene.Template

getClassLoader, getConfiguration, getEncoding, getExcludeTemplates, getGeneratedPackages, getLastModifiedSource, getModel, getOverwrite, getProperties, getProperty, getProperty, getWriterReport, isOverwrite, isVerbose, setConfiguration, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

usages

protected Map<org.nuiton.eugene.models.object.ObjectModelClass,Set<org.nuiton.eugene.models.object.ObjectModelClass>> usages

map of direct usages (values) for each entity (key).

This map is used to generate the findUsages methods for DAOAbstract.

allEntitiesFqn

protected Set<String> allEntitiesFqn

All entities fqn of the model (used to detect if an attribute is not an entity).

entityEnumName

protected String entityEnumName

entityEnumPackage

protected String entityEnumPackage

extraOperations

protected Map<String,Collection<org.nuiton.eugene.models.object.ObjectModelOperation>> extraOperations

Map of extra operations for DAO. The key of the map is the qualified name of the entity relative to the DAO.

Constructor Detail

EntityDaoTransformer

public EntityDaoTransformer()

Method Detail

transformFromModel

public void transformFromModel(org.nuiton.eugene.models.object.ObjectModel model)

Overrides:

transformFromModel in class org.nuiton.eugene.models.object.ObjectModelTransformer<org.nuiton.eugene.models.object.ObjectModel>

transformFromInterface

public void transformFromInterface(org.nuiton.eugene.models.object.ObjectModelInterface interfacez)

Overrides:

transformFromInterface in class org.nuiton.eugene.models.object.ObjectModelTransformer<org.nuiton.eugene.models.object.ObjectModel>

transformFromClass

public void transformFromClass(org.nuiton.eugene.models.object.ObjectModelClass clazz)

Overrides:

transformFromClass in class org.nuiton.eugene.models.object.ObjectModelTransformer<org.nuiton.eugene.models.object.ObjectModel>

isGenerateConcreteDao

protected boolean isGenerateConcreteDao(org.nuiton.eugene.models.object.ObjectModelClass input)

isGenerateGeneratedDao

protected boolean isGenerateGeneratedDao(org.nuiton.eugene.models.object.ObjectModelClass input)

isGenerateAbstractDao

protected boolean isGenerateAbstractDao(org.nuiton.eugene.models.object.ObjectModelClass input)

generateConcreteDao

protected void generateConcreteDao(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                       String clazzName,
                       String clazzFQN)

generateAbstractDao

protected void generateAbstractDao(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                       String clazzName,
                       String clazzFQN)

warnOnLegacyClassDetected

protected void warnOnLegacyClassDetected(String packageName,
                             String legacyDaoName,
                             String daoName,
                             String daoGenerics,
                             String superclassQualifiedName)

generateGeneratedDao

protected void generateGeneratedDao(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                        String clazzName,
                        String clazzFQN)

generateDelete

protected void generateDelete(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                  org.nuiton.eugene.models.object.ObjectModelClass result)

generateFindUsages

protected void generateFindUsages(org.nuiton.eugene.models.object.ObjectModelClass clazz,
                      org.nuiton.eugene.models.object.ObjectModelClass result,
                      Set<org.nuiton.eugene.models.object.ObjectModelClass> usagesForclass)

generateDAOOperations

@Deprecated
protected void generateDAOOperations(org.nuiton.eugene.models.object.ObjectModelClass result,
                                    Collection<org.nuiton.eugene.models.object.ObjectModelOperation> operations)

Deprecated. will be removed ASAP in topia 3.0

Generation of DAO operations signatures from class. These operations are abstract and identified by <> stereotype in the model. The developper must defined these methods in the DAOImpl associated to this DAOAbstract.

Parameters:

result - clazz where to add operations

operations - operations to generate

generateNoNMultiplicity

protected void generateNoNMultiplicity(String clazzName,
                           org.nuiton.eugene.models.object.ObjectModelClass result,
                           org.nuiton.eugene.models.object.ObjectModelAttribute attr,
                           boolean isAssoc)

generateNMultiplicity

protected void generateNMultiplicity(String clazzName,
                         org.nuiton.eugene.models.object.ObjectModelClass result,
                         org.nuiton.eugene.models.object.ObjectModelAttribute attr)

getDaoOperations

@Deprecated
public Collection<org.nuiton.eugene.models.object.ObjectModelOperation> getDaoOperations(org.nuiton.eugene.models.object.ObjectModelClass clazz)

Deprecated. Dao operation will not be generated anymore in a very close future

Obtain business operations of the DAO. This operations can not be generated, but must be written by developper.

Parameters:

clazz - the clazz to test.

Returns:

collections of extra operations, or empty collection if none found.

generateNotNull

protected void generateNotNull(org.nuiton.eugene.models.object.ObjectModelClass result,
                   org.nuiton.eugene.models.object.ObjectModelClass clazz)