Project

General

Profile

« Previous | Next » 

Revision 3be6ef3e

Added by Niels Hoffmann over 13 years ago

performed javacscript:fix and worked on documentation

View differences:

taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/store/TermStore.java
53 53
 * All terms may be accessed through this store.
54 54
 * Note: This is for internal use. When using vocabularies in the UI, try to use the preferred terms from
55 55
 * PreferenceUtil
56
 * 
56
 *
57 57
 * @author n.hoffmann
58 58
 * @created 25.06.2009
59 59
 * @version 1.0
......
61 61
public class TermStore {
62 62
	
63 63
	/**
64
	 * 
65
	 * @return
64
	 * <p>getSpecimenTypeDesignationStatus</p>
65
	 *
66
	 * @return a {@link java.util.List} object.
66 67
	 */
67 68
	public static List<SpecimenTypeDesignationStatus> getSpecimenTypeDesignationStatus() {
68 69
		return getTerms(SpecimenTypeDesignationStatus.class);
......
70 71
	
71 72

  
72 73
	/**
73
	*
74
	* @return
75
	*/
74
	 * <p>getNameTypeDesignationStatus</p>
75
	 *
76
	 * @return a {@link java.util.List} object.
77
	 */
76 78
	public static List<NameTypeDesignationStatus> getNameTypeDesignationStatus() {
77 79
		return getTerms(NameTypeDesignationStatus.class);
78 80
	}
79 81
	
80 82
	/**
81
	 * 
82
	 * @return
83
	 * <p>getNamedAreaTypes</p>
84
	 *
85
	 * @return a {@link java.util.List} object.
83 86
	 */
84 87
	public static List<NamedAreaType> getNamedAreaTypes(){
85 88
		return getTerms(NamedAreaType.class);
86 89
	}
87 90
	
88 91
	/**
89
	 * 
90
	 * @return
92
	 * <p>getAnnotationTypes</p>
93
	 *
94
	 * @return a {@link java.util.List} object.
91 95
	 */
92 96
	public static List<AnnotationType> getAnnotationTypes(){
93 97
		return getTerms(AnnotationType.class);
94 98
	}
95 99
	
96 100
	/**
97
	 * 
98
	 * @return
101
	 * <p>getTaxonRelationshipTypes</p>
102
	 *
103
	 * @return a {@link java.util.List} object.
99 104
	 */
100 105
	public static List<TaxonRelationshipType> getTaxonRelationshipTypes(){
101 106
		return getTerms(TaxonRelationshipType.class);
......
103 108
	
104 109
	
105 110
	/**
106
	 * 
107
	 * @return
111
	 * <p>getLanguages</p>
112
	 *
113
	 * @return a {@link java.util.List} object.
108 114
	 */
109 115
	public static List<Language> getLanguages(){
110 116
		return getTerms(Language.class);
111 117
	}
112 118
	
113 119
	/**
114
	 * 
115
	 * @return
120
	 * <p>getFeatures</p>
121
	 *
122
	 * @return a {@link java.util.List} object.
116 123
	 */
117 124
	public static List<Feature> getFeatures() {
118 125
		List<Feature> features = getTerms(Feature.class);
......
122 129
	}
123 130
	
124 131
	/**
125
	 * 
126
	 * @return
132
	 * <p>getNameRelationshipTypes</p>
133
	 *
134
	 * @return a {@link java.util.List} object.
127 135
	 */
128 136
	public static List<NameRelationshipType> getNameRelationshipTypes() {
129 137
		return getTerms(NameRelationshipType.class);
130 138
	}
131 139
	
132 140
	/**
133
	 * 
134
	 * @return
141
	 * <p>getNomenclaturalStatusTypes</p>
142
	 *
143
	 * @return a {@link java.util.List} object.
135 144
	 */
136 145
	public static List<NomenclaturalStatusType> getNomenclaturalStatusTypes(){
137 146
		return getTerms(NomenclaturalStatusType.class);
......
139 148
	
140 149

  
141 150
	/**
142
	 * @return 
143
	 * 
151
	 * <p>getNonTechnicalMarkerTypes</p>
152
	 *
153
	 * @return a {@link java.util.List} object.
144 154
	 */
145 155
	public static List<MarkerType> getNonTechnicalMarkerTypes() {
146 156
		List<MarkerType> nonTechnicalMarkerTypes = new ArrayList<MarkerType>();
......
157 167
	
158 168

  
159 169
	/**
160
	 * @return
170
	 * <p>getExtensionTypes</p>
171
	 *
172
	 * @return a {@link java.util.List} object.
161 173
	 */
162 174
	public static List<ExtensionType> getExtensionTypes() {
163 175
		return getTerms(ExtensionType.class);
164 176
	}
165 177
	
166 178
	/**
167
	 * @return
179
	 * <p>getRightsTypes</p>
180
	 *
181
	 * @return a {@link java.util.List} object.
168 182
	 */
169 183
	public static List<RightsTerm> getRightsTypes() {
170 184
		return getTerms(RightsTerm.class);
......
173 187
	
174 188
	/**
175 189
	 * Retrieve all ranks from data store.
176
	 * 
177
	 * @return
190
	 *
191
	 * @return a {@link java.util.List} object.
178 192
	 */
179 193
	public static List<Rank> getRanks(){
180 194
		if(PreferencesUtil.getSortRanksHierarchichally()){
......
194 208
	
195 209
	/**
196 210
	 * Retrieve all presence and absence terms from data store.
197
	 *  
198
	 * @return
211
	 *
212
	 * @return a {@link java.util.List} object.
199 213
	 */
200 214
	public static List<PresenceAbsenceTermBase> getPresenceAbsenceTerms() {
201 215
		List presenceAbsenceTerms = getTerms(PresenceTerm.class);
......
206 220

  
207 221
	/**
208 222
	 * Retrieve all stages from data store.
209
	 * 
210
	 * @return
223
	 *
224
	 * @return a {@link java.util.List} object.
211 225
	 */
212 226
	public static List<Stage> getStages(){
213 227
		return getTerms(Stage.class);
......
215 229
	
216 230
	/**
217 231
	 * Retrieve all states from data store.
218
	 * 
219
	 * @return
232
	 *
233
	 * @return a {@link java.util.List} object.
220 234
	 */
221 235
	public static List<State> getStates() {
222 236
		return getTerms(State.class);
......
224 238
	
225 239
	/**
226 240
	 * Retrieve all preservation methods from data store.
227
	 * 
228
	 * @return
241
	 *
242
	 * @return a {@link java.util.List} object.
229 243
	 */
230 244
	public static List<PreservationMethod> getPreservationMethods(){
231 245
		return getTerms(PreservationMethod.class);
......
233 247
	
234 248
	
235 249

  
250
	/**
251
	 * <p>getMeasurementUnits</p>
252
	 *
253
	 * @return a {@link java.util.List} object.
254
	 */
236 255
	public static List<MeasurementUnit> getMeasurementUnits() {
237 256
		return getTerms(MeasurementUnit.class);
238 257
	}
239 258
	
240 259

  
260
	/**
261
	 * <p>getModifiers</p>
262
	 *
263
	 * @return a {@link java.util.List} object.
264
	 */
241 265
	public static List<Modifier> getModifiers() {
242 266
		return getTerms(Modifier.class);
243 267
	}
244 268

  
245 269

  
270
	/**
271
	 * <p>getStatisticalMeasures</p>
272
	 *
273
	 * @return a {@link java.util.List} object.
274
	 */
246 275
	public static List<StatisticalMeasure> getStatisticalMeasures() {
247 276
		return getTerms(StatisticalMeasure.class);
248 277
	}
249 278
	
279
	/**
280
	 * <p>getScopes</p>
281
	 *
282
	 * @return a {@link java.util.List} object.
283
	 */
250 284
	public static List<Scope> getScopes() {
251 285
		return getTerms(Scope.class);
252 286
	}
253 287
	
254 288
	/**
255
	 * @return
289
	 * <p>getDeterminationModifiers</p>
290
	 *
291
	 * @return a {@link java.util.List} object.
256 292
	 */
257 293
	public static List<DeterminationModifier> getDeterminationModifiers() {
258 294
		return getTerms(DeterminationModifier.class);
259 295
	}
260 296
	
261 297
	/**
262
	 * @return
298
	 * <p>getReferenceSystems</p>
299
	 *
300
	 * @return a {@link java.util.List} object.
263 301
	 */
264 302
	public static List<ReferenceSystem> getReferenceSystems() {
265 303
		return getTerms(ReferenceSystem.class);
266 304
	}
267 305
	
268
	/*************** save methods ******************************/
269
	
306
	/**
307
	 ************* save methods *****************************
308
	 *
309
	 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
310
	 */
270 311
	public static void saveTerm(DefinedTermBase term){
271 312
		getTermService().saveOrUpdate(term);
272 313
	}
273 314
	
274 315
	/**
275
	 * @param selected
316
	 * <p>delete</p>
317
	 *
318
	 * @param selected a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
276 319
	 */
277 320
	public static void delete(DefinedTermBase selected) {
278 321
		getTermService().delete(selected);
......
280 323
	
281 324
	/**
282 325
	 * Save a vacabulary to data store
283
	 * 
284
	 * @param feature
326
	 *
327
	 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
285 328
	 */
286 329
	public static void updateVocabulary(DefinedTermBase term) {
287 330
		getTermService().saveOrUpdate(term);
......
300 343
 		return HibernateProxyHelper.deproxy(vocabulary, OrderedTermVocabulary.class);
301 344
	}
302 345
	
346
	/**
347
	 * <p>getTermVocabulary</p>
348
	 *
349
	 * @param vocabularyType a {@link eu.etaxonomy.cdm.model.common.VocabularyEnum} object.
350
	 * @return a {@link eu.etaxonomy.cdm.model.common.TermVocabulary} object.
351
	 */
303 352
	public static TermVocabulary<DefinedTermBase> getTermVocabulary(VocabularyEnum vocabularyType){
304 353
		
305 354
		return CdmStore.getVocabularyService().getVocabulary(vocabularyType);

Also available in: Unified diff