- added javadoc

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 5b4c1b777614c1c350a5cf82fc5420f1906de5bc..1402193a866f164e3fc4fc033cb14a58aa7526c9 100644 (file)
--- 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 3596add137f94cd90ead9052549a033672364b6a..080c85ffd1a53b9df64341c69f3704bbe50a6961 100644 (file)
--- 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 eaec9af328c18ee45bb9ae7a2328f85ebce4b047..1355384bcbe15cdfcf76a2e8e8591e2228a64a38 100644 (file)
--- 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