2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.store
;
12 import java
.util
.ArrayList
;
13 import java
.util
.Arrays
;
14 import java
.util
.Collections
;
15 import java
.util
.Comparator
;
16 import java
.util
.HashSet
;
17 import java
.util
.List
;
20 import eu
.etaxonomy
.cdm
.api
.service
.ITermService
;
21 import eu
.etaxonomy
.cdm
.api
.service
.exception
.ReferencedObjectUndeletableException
;
22 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
23 import eu
.etaxonomy
.cdm
.model
.common
.MarkerType
;
24 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
25 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
26 import eu
.etaxonomy
.cdm
.model
.description
.Feature
;
27 import eu
.etaxonomy
.cdm
.model
.description
.PresenceAbsenceTerm
;
28 import eu
.etaxonomy
.cdm
.model
.name
.Rank
;
29 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationshipType
;
30 import eu
.etaxonomy
.taxeditor
.model
.DefaultTermComparator
;
31 import eu
.etaxonomy
.taxeditor
.model
.TaxonRelationshipTypeInverseContainer
;
32 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
35 * All terms may be accessed through this store.
36 * Note: This is for internal use. When using vocabularies in the UI, try to use the preferred terms from
43 public class TermStore
{
46 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given type currently available in the system.
48 * @param clazz a class that inherits from {@link DefinedTermBase}
49 * @return an alphabetically sorted list of terms
51 public static <TERM
extends DefinedTermBase
> List
<TERM
> getTerms(Class
<TERM
> clazz
){
52 return getTerms(clazz
, null, true);
56 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given {@link TermType})
57 * currently available in the system.
59 * @param termType the term type
60 * @return an alphabetically sorted list of terms
62 public static <TERM
extends DefinedTermBase
> List
<TERM
> getTerms(TermType termType
, Comparator
<TERM
> comparator
){
63 return getTermsFromService(termType
, comparator
);
67 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given {@link TermType})
68 * currently available in the system.
70 * @param termType the term type
71 * @return an alphabetically sorted list of terms
73 public static <TERM
extends DefinedTermBase
> Set
<TERM
> getTerms(TermVocabulary
<TERM
> termVocabulary
, Comparator
<DefinedTermBase
<?
>> comparator
){
74 return termVocabulary
.getTerms();
78 * Returns a list of terms of the given type currently available in the system.
79 * If <code>filtered</code> is set to <code>true</code>, all terms for certain types will be
80 * gathered from edge cases.
82 * @param clazz a class that inherits from {@link DefinedTermBase}
83 * @param comparator a {@link Comparator} that defines the sorting algorithm. If set to null, {@link DefaultTermComparator} will be used
84 * @param filtered if set to true, some terms are filtered from the result (according to definition in {@link ITermStoreEdgeCase}s)
85 * @return a sorted list of terms
87 public static <TERM
extends DefinedTermBase
> List
<TERM
> getTerms(Class
<TERM
> clazz
, Comparator
<TERM
> comparator
, boolean filtered
){
88 List
<TERM
> terms
= new ArrayList
<TERM
>();
90 ITermStoreEdgeCase
<TERM
> edgeCase
= getEdgeCase(clazz
);
91 if(filtered
&& edgeCase
!= null){
92 terms
= edgeCase
.getTerms();
94 terms
= getTermsFromService(clazz
, comparator
);
107 private static <T
extends DefinedTermBase
> List
<T
> getTermsFromService(TermType termType
, Comparator
<T
> comparator
){
108 if (comparator
== null){
109 comparator
= new DefaultTermComparator
<T
>();
112 List
<T
> terms
= CdmStore
.getService(ITermService
.class).listByTermType(termType
, null, null, null, null);
113 Collections
.sort(terms
, comparator
);
123 private static <T
extends DefinedTermBase
> List
<T
> getTermsFromService(Class
<T
> termClass
, Comparator
<T
> comparator
){
124 if (comparator
== null){
125 comparator
= new DefaultTermComparator
<T
>();
128 List
<T
> terms
= CdmStore
.getService(ITermService
.class).list(termClass
, null, null, null, null);
129 Collections
.sort(terms
, comparator
);
134 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
136 public static void saveTerm(DefinedTermBase term
){
137 CdmStore
.getService(ITermService
.class).saveOrUpdate(term
);
143 * @param selected a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
144 * @throws ReferencedObjectUndeletableException
146 public static void delete(DefinedTermBase selected
) throws ReferencedObjectUndeletableException
{
147 CdmStore
.getService(ITermService
.class).delete(selected
);
151 * Save a vacabulary to data store
153 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
155 public static void updateVocabulary(DefinedTermBase term
) {
156 CdmStore
.getService(ITermService
.class).saveOrUpdate(term
);
160 * Handingling of special cases
163 private static Set
<ITermStoreEdgeCase
<?
extends DefinedTermBase
>> termStoreEdgeCases
= new HashSet
<ITermStoreEdgeCase
<?
extends DefinedTermBase
>>();
166 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<Feature
>() {
169 public Class
<Feature
> getTermClass() {
170 return Feature
.class;
174 public List
<Feature
> getTerms() {
175 List
<Feature
> features
= TermStore
.getTermsFromService(Feature
.class, null);
176 features
.remove(Feature
.IMAGE());
180 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<MarkerType
>(){
183 public Class
<MarkerType
> getTermClass() {
184 return MarkerType
.class;
188 public List
<MarkerType
> getTerms() {
189 // filter out non technical markers
190 List
<MarkerType
> nonTechnicalMarkerTypes
= new ArrayList
<MarkerType
>();
191 List
<MarkerType
> markerTypes
= TermStore
.getTermsFromService(MarkerType
.class, null);
193 for (Object type
: markerTypes
) {
194 if (((MarkerType
) type
).isTechnical() == false) {
195 nonTechnicalMarkerTypes
.add((MarkerType
) type
);
199 return nonTechnicalMarkerTypes
;
203 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<Rank
>() {
206 public Class
<Rank
> getTermClass() {
211 public List
<Rank
> getTerms() {
212 if(PreferencesUtil
.getSortRanksHierarchichally()){
213 return TermStore
.getTermsFromService(Rank
.class, new Comparator
<Rank
>(){
216 public int compare(Rank o1
, Rank o2
) {
217 return o1
.compareTo(o2
);
222 return TermStore
.getTermsFromService(Rank
.class, null);
227 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<PresenceAbsenceTerm
>() {
230 public Class
<PresenceAbsenceTerm
> getTermClass() {
231 return PresenceAbsenceTerm
.class;
235 public List
<PresenceAbsenceTerm
> getTerms() {
236 List
<PresenceAbsenceTerm
> presenceAbsenceTerms
= TermStore
.getTermsFromService(PresenceAbsenceTerm
.class, null);
238 return presenceAbsenceTerms
;
241 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<TaxonRelationshipTypeInverseContainer
>() {
244 public Class
<TaxonRelationshipTypeInverseContainer
> getTermClass() {
245 return TaxonRelationshipTypeInverseContainer
.class;
249 public List
<TaxonRelationshipTypeInverseContainer
> getTerms() {
250 List
<TaxonRelationshipType
> excludeTaxonRelationshipTypes
= Arrays
.asList(new TaxonRelationshipType
[]{
251 TaxonRelationshipType
.TAXONOMICALLY_INCLUDED_IN(),
252 TaxonRelationshipType
.MISAPPLIED_NAME_FOR(),
253 TaxonRelationshipType
.ALL_RELATIONSHIPS()
256 List
<TaxonRelationshipTypeInverseContainer
> relationshipTypeInverseContainers
= new ArrayList
<TaxonRelationshipTypeInverseContainer
>();
258 List
<TaxonRelationshipType
> relationshipTypes
= TermStore
.getTerms(TaxonRelationshipType
.class);
260 relationshipTypes
.removeAll(excludeTaxonRelationshipTypes
);
262 for (TaxonRelationshipType relationshipType
: relationshipTypes
){
263 if(!relationshipType
.isSymmetric()){
264 TaxonRelationshipTypeInverseContainer inverseContainer
= new TaxonRelationshipTypeInverseContainer(relationshipType
, true);
265 relationshipTypeInverseContainers
.add(inverseContainer
);
267 TaxonRelationshipTypeInverseContainer container
= new TaxonRelationshipTypeInverseContainer(relationshipType
, false);
268 relationshipTypeInverseContainers
.add(container
);
271 return relationshipTypeInverseContainers
;
276 private static <T
extends DefinedTermBase
> ITermStoreEdgeCase
<T
> getEdgeCase(Class
<T
> termClass
) {
278 for (ITermStoreEdgeCase termStoreEdgeCase
: termStoreEdgeCases
){
279 if (termStoreEdgeCase
.getTermClass().equals(termClass
)){
280 return termStoreEdgeCase
;
287 private interface ITermStoreEdgeCase
<TERM
> {
289 public abstract Class
<TERM
> getTermClass();
291 public abstract List
<TERM
> getTerms();