Author: echatellier Date: 2012-01-06 18:04:24 +0100 (Fri, 06 Jan 2012) New Revision: 1290 Url: http://nuiton.org/repositories/revision/wikitty/1290 Log: Update documentation Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyContractGenerator.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyHelperGenerator.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyImplementationGenerator.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyMetaTransformer.java trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyPurifierTransformer.java Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -51,6 +51,8 @@ /*{generator option: writeString = +}*/ /** + * Wikitty abstract class generator. + * * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyAbstractGenerator" */ public class WikittyAbstractGenerator extends ObjectModelTransformerToJava { @@ -336,6 +338,22 @@ } } + /** + * Methode de génération des methodes (avec corps) qui permet de generer + * des methodes avec des nom (et corps) différent suivant si on l'appel + * pour générer le operation de la classe actuelle ou celles de ses + * super classes. + * + * @param businessEntity class du modèle + * @param abstractClass class a générer + * @param attribute attribut dont on veut generer les opérations + * @param getterSetterName le nom du getter (peut etre différent du nom + * de l'attribut dans le cas d'un heritage multiples) + * @param helperClassName le nom du helper qui gere l'acces au parametre + * (celui de la classe courante ou un de ses supper class) + * @param helperGetterSetterName le nom du getter a appeler pour le helper + * concerné + */ protected void addOperationWithName(ObjectModelClass businessEntity, ObjectModelClass abstractClass, ObjectModelAttribute attribute, String getterSetterName, String helperClassName, String helperGetterSetterName) { Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyContractGenerator.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyContractGenerator.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyContractGenerator.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -51,6 +51,8 @@ /*{generator option: writeString = +}*/ /** + * Wikitty interface générator. + * * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyContractGenerator" */ public class WikittyContractGenerator extends ObjectModelTransformerToJava { @@ -258,7 +260,18 @@ processedEntities.add(businessEntity); } - protected void addOperationWithName(ObjectModelInterface contract, ObjectModelAttribute attribute, String attributeName) { + /** + * Methode de génération des methodes (sans corps) qui permet de generer + * des methodes avec des nom différent suivant si on l'appel + * pour générer le operation de la classe actuelle ou celles de ses + * super classes. + * + * @param contract class a générer + * @param attribute attribut dont on veut generer les opérations + * @param getterSetterName le nom du getter (peut etre différent du nom + * de l'attribut dans le cas d'un heritage multiples) + */ + protected void addOperationWithName(ObjectModelInterface contract, ObjectModelAttribute attribute, String getterSetterName) { String attributeType = WikittyTransformerUtil.generateResultType(attribute, false); if (attribute.getMaxMultiplicity() > 1 || attribute.getMaxMultiplicity() == -1) { // attributed is a collection, we will generate operations get, add, remove and clear @@ -269,38 +282,38 @@ // now, for this attribute, we will generate add, remove and clear methods // adding operations to contract - String getterName = "get" + StringUtils.capitalize(attributeName); + String getterName = "get" + StringUtils.capitalize(getterSetterName); ObjectModelOperation getter = addOperation(contract, getterName, attributeTypeCollectionStrict); setDocumentation(getter, attribute.getDocumentation()); - String setterName = "set" + StringUtils.capitalize(attributeName); + String setterName = "set" + StringUtils.capitalize(getterSetterName); ObjectModelOperation setter = addOperation(contract, setterName, "void"); - addParameter(setter, attributeTypeCollectionStrict, attributeName); + addParameter(setter, attributeTypeCollectionStrict, getterSetterName); - String addAllName = "addAll" + StringUtils.capitalize(attributeName); + String addAllName = "addAll" + StringUtils.capitalize(getterSetterName); ObjectModelOperation addAll = addOperation(contract, addAllName, "void"); - addParameter(addAll, attributeTypeCollectionGeneric, attributeName); + addParameter(addAll, attributeTypeCollectionGeneric, getterSetterName); - String addName = "add" + StringUtils.capitalize(attributeName); + String addName = "add" + StringUtils.capitalize(getterSetterName); ObjectModelOperation adder = addOperation(contract, addName, "void"); addParameter(adder, attributeTypeVarargs, "element"); - String removeName = "remove" + StringUtils.capitalize(attributeName); + String removeName = "remove" + StringUtils.capitalize(getterSetterName); ObjectModelOperation remover = addOperation(contract, removeName, "void"); addParameter(remover, attributeTypeVarargs, "element"); - String clearName = "clear" + StringUtils.capitalize(attributeName); + String clearName = "clear" + StringUtils.capitalize(getterSetterName); addOperation(contract, clearName, "void"); } else { // attribute is not a collection, we generate a getter and a setter - String getterName = "get" + StringUtils.capitalize(attributeName); + String getterName = "get" + StringUtils.capitalize(getterSetterName); ObjectModelOperation getter = addOperation(contract, getterName, attributeType); setDocumentation(getter, attribute.getDocumentation()); - String setterName = "set" + StringUtils.capitalize(attributeName); + String setterName = "set" + StringUtils.capitalize(getterSetterName); ObjectModelOperation setter = addOperation(contract, setterName, "void"); - addParameter(setter, attributeType, attributeName); + addParameter(setter, attributeType, getterSetterName); } } Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2010 CodeLutin + * Copyright (C) 2010 - 2012 CodeLutin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -28,7 +28,6 @@ import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; -import java.util.HashSet; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; @@ -39,7 +38,6 @@ import org.apache.commons.lang.StringUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.nuiton.eugene.Transformer; import org.nuiton.eugene.java.ObjectModelTransformerToJava; import org.nuiton.eugene.models.object.ObjectModel; import org.nuiton.eugene.models.object.ObjectModelAttribute; @@ -54,6 +52,8 @@ /*{generator option: writeString = +}*/ /** + * Wikitty DTO générator. + * * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyDTOGenerator" */ public class WikittyDTOGenerator extends ObjectModelTransformerToJava { Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyHelperGenerator.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyHelperGenerator.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyHelperGenerator.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2012 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -44,6 +44,8 @@ /*{generator option: writeString = +}*/ /** + * Wikitty helper generator. + * * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyHelperGenerator" */ public class WikittyHelperGenerator extends ObjectModelTransformerToJava { Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyImplementationGenerator.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyImplementationGenerator.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyImplementationGenerator.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -5,7 +5,7 @@ * $Id$ * $HeadURL$ * %% - * Copyright (C) 2009 - 2010 CodeLutin, Benjamin Poussin + * Copyright (C) 2009 - 2012 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -47,6 +47,8 @@ /*{generator option: writeString = +}*/ /** + * Wikitty implementation class generator. + * * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyImplementationGenerator" */ public class WikittyImplementationGenerator extends ObjectModelTransformerToJava { Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyMetaTransformer.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyMetaTransformer.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyMetaTransformer.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -30,6 +30,11 @@ import org.nuiton.eugene.models.object.ObjectModel; import org.nuiton.eugene.models.object.ObjectModelClass; +//TODO 20100610 use filter with /*[]*/ +/*{generator option: writeString = }*/ +/*{generator option: parentheses = false}*/ +/*{generator option: writeString = +}*/ + /** * Wikitty generation steps : * <ol> @@ -47,12 +52,6 @@ * @author bleny * @plexus.component role="org.nuiton.eugene.Template" role-hint="org.nuiton.wikitty.generator.WikittyMetaGenerator" */ - -// TODO 20100610 use filter with /*[]*/ -/*{generator option: writeString = }*/ -/*{generator option: parentheses = false}*/ -/*{generator option: writeString = +}*/ - public class WikittyMetaTransformer extends AbstractMetaTransformer<ObjectModel> { private static final Log log = LogFactory.getLog(WikittyMetaTransformer.class); Modified: trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyPurifierTransformer.java =================================================================== --- trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyPurifierTransformer.java 2012-01-06 16:53:56 UTC (rev 1289) +++ trunk/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyPurifierTransformer.java 2012-01-06 17:04:24 UTC (rev 1290) @@ -158,7 +158,10 @@ * @param source the class to clone from the source model * @param cloneDocumentation flag to add documentation if some found in model * @return the clone of the given class + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelClass cloneClass(ObjectModelClass source, boolean cloneDocumentation) { ObjectModelClass outputClass = @@ -192,7 +195,10 @@ * @param source the classifier to clone from the source model * @param cloneDocumentation flag to add documentation if some found in model * @return the clone of the given classifier + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelClassifier cloneClassifier(ObjectModelClassifier source, boolean cloneDocumentation) { ObjectModelClassifier clone = null; @@ -217,7 +223,10 @@ * @param source the interface to clone from the source model * @param cloneDocumentation flag to add documentation if some found in model * @return the clone of the given interface + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelInterface cloneInterface(ObjectModelInterface source, boolean cloneDocumentation) { ObjectModelInterface outputInterface = @@ -237,7 +246,10 @@ * @param source the enumeration to clone from the source model * @param cloneDocumentation flag to add documentation if some found in model * @return the clone of the given enumeration + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelEnumeration cloneEnumeration(ObjectModelEnumeration source, boolean cloneDocumentation) { ObjectModelEnumeration outputEnumeration = @@ -263,7 +275,10 @@ * @param source the classifier to clone from the source model * @param destination where to clone the given source one * @param copyDocumentation flag to add documentation if some found in model + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated protected void cloneClassifier(ObjectModelClassifier source, ObjectModelClassifier destination, boolean copyDocumentation) { @@ -295,7 +310,10 @@ * @param cloneDocumentation flag to add documentation if some found in model * @param modifiers extra modifiers * @return the new operation created in destination classifier + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelOperation cloneOperation(ObjectModelOperation source, ObjectModelClassifier destination, boolean cloneDocumentation, @@ -327,7 +345,10 @@ * * @param source the source element * @param destination the destination element + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated protected void cloneTagValues(ObjectModelElement source, ObjectModelElement destination) { Map<String, String> tags = source.getTagValues(); @@ -340,7 +361,10 @@ * * @param source * @param destination + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated protected void cloneStereotypes(ObjectModelClassifier source, ObjectModelClassifier destination) { @@ -360,7 +384,10 @@ * @param cloneDocumentation flag to add documentation if some found in model * @param modifiers extra modifiers * @return the new operation created in destination classifier + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated public ObjectModelOperation cloneOperationSignature(ObjectModelOperation source, ObjectModelClassifier destination, boolean cloneDocumentation, @@ -400,7 +427,10 @@ * @param cloneDocumentation flag to add documentation if some found in model * @param modifiers extra modifiers * @return the clone attribute + * + * @deprecated echatellier 20120106 must be moved to super class : ObjectModelTransformer */ + @Deprecated protected ObjectModelAttribute cloneAttribute(ObjectModelAttribute source, ObjectModelClassifier destination, boolean cloneDocumentation,