Revision c55c6773
Added by Patrick Plitzner over 10 years ago
- added javadoc
eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/campanula/specimenSearch/SpecimenSearchController.java | ||
---|---|---|
13 | 13 |
import org.eclipse.swt.widgets.Composite; |
14 | 14 |
|
15 | 15 |
/** |
16 |
* Controller class for handling a {@link SpecimenSearchComposite}. |
|
16 | 17 |
* @author pplitzner |
17 | 18 |
* @date 03.09.2013 |
18 | 19 |
* |
19 | 20 |
*/ |
20 | 21 |
public class SpecimenSearchController { |
21 | 22 |
|
22 |
private SpecimenSearchComposite specimenSearchComposite; |
|
23 |
private final SpecimenSearchComposite specimenSearchComposite;
|
|
23 | 24 |
|
24 | 25 |
/** |
25 | 26 |
* @param specimenSearchComposite |
... | ... | |
28 | 29 |
this.specimenSearchComposite = new SpecimenSearchComposite(parent, SWT.NONE); |
29 | 30 |
} |
30 | 31 |
|
32 |
/** |
|
33 |
* Returns the {@link Composite} handled by this controller |
|
34 |
* @return |
|
35 |
*/ |
|
31 | 36 |
public Composite getComposite() { |
32 | 37 |
return specimenSearchComposite; |
33 | 38 |
} |
34 | 39 |
|
35 | 40 |
/** |
36 |
* @return |
|
41 |
* Returns the taxon name entered in the search view |
|
42 |
* @return the taxon name as a {@link String} |
|
37 | 43 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextTaxonName() |
38 | 44 |
*/ |
39 | 45 |
public String getTaxonName() { |
... | ... | |
41 | 47 |
} |
42 | 48 |
|
43 | 49 |
/** |
44 |
* @return |
|
50 |
* Returns the collector entered in the search view |
|
51 |
* @return the collector as a {@link String} |
|
45 | 52 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextCollector() |
46 | 53 |
*/ |
47 | 54 |
public String getCollector() { |
... | ... | |
49 | 56 |
} |
50 | 57 |
|
51 | 58 |
/** |
52 |
* @return |
|
59 |
* Returns the collecting number entered in the search view |
|
60 |
* @return the collecting as a {@link String} |
|
53 | 61 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextCollectorNumber() |
54 | 62 |
*/ |
55 | 63 |
public String getCollectorNumber() { |
... | ... | |
57 | 65 |
} |
58 | 66 |
|
59 | 67 |
/** |
60 |
* @return |
|
68 |
* Returns the accession number entered in the search view |
|
69 |
* @return the accession number as a {@link String} |
|
61 | 70 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextAccessionNumber() |
62 | 71 |
*/ |
63 | 72 |
public String getAccessionNumber() { |
... | ... | |
65 | 74 |
} |
66 | 75 |
|
67 | 76 |
/** |
68 |
* @return |
|
77 |
* Returns the herbarium entered in the search view |
|
78 |
* @return the herbarium as a {@link String} |
|
69 | 79 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getComboHerbarium() |
70 | 80 |
*/ |
71 | 81 |
public String getHerbarium() { |
... | ... | |
74 | 84 |
} |
75 | 85 |
|
76 | 86 |
/** |
77 |
* @return |
|
87 |
* Returns the country entered in the search view |
|
88 |
* @return the country as a {@link String} |
|
78 | 89 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getComboCountry() |
79 | 90 |
*/ |
80 | 91 |
public String getCountry() { |
... | ... | |
83 | 94 |
} |
84 | 95 |
|
85 | 96 |
/** |
86 |
* @return |
|
97 |
* Returns the locality entered in the search view |
|
98 |
* @return the locality as a {@link String} |
|
87 | 99 |
* @see eu.etaxonomy.taxeditor.ui.campanula.specimenSearch.SpecimenSearchComposite#getTextLocality() |
88 | 100 |
*/ |
89 | 101 |
public String getLocality() { |
90 | 102 |
return specimenSearchComposite.getTextLocality().getText(); |
91 | 103 |
} |
92 | 104 |
|
93 |
} |
|
105 |
} |
Also available in: Unified diff