Author: echatellier Date: 2013-02-05 18:09:49 +0100 (Tue, 05 Feb 2013) New Revision: 74 Url: http://forge.codelutin.com/projects/cantharella/repository/revisions/74 Log: Fix missing javadoc. Modified: trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/dao/impl/MoleculeDao.java trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/Molecule.java trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/MoleculeProvenance.java trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/MoleculeServiceImpl.java trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/SearchServiceImpl.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ListMoleculesPage.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ManageMoleculePage.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ReadMoleculePage.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/search/SearchPage.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeEditorBehavior.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeViewBehavior.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/BooleanPropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/CsvWriter.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/DecimalPropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/EnumPropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportablePropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportableTextFilteredPropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/LinkPropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/MapValuePropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ShortDatePropertyColumn.java trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/links/CsvExportLink.java Modified: trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/dao/impl/MoleculeDao.java =================================================================== --- trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/dao/impl/MoleculeDao.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/dao/impl/MoleculeDao.java 2013-02-05 17:09:49 UTC (rev 74) @@ -37,7 +37,7 @@ */ public final class MoleculeDao extends AbstractModelDao { - /** Criteria : différents programmes des campagnes déjà saisis */ + /** Criteria : différents organismes des molécules déjà saisis */ public static final DetachedCriteria CRITERIA_DISTINCT_MOLECULE_ORGANISMES = DetachedCriteria .forClass(Molecule.class).setProjection(Projections.distinct(Projections.property("identifieePar"))) .addOrder(Order.asc("identifieePar")); Modified: trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/Molecule.java =================================================================== --- trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/Molecule.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/Molecule.java 2013-02-05 17:09:49 UTC (rev 74) @@ -56,6 +56,11 @@ import org.hibernate.validator.constraints.Length; import org.hibernate.validator.constraints.NotEmpty; +/** + * Molecule entity. + * + * @author Eric Chatellier + */ @Entity @Indexed @FullTextFilterDefs( { @@ -106,6 +111,7 @@ /** Est-ce une nouvelle molécule ? */ private boolean nouvMolecul; + /** Campagne. */ @ManyToOne(fetch = FetchType.EAGER) @IndexedEmbedded(depth=1) private Campagne campagne; @@ -137,6 +143,8 @@ private List<MoleculeProvenance> provenances; /** + * Id molecule getter. + * * @return the idMolecule */ public Integer getIdMolecule() { @@ -144,6 +152,8 @@ } /** + * Id molecule setter. + * * @param idMolecule the idMolecule to set */ public void setIdMolecule(Integer idMolecule) { @@ -151,6 +161,8 @@ } /** + * Nom commun getter. + * * @return the nomCommun */ public String getNomCommun() { @@ -158,6 +170,8 @@ } /** + * Nom commun getter. + * * @param nomCommun the nomCommun to set */ public void setNomCommun(String nomCommun) { @@ -165,6 +179,8 @@ } /** + * Famille chimique getter. + * * @return the familleChimique */ public String getFamilleChimique() { @@ -172,6 +188,8 @@ } /** + * Famille chimique setter. + * * @param familleChimique the familleChimique to set */ public void setFamilleChimique(String familleChimique) { @@ -179,6 +197,8 @@ } /** + * Fomule dev mol getter. + * * @return the formuleDevMol */ public String getFormuleDevMol() { @@ -186,6 +206,8 @@ } /** + * Formule dev mol setter. + * * @param formuleDevMol the formuleDevMol to set */ public void setFormuleDevMol(String formuleDevMol) { @@ -193,6 +215,8 @@ } /** + * Nom iupca getter. + * * @return the nomIupca */ public String getNomIupca() { @@ -200,6 +224,8 @@ } /** + * Nom iupca setter. + * * @param nomIupca the nomIupca to set */ public void setNomIupca(String nomIupca) { @@ -207,6 +233,8 @@ } /** + * Formule brute getter. + * * @return the formuleBrute */ public String getFormuleBrute() { @@ -214,6 +242,8 @@ } /** + * Formule brute setter. + * * @param formuleBrute the formuleBrute to set */ public void setFormuleBrute(String formuleBrute) { @@ -221,6 +251,8 @@ } /** + * Masse molaire getter. + * * @return the masseMolaire */ public BigDecimal getMasseMolaire() { @@ -228,6 +260,8 @@ } /** + * Masse molaire setter. + * * @param masseMolaire the masseMolaire to set */ public void setMasseMolaire(BigDecimal masseMolaire) { @@ -235,6 +269,8 @@ } /** + * Nouv molecule getter. + * * @return the nouvMolecul */ public boolean isNouvMolecul() { @@ -242,6 +278,8 @@ } /** + * Nouv molecule setter. + * * @param nouvMolecul the nouvMolecul to set */ public void setNouvMolecul(boolean nouvMolecul) { @@ -249,6 +287,8 @@ } /** + * Campagne getter. + * * @return the campagne */ public Campagne getCampagne() { @@ -256,6 +296,8 @@ } /** + * Campagne setter. + * * @param campagne the campagne to set */ public void setCampagne(Campagne campagne) { @@ -263,6 +305,8 @@ } /** + * Identifiee par getter. + * * @return the identifieePar */ public String getIdentifieePar() { @@ -270,6 +314,8 @@ } /** + * Identifiee par setter. + * * @param identifieePar the identifieePar to set */ public void setIdentifieePar(String identifieePar) { @@ -277,6 +323,8 @@ } /** + * Publi origine getter. + * * @return the publiOrigine */ public String getPubliOrigine() { @@ -284,6 +332,8 @@ } /** + * Publi origine setter. + * * @param publiOrigine the publiOrigine to set */ public void setPubliOrigine(String publiOrigine) { @@ -291,6 +341,8 @@ } /** + * Complement getter. + * * @return the complement */ public String getComplement() { @@ -298,6 +350,8 @@ } /** + * Complement setter. + * * @param complement the complement to set */ public void setComplement(String complement) { @@ -305,6 +359,8 @@ } /** + * Createur getter. + * * @return the createur */ public Personne getCreateur() { @@ -312,6 +368,8 @@ } /** + * Createur setter. + * * @param createur the createur to set */ public void setCreateur(Personne createur) { @@ -319,6 +377,8 @@ } /** + * Provenances getter. + * * @return the provenances */ public List<MoleculeProvenance> getProvenances() { @@ -326,6 +386,8 @@ } /** + * Provenances setter. + * * @param provenances the provenances to set */ public void setProvenances(List<MoleculeProvenance> provenances) { Modified: trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/MoleculeProvenance.java =================================================================== --- trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/MoleculeProvenance.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.data/src/main/java/nc/ird/cantharella/data/model/MoleculeProvenance.java 2013-02-05 17:09:49 UTC (rev 74) @@ -37,6 +37,11 @@ import nc.ird.cantharella.data.config.DataContext; import nc.ird.cantharella.data.model.utils.AbstractModel; +/** + * MoleculeProvenance association entity between {@link Molecule} and {@Produit}. + * + * @author Eric Chatellier + */ @Entity public class MoleculeProvenance extends AbstractModel implements Cloneable { @@ -62,6 +67,8 @@ private Produit produit; /** + * Id getter. + * * @return the id */ public Integer getId() { @@ -69,6 +76,8 @@ } /** + * Id setter. + * * @param id the id to set */ public void setId(Integer id) { @@ -76,6 +85,8 @@ } /** + * Pourcentage getter. + * * @return the pourcentage */ public BigDecimal getPourcentage() { @@ -83,6 +94,8 @@ } /** + * Pourcentage setter. + * * @param pourcentage the pourcentage to set */ public void setPourcentage(BigDecimal pourcentage) { @@ -90,6 +103,8 @@ } /** + * Molecule getter. + * * @return the molecule */ public Molecule getMolecule() { @@ -97,6 +112,8 @@ } /** + * Molecule setter. + * * @param molecule the molecule to set */ public void setMolecule(Molecule molecule) { @@ -104,6 +121,8 @@ } /** + * Produit getter. + * * @return the produit */ public Produit getProduit() { @@ -111,6 +130,8 @@ } /** + * Produit setter. + * * @param produit the produit to set */ public void setProduit(Produit produit) { Modified: trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/MoleculeServiceImpl.java =================================================================== --- trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/MoleculeServiceImpl.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/MoleculeServiceImpl.java 2013-02-05 17:09:49 UTC (rev 74) @@ -55,11 +55,13 @@ @Autowired private GenericDao dao; + /** {@inheritDoc} */ @Override public long countMolecules() { return dao.count(Molecule.class); } + /** {@inheritDoc} */ @Override public void createMolecule(Molecule molecule) throws DataConstraintException { @@ -67,6 +69,7 @@ dao.create(molecule); } + /** {@inheritDoc} */ @Override public void deleteMolecule(Molecule molecule) throws DataConstraintException { @@ -78,19 +81,21 @@ LOG.error(e.getMessage(), e); throw new UnexpectedException(e); } - } + /** {@inheritDoc} */ @Override public List<Molecule> listMolecules() { return dao.readList(Molecule.class, "idMolecule"); } + /** {@inheritDoc} */ @Override public Molecule loadMolecule(Integer numero) throws DataNotFoundException { return dao.read(Molecule.class, numero); } + /** {@inheritDoc} */ @Override public void updateMolecule(Molecule molecule) throws DataConstraintException { @@ -101,9 +106,9 @@ LOG.error(e.getMessage(), e); throw new UnexpectedException(e); } - } + /** {@inheritDoc} */ @Override public boolean updateOrdeleteMoleculeEnabled(Molecule molecule, Utilisateur utilisateur) { return utilisateur.getTypeDroit() == TypeDroit.ADMINISTRATEUR Modified: trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/SearchServiceImpl.java =================================================================== --- trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/SearchServiceImpl.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.service/src/main/java/nc/ird/cantharella/service/services/impl/SearchServiceImpl.java 2013-02-05 17:09:49 UTC (rev 74) @@ -69,9 +69,11 @@ /** Logger */ private static final Logger LOG = LoggerFactory.getLogger(SearchServiceImpl.class); + /** Hibernate session factory. */ @Resource private SessionFactory sessionFactory; + /** {@inheritDoc} */ @Override public void reIndex() { long before = System.currentTimeMillis(); @@ -96,6 +98,7 @@ } } + /** {@inheritDoc} */ @Override @SuppressWarnings("unchecked") public SearchResult search(String strQuery, Utilisateur utilisateur) { @@ -149,6 +152,17 @@ return result; } + /** + * Prepare hibernate query with lucene query implementation to + * search for query string on specified single type. + * + * @param fullTextSession search session + * @param clazz type + * @param strQuery query string + * @param utilisateur user + * @return hibernate query implemented by lucene query + * @throws ParseException + */ protected org.hibernate.Query getQuery(FullTextSession fullTextSession, Class<?> clazz, String strQuery, Utilisateur utilisateur) throws ParseException { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ListMoleculesPage.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ListMoleculesPage.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ListMoleculesPage.java 2013-02-05 17:09:49 UTC (rev 74) @@ -58,7 +58,7 @@ import org.apache.wicket.spring.injection.annot.SpringBean; /** - * Liste des molécules. + * Molecules list page. * * @author Eric Chatellier */ @@ -69,6 +69,9 @@ @SpringBean private MoleculeService moleculeService; + /** + * Constructor. + */ public ListMoleculesPage() { super(ListMoleculesPage.class); Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ManageMoleculePage.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ManageMoleculePage.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ManageMoleculePage.java 2013-02-05 17:09:49 UTC (rev 74) @@ -84,7 +84,7 @@ import org.apache.wicket.spring.injection.annot.SpringBean; /** - * Gestion des molecules. + * Manage molecule page. * * @author Eric Chatellier */ @@ -134,12 +134,12 @@ /** Page appelante */ private final CallerPage callerPage; - + /** Bouton d'ajout d'une provenance **/ - Button addProvenanceButton; + protected Button addProvenanceButton; /** - * Constructeur (mode création) + * Constructeur (mode création). * @param callerPage Page appelante * @param multipleEntry Saisie multiple */ Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ReadMoleculePage.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ReadMoleculePage.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/molecule/ReadMoleculePage.java 2013-02-05 17:09:49 UTC (rev 74) @@ -88,6 +88,12 @@ /** Page appelante */ private final CallerPage callerPage; + /** + * Constructor with molecule id to render. + * + * @param idMolecule molecul id + * @param callerPage caller page + */ public ReadMoleculePage(Integer idMolecule, final CallerPage callerPage) { super(ReadMoleculePage.class); this.callerPage = callerPage; Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/search/SearchPage.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/search/SearchPage.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/pages/domain/search/SearchPage.java 2013-02-05 17:09:49 UTC (rev 74) @@ -89,26 +89,27 @@ import org.apache.wicket.util.value.ValueMap; /** - * Resultat de page de recherche. + * Search results page. * * @author echatellier */ @AuthRoles({ AuthRole.ADMIN, AuthRole.USER }) public class SearchPage extends TemplatePage { + /** Form query. */ protected String query; + /** Search service. */ @SpringBean protected SearchService searchService; - /** - * Nombre d'extraits affichés dans la colonne de résumés des extraits - */ + /** Nombre d'extraits affichés dans la colonne de résumés des extraits. */ private static int MAX_EXTRAITS_DISPLAY = 4; /** - * Constructeur. - * @param query + * Constructor. + * + * @param query form query */ public SearchPage(String query) { super(SearchPage.class); @@ -116,7 +117,7 @@ final CallerPage currentPage = new CallerPage(ListSpecimensPage.class); // ca sert a rien, mais wicket est pas content - ExternalLink link = new ExternalLink("advancedLink", "http://lucene.apache.org/core/3_6_1/queryparsersyntax.html"); + ExternalLink link = new ExternalLink("advancedLink", "http://lucene.apache.org/core/3_6_2/queryparsersyntax.html"); add(link); // search form @@ -140,14 +141,21 @@ addMoleculesTable(currentPage, searchResult); } + /** + * Get current form query value. + * + * @return form query value + */ public String getQuery() { return query; } - public void setQuery(String query) { - this.query = query; - } - + /** + * Format specimens result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addSpecimensTable(final CallerPage currentPage, SearchResult searchResult) { // search result : specimens List<Specimen> specimens = searchResult.getSpecimens(); @@ -197,7 +205,13 @@ add(specimensDataTable); add(new CsvExportLink("SearchPage.Specimens.ExportCSV", specimensDataTable, "specimens.csv")); } - + + /** + * Format lots result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addLotsTable(final CallerPage currentPage, SearchResult searchResult) { // search result : lots List<Lot> lots = searchResult.getLots(); @@ -278,7 +292,13 @@ add(lotsDataTable); add(new CsvExportLink("SearchPage.Lots.ExportCSV", lotsDataTable, "lots.csv")); } - + + /** + * Format extractions result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addExtractionsTable(final CallerPage currentPage, SearchResult searchResult) { // search result : extractions List<Extraction> extractions = searchResult.getExtractions(); @@ -373,6 +393,12 @@ add(new CsvExportLink("SearchPage.Extractions.ExportCSV", extractionsDataTable, "extractions.csv")); } + /** + * Format purification result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addPurificationsTable(final CallerPage currentPage, SearchResult searchResult) { List<Purification> purifications = searchResult.getPurifications(); LoadableDetachableSortableListDataProvider<Purification> purificationsDataProvider = new LoadableDetachableSortableListDataProvider<Purification>( @@ -438,6 +464,12 @@ add(new CsvExportLink("SearchPage.Purifications.ExportCSV", purificationsDataTable, "purifications.csv")); } + /** + * Format testBios result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addTestBiosTable(final CallerPage currentPage, SearchResult searchResult) { List<ResultatTestBio> resultatTestBios = searchResult.getResultatTestBios(); LoadableDetachableSortableListDataProvider<ResultatTestBio> resTestBiosDataProvider = new LoadableDetachableSortableListDataProvider<ResultatTestBio>( @@ -521,7 +553,13 @@ add(new CsvExportLink("SearchPage.ResultatTestBios.ExportCSV", resTestBiosDataTable, "testbios.csv")); } - + + /** + * Format stations result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addStationsTable(final CallerPage currentPage, SearchResult searchResult) { // Liste des stations @@ -566,7 +604,13 @@ add(stationsDataTable); add(new CsvExportLink("SearchPage.Stations.ExportCSV", stationsDataTable, "stations.csv")); } - + + /** + * Format molécules result into table. + * + * @param currentPage current page + * @param searchResult search results + */ protected void addMoleculesTable(final CallerPage currentPage, SearchResult searchResult) { // Liste des molecules Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeEditorBehavior.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeEditorBehavior.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeEditorBehavior.java 2013-02-05 17:09:49 UTC (rev 74) @@ -4,7 +4,7 @@ * $Id:$ * $HeadURL:$ * %% - * Copyright (C) 2009 - 2012 IRD (Institut de Recherche pour le Developpement) and by respective authors (see below) + * Copyright (C) 2009 - 2013 IRD (Institut de Recherche pour le Developpement) and by respective authors (see below) * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -41,12 +41,16 @@ */ public class MoleculeEditorBehavior extends AttributeModifier { - private static final long serialVersionUID = 1L; - + /** + * Constructor. + * + * @param replaceModel replace model + */ public MoleculeEditorBehavior(IModel<?> replaceModel) { super("formula", replaceModel); } - + + /** {@inheritDoc} */ @Override protected String newValue(String currentValue, String replacementValue) { // on ajoute toujours un premier caractere pour oblige l'existance de @@ -54,6 +58,7 @@ return "." + replacementValue; } + /** {@inheritDoc} */ @Override public void renderHead(Component component, IHeaderResponse response) { response.renderCSSReference("ChemDoodleWeb/css/ChemDoodleWeb.css"); @@ -66,6 +71,7 @@ response.renderJavaScriptReference("js/moleditor.js"); } + /** {@inheritDoc} */ @Override public void beforeRender(Component component) { // il faut que l'element HTML est forcement un identifiant pour pouvoir @@ -73,6 +79,7 @@ component.setOutputMarkupId(true); } + /** {@inheritDoc} */ @Override public void afterRender(Component component) { Response response = component.getResponse(); Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeViewBehavior.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeViewBehavior.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/behaviors/MoleculeViewBehavior.java 2013-02-05 17:09:49 UTC (rev 74) @@ -4,7 +4,7 @@ * $Id:$ * $HeadURL:$ * %% - * Copyright (C) 2009 - 2012 IRD (Institut de Recherche pour le Developpement) and by respective authors (see below) + * Copyright (C) 2009 - 2013 IRD (Institut de Recherche pour le Developpement) and by respective authors (see below) * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -41,12 +41,16 @@ */ public class MoleculeViewBehavior extends AttributeModifier { - private static final long serialVersionUID = 1L; - + /** + * Constructor. + * + * @param replaceModel replace model + */ public MoleculeViewBehavior(IModel<?> replaceModel) { super("formula", replaceModel); } + /** {@inheritDoc} */ @Override protected String newValue(String currentValue, String replacementValue) { // on ajoute toujours un premier caractere pour oblige l'existance de @@ -54,6 +58,7 @@ return "." + replacementValue; } + /** {@inheritDoc} */ @Override public void renderHead(Component component, IHeaderResponse response) { response.renderCSSReference("ChemDoodleWeb/css/ChemDoodleWeb.css"); @@ -63,6 +68,7 @@ response.renderJavaScriptReference("js/molviewer.js"); } + /** {@inheritDoc} */ @Override public void beforeRender(Component component) { // il faut que l'element HTML est forcement un identifiant pour pouvoir @@ -70,6 +76,7 @@ component.setOutputMarkupId(true); } + /** {@inheritDoc} */ @Override public void afterRender(Component component) { Response response = component.getResponse(); Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/BooleanPropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/BooleanPropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/BooleanPropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -66,11 +66,13 @@ page))); } + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = new DisplayBooleanPropertyModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/CsvWriter.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/CsvWriter.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/CsvWriter.java 2013-02-05 17:09:49 UTC (rev 74) @@ -31,15 +31,33 @@ * @author echatellier */ public class CsvWriter { + + /** Output writer. */ private final PrintWriter out; + + /** First column flag. */ private boolean first = true; + + /** Csv separator. */ private char separator; + /** + * Constructor. + * + * @param os output stream + * @param separator csv separator + */ public CsvWriter(OutputStream os, char separator) { out = new PrintWriter(os); this.separator = separator; } + /** + * Write simple column data. + * + * @param value value to write + * @return {@code this} + */ public CsvWriter write(Object value) { if (!first) { out.append(separator); @@ -54,17 +72,30 @@ return this; } + /** + * End current line. + * + * @return {@code this} + */ public CsvWriter endLine() { out.append("\r\n"); first = true; return this; } + /** + * Flush output stream. + * + * @return {@code this} + */ public CsvWriter flush() { out.flush(); return this; } + /** + * Close output stream. + */ public void close() { out.close(); } Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/DecimalPropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/DecimalPropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/DecimalPropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -72,12 +72,14 @@ cellItem.add(new Label(componentId, new DisplayDecimalPropertyModel(rowModel.getObject(), propertyExpression, format, locale))); } - + + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = new DisplayDecimalPropertyModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/EnumPropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/EnumPropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/EnumPropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -66,11 +66,13 @@ new DisplayEnumPropertyModel(rowModel.getObject(), propertyExpression, page))); } + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = new DisplayEnumPropertyModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportablePropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportablePropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportablePropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -36,15 +36,24 @@ public class ExportablePropertyColumn<T> extends PropertyColumn<T> implements ExportableColumn<T> { + /** + * Constructor. + * + * @param displayModel display model + * @param sortProperty wicket sort property + * @param propertyExpression wicket sort expression + */ public ExportablePropertyColumn(IModel<String> displayModel, String sortProperty, String propertyExpression) { super(displayModel, sortProperty, propertyExpression); } + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = createLabelModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportableTextFilteredPropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportableTextFilteredPropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ExportableTextFilteredPropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -36,16 +36,25 @@ */ public class ExportableTextFilteredPropertyColumn<T, F> extends TextFilteredPropertyColumn<T, F> implements ExportableColumn<T> { + /** + * Constructor. + * + * @param displayModel display model + * @param sortProperty wicket sort property + * @param propertyExpression wicket sort expression + */ public ExportableTextFilteredPropertyColumn(IModel<String> displayModel, String sortProperty, String propertyExpression) { super(displayModel, sortProperty, propertyExpression); } + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = createLabelModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/LinkPropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/LinkPropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/LinkPropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -171,12 +171,14 @@ link.add(new Label("label", tmpLabelModel)); } } - + + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = createLabelModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/MapValuePropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/MapValuePropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/MapValuePropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -68,11 +68,13 @@ propertyExpression, map))); } + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = new DisplayMapValuePropertyModel<U>(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ShortDatePropertyColumn.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ShortDatePropertyColumn.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/columns/ShortDatePropertyColumn.java 2013-02-05 17:09:49 UTC (rev 74) @@ -66,12 +66,14 @@ cellItem.add(new Label(componentId, new DisplayShortDatePropertyModel(rowModel.getObject(), propertyExpression, locale))); } - + + /** {@inheritDoc} */ @Override public String getHeaderName() { return getDisplayModel().getObject().toString(); } + /** {@inheritDoc} */ @Override public void exportCsv(final T object, CsvWriter writer) { IModel<?> textModel = new DisplayShortDatePropertyModel(new AbstractReadOnlyModel<T>() { Modified: trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/links/CsvExportLink.java =================================================================== --- trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/links/CsvExportLink.java 2013-02-04 11:06:26 UTC (rev 73) +++ trunk/cantharella.web/src/main/java/nc/ird/cantharella/web/utils/links/CsvExportLink.java 2013-02-05 17:09:49 UTC (rev 74) @@ -39,6 +39,12 @@ import org.apache.wicket.markup.html.link.Link; import org.apache.wicket.request.http.WebResponse; +/** + * Link used to export associated table into csv file. + * + * @author Eric Chatellier + * @param <T> datatable type + */ public class CsvExportLink<T> extends Link<Void> { /** For serializable methods */ @@ -47,17 +53,28 @@ /** Date format for download filename. */ private static final DateFormat FILENAME_DF = new SimpleDateFormat("yyyy_MM_dd-HH_mm-"); - + /** Data table containing data to export. */ private final DataTable<T> table; + /** Download filename. */ private final String filename; + /** + * Constructor. + * + * @param id wicket id + * @param table data table + * @param filename csv filename + */ public CsvExportLink(String id, DataTable<T> table, String filename) { super(id); this.table = table; this.filename = filename; } + /** + * Link clic event. + */ @Override public void onClick() { WebResponse response = (WebResponse) getResponse(); @@ -98,6 +115,11 @@ writer.close(); } + /** + * Get list of only {@link ExportableColumn} of datatable columns. + * + * @return exportable column list + */ @SuppressWarnings("unchecked") private List<ExportableColumn<T>> getExportableColumns() { List<ExportableColumn<T>> exportable = new ArrayList<ExportableColumn<T>>(table.getColumns().size());