From c55c67734316128e17cbbc4e2eb3b7975776f01c Mon Sep 17 00:00:00 2001 From: Patric Plitzner Date: Mon, 30 Sep 2013 07:29:33 +0000 Subject: [PATCH] - added javadoc --- .../wizard/SpecimenSearchWizard.java | 3 +- .../wizard/SpecimenSearchWizardPage.java | 5 ++-- .../SpecimenSearchController.java | 30 +++++++++++++------ 3 files changed, 25 insertions(+), 13 deletions(-) diff --git a/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizard.java b/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizard.java index 5b4c1b777..1402193a8 100644 --- a/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizard.java +++ b/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizard.java @@ -23,7 +23,7 @@ import eu.etaxonomy.taxeditor.dataimport.DataImportEditor; import eu.etaxonomy.taxeditor.dataimport.DataImportSpecimenEditorInput; /** - * + * Wizard for querying BioCASe provider. * @author pplitzner * @date 11.09.2013 * @@ -78,6 +78,7 @@ public class SpecimenSearchWizard extends Wizard implements IImportWizard { } /** + * Return a {@link BioCaseQuery} with the parameters entered in the wizard * @return the query */ public BioCaseQuery getQuery() { diff --git a/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizardPage.java b/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizardPage.java index 3596add13..080c85ffd 100644 --- a/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizardPage.java +++ b/eu.etaxonomy.taxeditor.bulkeditor/src/main/java/eu/etaxonomy/taxeditor/dataimport/wizard/SpecimenSearchWizardPage.java @@ -17,6 +17,7 @@ import eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchControll /** + * Wizard page for entering search parameters * @author pplitzner * @date 12.09.2013 * @@ -25,9 +26,6 @@ public class SpecimenSearchWizardPage extends WizardPage{ private SpecimenSearchController specimenSearchController; - /** - * @param pageName - */ protected SpecimenSearchWizardPage(String pageName) { super(pageName); } @@ -42,6 +40,7 @@ public class SpecimenSearchWizardPage extends WizardPage{ } /** + * Returns a {@link BioCaseQuery} filled with the parameters defined in this wizard page * @return */ public BioCaseQuery getQuery() { diff --git a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/campanula/specimenSearch/SpecimenSearchController.java b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/campanula/specimenSearch/SpecimenSearchController.java index eaec9af32..1355384bc 100644 --- a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/campanula/specimenSearch/SpecimenSearchController.java +++ b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/campanula/specimenSearch/SpecimenSearchController.java @@ -13,13 +13,14 @@ import org.eclipse.swt.SWT; import org.eclipse.swt.widgets.Composite; /** + * Controller class for handling a {@link SpecimenSearchComposite}. * @author pplitzner * @date 03.09.2013 * */ public class SpecimenSearchController { - private SpecimenSearchComposite specimenSearchComposite; + private final SpecimenSearchComposite specimenSearchComposite; /** * @param specimenSearchComposite @@ -28,12 +29,17 @@ public class SpecimenSearchController { this.specimenSearchComposite = new SpecimenSearchComposite(parent, SWT.NONE); } + /** + * Returns the {@link Composite} handled by this controller + * @return + */ public Composite getComposite() { return specimenSearchComposite; } /** - * @return + * Returns the taxon name entered in the search view + * @return the taxon name as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextTaxonName() */ public String getTaxonName() { @@ -41,7 +47,8 @@ public class SpecimenSearchController { } /** - * @return + * Returns the collector entered in the search view + * @return the collector as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextCollector() */ public String getCollector() { @@ -49,7 +56,8 @@ public class SpecimenSearchController { } /** - * @return + * Returns the collecting number entered in the search view + * @return the collecting as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextCollectorNumber() */ public String getCollectorNumber() { @@ -57,7 +65,8 @@ public class SpecimenSearchController { } /** - * @return + * Returns the accession number entered in the search view + * @return the accession number as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextAccessionNumber() */ public String getAccessionNumber() { @@ -65,7 +74,8 @@ public class SpecimenSearchController { } /** - * @return + * Returns the herbarium entered in the search view + * @return the herbarium as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getComboHerbarium() */ public String getHerbarium() { @@ -74,7 +84,8 @@ public class SpecimenSearchController { } /** - * @return + * Returns the country entered in the search view + * @return the country as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getComboCountry() */ public String getCountry() { @@ -83,11 +94,12 @@ public class SpecimenSearchController { } /** - * @return + * Returns the locality entered in the search view + * @return the locality as a {@link String} * @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextLocality() */ public String getLocality() { return specimenSearchComposite.getTextLocality().getText(); } -} +} \ No newline at end of file -- 2.34.1