Author: fdesbois Date: 2010-05-08 18:05:12 +0200 (Sat, 08 May 2010) New Revision: 1940 Url: http://nuiton.org/repositories/revision/topia/1940 Log: Clean headers + add some javadoc Added: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/SearchFields.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAO.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAOImpl.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaId.java Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/DepthEntityVisitor.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -35,11 +35,9 @@ /** * Parcourt du graphe d'entité en profondeur. * - * @author chatellier - * @version $Revision$ - * - * Last update : $Date$ - * By : $Author$ + * @author chatellier <chatellier@codelutin.com> + * @author tchemit <tchemit@codelutin.com> + * @version $Id$ */ public class DepthEntityVisitor implements EntityVisitor { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/HorizontalEntityVisitor.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -36,11 +36,9 @@ /** * Parcourt en largeur du modele et délegation à un autre visiteur. * - * @author chatellier - * @version $Revision$ - * - * Last update : $Date$ - * By : $Author$ + * @author chatellier <chatellier@codelutin.com> + * @author tchemit <tchemit@codelutin.com> + * @version $Id$ */ public class HorizontalEntityVisitor implements EntityVisitor { @@ -121,7 +119,7 @@ // here, must revisit all remembered entities List<TopiaEntity> currentEntities = new ArrayList<TopiaEntity>(toVisitEntities); - // TODO verify if clearing here is enough + // TODO-chatellier-20091221 : verify if clearing here is enough toVisitEntities.clear(); for (TopiaEntity currentEntity : currentEntities) { try { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/SearchFields.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/SearchFields.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/SearchFields.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -44,6 +44,9 @@ import java.lang.annotation.Target; /** + * + * TODO-fdesbois-20100508 : javadoc : where is it used for ? which service use it ? + * * Ces annotations permettent de savoir quels sont les champs sur lesquels * la recherche pourra s'effectuer. */ Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAO.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAO.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAO.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -61,6 +61,7 @@ * DAOAbstractTransformer} for abstract implementation and {@link * DAOImplTransformer} for final implementation class. * + * TODO-fdesbois-20100508 : Need translation of javadoc. * * @author poussin <poussin@codelutin.com> * @author fdesbois <fdesbois@codelutin.com> Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAOImpl.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAOImpl.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaDAOImpl.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -37,49 +37,50 @@ package org.nuiton.topia.persistence; -import java.io.Serializable; -import java.lang.reflect.InvocationTargetException; -import java.security.Permission; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; - import org.apache.commons.beanutils.PropertyUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.hibernate.Criteria; import org.hibernate.FlushMode; +import org.hibernate.HibernateException; +import org.hibernate.Session; +import org.hibernate.metadata.ClassMetadata; import org.nuiton.topia.TopiaContext; import org.nuiton.topia.TopiaException; import org.nuiton.topia.event.TopiaEntityListener; import org.nuiton.topia.event.TopiaEntityVetoable; import org.nuiton.topia.framework.TopiaContextImplementor; -import org.hibernate.HibernateException; -import org.hibernate.Session; -import org.hibernate.criterion.Criterion; -import org.hibernate.criterion.Restrictions; -import org.hibernate.metadata.ClassMetadata; import org.nuiton.topia.framework.TopiaQuery; +import java.io.Serializable; +import java.lang.reflect.InvocationTargetException; +import java.security.Permission; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; + /** - * Cette classe permet d'avoir un ensemble de méthode implantée de façon + * TODO-fdesbois-20100508 : Need translation of javadoc. + * <p/> + * Cette classe permet d'avoir un ensemble de méthode implantée de façon * standard et plus spécifiquement pour Hibernate. + * <p/> + * Certains accès à Hibernate sont tout de même fait ici, car on a pris le choix + * de se baser entièrement sur hibernate pour la persistence, et il est ainsi + * possible d'accèder au meta information hibernate sur les classes lorque l'on + * en a besoin. * - * Certains accès à Hibernate sont tout de même fait ici, car on a pris le - * choix de se baser entièrement sur hibernate pour la persistence, et il - * est ainsi possible d'accèder au meta information hibernate sur les classes - * lorque l'on en a besoin. - * + * @author poussin <poussin@codelutin.com> + * @version $Id$ * @param <E> le type de l'entite - * @author poussin <poussin@codelutin.com> - * */ public class TopiaDAOImpl<E extends TopiaEntity> implements TopiaDAO<E> { // TopiaDAOImpl + /** to use log facility, just put in your code: log.info(\"...\"); */ private static Log log = LogFactory.getLog(TopiaDAOImpl.class); @@ -95,6 +96,7 @@ /** * Retourne l'id de l'entity + * * @param e l'entity * @return l'id de l'entity ou null si pas trouvé * @throws TopiaException Si une erreur survient durant la recherche @@ -126,6 +128,7 @@ /** * Retourne l'id de l'entity representer comme une map + * * @param map l'entity en representation map * @return l'id de l'entity ou null si pas trouvé * @throws TopiaException Si une erreur survient durant la recherche @@ -252,8 +255,9 @@ } /** - * Callback method when context was commit. - * By default, the method does nothing + * Callback method when context was commit. By default, the method does + * nothing + * * @throws TopiaException */ @Override @@ -261,8 +265,9 @@ } /** - * Callback method when context was rollback. - * By default, the method does nothing + * Callback method when context was rollback. By default, the method does + * nothing + * * @throws TopiaException */ @Override @@ -360,7 +365,7 @@ @Override public E findByProperties(String propertyName, Object value, - Object... others) throws TopiaException { + Object... others) throws TopiaException { Map<String, Object> properties = new HashMap<String, Object>(); properties.put(propertyName, value); Object name = null; @@ -387,7 +392,7 @@ @Override public List<E> findAllByProperties(String propertyName, Object value, - Object... others) throws TopiaException { + Object... others) throws TopiaException { Map<String, Object> properties = new HashMap<String, Object>(); properties.put(propertyName, value); Object name = null; @@ -419,13 +424,13 @@ E result = null; if (!results.isEmpty()) { result = results.get(0); - } + } return result; } @Override public E findContainsProperties(String propertyName, - Collection<?> values, Object... others) throws TopiaException { + Collection<?> values, Object... others) throws TopiaException { Map<String, Collection<?>> properties = new HashMap<String, Collection<?>>(); properties.put(propertyName, values); Object name = null; @@ -451,19 +456,18 @@ } /** - * Find all entities with a specific rule : - * When the entity have a Collection type property, you want to find all - * entites where some values are contained in the collection type property. - * Example entity parameter : private Collection<Date> historicalDates; - * You want some dates to be contained in historicalDates. - * Collection<Date> myDates... - * myDates.add(date1) ... - * Map<String, Collection> properties = new HashMap<String,Collection>(); - * properties.put("historicalDates",myDates); + * Find all entities with a specific rule : When the entity have a + * Collection type property, you want to find all entites where some values + * are contained in the collection type property. Example entity parameter : + * private Collection<Date> historicalDates; You want some dates to be + * contained in historicalDates. Collection<Date> myDates... + * myDates.add(date1) ... Map<String, Collection> properties = new + * HashMap<String,Collection>(); properties.put("historicalDates",myDates); * findAllContainsProperties(properties); + * * @param properties * @return the list of entities corresponding to the request - * @throws TopiaException if any pb + * @throws TopiaException if any pb */ @Override public List<E> findAllContainsProperties(Map<String, @@ -521,7 +525,7 @@ @Override public List<E> findAllContainsProperties(String propertyName, - Collection<?> values, Object... others) throws TopiaException { + Collection<?> values, Object... others) throws TopiaException { Map<String, Collection<?>> properties = new HashMap<String, Collection<?>>(); properties.put(propertyName, values); Object name = null; @@ -580,12 +584,12 @@ @Override public void addTopiaEntityListener(TopiaEntityListener listener) { - getContext().addTopiaEntityListener(entityClass,listener); + getContext().addTopiaEntityListener(entityClass, listener); } @Override public void addTopiaEntityVetoable(TopiaEntityVetoable vetoable) { - getContext().addTopiaEntityVetoable(entityClass,vetoable); + getContext().addTopiaEntityVetoable(entityClass, vetoable); } @Override @@ -619,9 +623,9 @@ } /** - * Cette methode appelle fireVetoableCreate et fireOnCreated - * Si vous la surchargé, faites attention a appeler le super - * ou a appeler vous aussi ces deux methodes. + * Cette methode appelle fireVetoableCreate et fireOnCreated Si vous la + * surchargé, faites attention a appeler le super ou a appeler vous aussi + * ces deux methodes. */ @Override public E create(Map<String, Object> properties) throws TopiaException { @@ -732,7 +736,7 @@ throws TopiaException { return query.executeToEntityMap(context, getEntityClass(), keyName, keyClass); - } + } @Override public List<E> findAllWithOrder(String... propertyNames) @@ -758,9 +762,8 @@ } /** - * Count number of existing entities using - * {@link TopiaQuery#executeCount(TopiaContext) } - * FIXME-FD20091224 change type to int like in 2.2.2 version + * Count number of existing entities using {@link TopiaQuery#executeCount(TopiaContext) + * } FIXME-FD20091224 change type to int like in 2.2.2 version * * @return a long for the number of entities in database */ @@ -874,6 +877,7 @@ /** * TODO-TC20100225 Should this method deprecated (it is never used ?) * Renvoie un Criteria créé avec l'entityClass + * * @param mode le FlushMode du Criteria * @return le Criteria nouvellement créé * @throws TopiaException if any pb @@ -886,6 +890,7 @@ /** * Renvoie la Session contenue dans le contexte + * * @return hibernate session * @throws TopiaException if any pb */ Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -58,6 +58,7 @@ * d'entité si cela ne pose pas d'autre probleme (heritage entre ces entités). * * @author poussin <poussin@codelutin.com> + * @ version $Id$ */ public abstract class TopiaEntityAbstract implements TopiaEntity, Serializable { @@ -189,7 +190,7 @@ */ @Override public int hashCode() { - Date date = getTopiaCreateDate(); + Date date = getCreateDate(); //TC-20100220 : il se peut que la date de creation soit nulle // lorsque l'entite est utilise comme objet d'edition d'un formulaire // par exemple... @@ -208,16 +209,14 @@ if (this == obj) { return true; } - //TC-20100220 : test farfeulu :) - //if (obj instanceof TopiaEntity == false) { if (!(obj instanceof TopiaEntity)) { return false; } TopiaEntity other = (TopiaEntity) obj; - if (getTopiaId() == null || other.getId() == null) { + if (getId() == null || other.getId() == null) { return false; } - boolean result = getTopiaId().equals(other.getId()); + boolean result = getId().equals(other.getId()); return result; } Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityEnum.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -43,6 +43,7 @@ * - a method to accept any TopiaEntity class for this entity description * * @author tchemit <chemit@codelutin.com> + * @version $Id$ * @since 2.2.0 */ public interface TopiaEntityEnum { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaId.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaId.java 2010-05-08 11:11:15 UTC (rev 1939) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaId.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -38,16 +38,23 @@ package org.nuiton.topia.persistence; +import org.nuiton.topia.TopiaNotFoundException; + import java.io.Serializable; import java.util.logging.Level; import java.util.logging.Logger; -import org.nuiton.topia.TopiaNotFoundException; - /** -* Classe representant un Id, utilisable par JDO. Cette classe contient aussi un -* ensemble de methode static utile pour la manipulation des topiaId -*/ + * TODO-fdesbois-20100508 : Need translation of javadoc. + * + * Classe representant un Id, utilisable par JDO. Cette classe contient aussi un ensemble de methode + * static utile pour la manipulation des topiaId + * + * @author poussin <poussing@codelutin.com> + * @author tchemit <tchemit@codelutin.com> + * @author chatellier <chatellier@codelutin.com> + * @version $Id$ + */ public class TopiaId implements Serializable { // TopiaId /** */ @@ -84,11 +91,11 @@ } /** - * Cree un topiaId pour une certaine classe - * - * @param clazz + * Cree un topiaId pour une certaine classe + * + * @param clazz * @return a generated topiaId - */ + */ public static String create(Class clazz) { if (!clazz.isInterface()) { throw new IllegalArgumentException( @@ -104,10 +111,10 @@ /** * Extrait la classe du topiaId. - * - * @param topiaId + * + * @param topiaId * @return class - * @throws TopiaNotFoundException + * @throws TopiaNotFoundException */ public static Class getClassName(String topiaId) throws TopiaNotFoundException { @@ -122,9 +129,9 @@ } /** - * Return class name id topiaId is id, and empty string if topiaId is - * not an id. - * + * Return class name id topiaId is id, and empty string if topiaId is not an + * id. + * * @param topiaId * @return class name */ @@ -138,13 +145,13 @@ } /** - * Verifie si l'id passé en paramètre est bien un Id topia, c-a-d si la - * forme est bien classname#timemillis#random et si le classname est - * celui d'une classe valide, c-a-d que le systeme arrive a trouver. - * - * @param topiaId + * Verifie si l'id passé en paramètre est bien un Id topia, c-a-d si la + * forme est bien classname#timemillis#random et si le classname est celui + * d'une classe valide, c-a-d que le systeme arrive a trouver. + * + * @param topiaId * @return is valid topiaId - */ + */ public static boolean isValidId(String topiaId) { try { if (topiaId.matches(".*?#[0-9]+#[0-9.]+")) { Added: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java (rev 0) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java 2010-05-08 16:05:12 UTC (rev 1940) @@ -0,0 +1,13 @@ +/** + * This package contains interfaces and abstract classes for entities and daos. + * <p /> + * For daos : {@link TopiaDAO} as interface and {@link TopiaDAImpl} as + * implementation. + * <p /> + * For entities : {@link TopiaEntity} as interface and {@link + * TopiaEntityAbstract} as abstract class inherited by generated entities for + * final applications. Generation is done using transformers from {@code + * org.nuiton.topia.generator} package. + * + */ +package org.nuiton.topia.persistence; \ No newline at end of file Property changes on: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL