3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
11 package eu
.etaxonomy
.taxeditor
.store
;
13 import java
.util
.ArrayList
;
14 import java
.util
.Arrays
;
15 import java
.util
.Collections
;
16 import java
.util
.Comparator
;
17 import java
.util
.HashSet
;
18 import java
.util
.List
;
21 import eu
.etaxonomy
.cdm
.api
.service
.ITermService
;
22 import eu
.etaxonomy
.cdm
.api
.service
.exception
.ReferencedObjectUndeletableException
;
23 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
24 import eu
.etaxonomy
.cdm
.model
.common
.MarkerType
;
25 import eu
.etaxonomy
.cdm
.model
.common
.TermType
;
26 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
27 import eu
.etaxonomy
.cdm
.model
.description
.Feature
;
28 import eu
.etaxonomy
.cdm
.model
.description
.PresenceAbsenceTerm
;
29 import eu
.etaxonomy
.cdm
.model
.name
.Rank
;
30 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationshipType
;
31 import eu
.etaxonomy
.taxeditor
.model
.DefaultTermComparator
;
32 import eu
.etaxonomy
.taxeditor
.model
.TaxonRelationshipTypeInverseContainer
;
33 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
36 * All terms may be accessed through this store.
37 * Note: This is for internal use. When using vocabularies in the UI, try to use the preferred terms from
44 public class TermStore
{
47 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given type currently available in the system.
49 * @param clazz a class that inherits from {@link DefinedTermBase}
50 * @return an alphabetically sorted list of terms
52 public static <TERM
extends DefinedTermBase
> List
<TERM
> getTerms(Class
<TERM
> clazz
){
53 return getTerms(clazz
, null, true);
57 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given {@link TermType})
58 * currently available in the system.
60 * @param termType the term type
61 * @return an alphabetically sorted list of terms
63 public static List
<DefinedTermBase
<?
>> getTerms(TermType termType
, Comparator
<DefinedTermBase
<?
>> comparator
){
64 return getTermsFromService(termType
, comparator
);
68 * Returns an alphabetically sorted list of terms (anything that extends {@link DefinedTermBase}) of the given {@link TermType})
69 * currently available in the system.
71 * @param termType the term type
72 * @return an alphabetically sorted list of terms
74 public static <TERM
extends DefinedTermBase
> Set
<TERM
> getTerms(TermVocabulary
<TERM
> termVocabulary
, Comparator
<DefinedTermBase
<?
>> comparator
){
75 return termVocabulary
.getTerms();
79 * Returns a list of terms of the given type currently available in the system.
80 * If <code>filtered</code> is set to <code>true</code>, all terms for certain types will be
81 * gathered from edge cases.
83 * @param clazz a class that inherits from {@link DefinedTermBase}
84 * @param comparator a {@link Comparator} that defines the sorting algorithm. If set to null, {@link DefaultTermComparator} will be used
85 * @param filtered if set to true, some terms are filtered from the result (according to definition in {@link ITermStoreEdgeCase}s)
86 * @return a sorted list of terms
88 public static <TERM
extends DefinedTermBase
> List
<TERM
> getTerms(Class
<TERM
> clazz
, Comparator
<TERM
> comparator
, boolean filtered
){
89 List
<TERM
> terms
= new ArrayList
<TERM
>();
91 ITermStoreEdgeCase
<TERM
> edgeCase
= getEdgeCase(clazz
);
92 if(filtered
&& edgeCase
!= null){
93 terms
= edgeCase
.getTerms();
95 terms
= getTermsFromService(clazz
, comparator
);
108 private static List
<DefinedTermBase
<?
>> getTermsFromService(TermType termType
, Comparator
<DefinedTermBase
<?
>> comparator
){
109 if (comparator
== null){
110 comparator
= new DefaultTermComparator
<DefinedTermBase
<?
>>();
113 List
<DefinedTermBase
<?
>> terms
= CdmStore
.getService(ITermService
.class).listByTermType(termType
, null, null, null, null);
114 Collections
.sort(terms
, comparator
);
124 private static <T
extends DefinedTermBase
> List
<T
> getTermsFromService(Class
<T
> termClass
, Comparator
<T
> comparator
){
125 if (comparator
== null){
126 comparator
= new DefaultTermComparator
<T
>();
129 List
<T
> terms
= CdmStore
.getService(ITermService
.class).list(termClass
, null, null, null, null);
130 Collections
.sort(terms
, comparator
);
135 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
137 public static void saveTerm(DefinedTermBase term
){
138 CdmStore
.getService(ITermService
.class).saveOrUpdate(term
);
144 * @param selected a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
145 * @throws ReferencedObjectUndeletableException
147 public static void delete(DefinedTermBase selected
) throws ReferencedObjectUndeletableException
{
148 CdmStore
.getService(ITermService
.class).delete(selected
);
152 * Save a vacabulary to data store
154 * @param term a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
156 public static void updateVocabulary(DefinedTermBase term
) {
157 CdmStore
.getService(ITermService
.class).saveOrUpdate(term
);
161 * Handingling of special cases
164 private static Set
<ITermStoreEdgeCase
<?
extends DefinedTermBase
>> termStoreEdgeCases
= new HashSet
<ITermStoreEdgeCase
<?
extends DefinedTermBase
>>();
167 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<Feature
>() {
170 public Class
<Feature
> getTermClass() {
171 return Feature
.class;
175 public List
<Feature
> getTerms() {
176 List
<Feature
> features
= TermStore
.getTermsFromService(Feature
.class, null);
177 features
.remove(Feature
.IMAGE());
181 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<MarkerType
>(){
184 public Class
<MarkerType
> getTermClass() {
185 return MarkerType
.class;
189 public List
<MarkerType
> getTerms() {
190 // filter out non technical markers
191 List
<MarkerType
> nonTechnicalMarkerTypes
= new ArrayList
<MarkerType
>();
192 List
<MarkerType
> markerTypes
= TermStore
.getTermsFromService(MarkerType
.class, null);
194 for (Object type
: markerTypes
) {
195 if (((MarkerType
) type
).isTechnical() == false) {
196 nonTechnicalMarkerTypes
.add((MarkerType
) type
);
200 return nonTechnicalMarkerTypes
;
204 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<Rank
>() {
207 public Class
<Rank
> getTermClass() {
212 public List
<Rank
> getTerms() {
213 if(PreferencesUtil
.getSortRanksHierarchichally()){
214 return TermStore
.getTermsFromService(Rank
.class, new Comparator
<Rank
>(){
217 public int compare(Rank o1
, Rank o2
) {
218 return o1
.compareTo(o2
);
223 return TermStore
.getTermsFromService(Rank
.class, null);
228 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<PresenceAbsenceTerm
>() {
231 public Class
<PresenceAbsenceTerm
> getTermClass() {
232 return PresenceAbsenceTerm
.class;
236 public List
<PresenceAbsenceTerm
> getTerms() {
237 List
<PresenceAbsenceTerm
> presenceAbsenceTerms
= TermStore
.getTermsFromService(PresenceAbsenceTerm
.class, null);
239 return presenceAbsenceTerms
;
242 termStoreEdgeCases
.add(new ITermStoreEdgeCase
<TaxonRelationshipTypeInverseContainer
>() {
245 public Class
<TaxonRelationshipTypeInverseContainer
> getTermClass() {
246 return TaxonRelationshipTypeInverseContainer
.class;
250 public List
<TaxonRelationshipTypeInverseContainer
> getTerms() {
251 List
<TaxonRelationshipType
> excludeTaxonRelationshipTypes
= Arrays
.asList(new TaxonRelationshipType
[]{
252 TaxonRelationshipType
.TAXONOMICALLY_INCLUDED_IN(),
253 TaxonRelationshipType
.MISAPPLIED_NAME_FOR(),
254 TaxonRelationshipType
.ALL_RELATIONSHIPS()
257 List
<TaxonRelationshipTypeInverseContainer
> relationshipTypeInverseContainers
= new ArrayList
<TaxonRelationshipTypeInverseContainer
>();
259 List
<TaxonRelationshipType
> relationshipTypes
= TermStore
.getTerms(TaxonRelationshipType
.class);
261 relationshipTypes
.removeAll(excludeTaxonRelationshipTypes
);
263 for (TaxonRelationshipType relationshipType
: relationshipTypes
){
264 if(!relationshipType
.isSymmetric()){
265 TaxonRelationshipTypeInverseContainer inverseContainer
= new TaxonRelationshipTypeInverseContainer(relationshipType
, true);
266 relationshipTypeInverseContainers
.add(inverseContainer
);
268 TaxonRelationshipTypeInverseContainer container
= new TaxonRelationshipTypeInverseContainer(relationshipType
, false);
269 relationshipTypeInverseContainers
.add(container
);
272 return relationshipTypeInverseContainers
;
277 private static <T
extends DefinedTermBase
> ITermStoreEdgeCase
<T
> getEdgeCase(Class
<T
> termClass
) {
279 for (ITermStoreEdgeCase termStoreEdgeCase
: termStoreEdgeCases
){
280 if (termStoreEdgeCase
.getTermClass().equals(termClass
)){
281 return termStoreEdgeCase
;
288 private interface ITermStoreEdgeCase
<TERM
> {
290 public abstract Class
<TERM
> getTermClass();
292 public abstract List
<TERM
> getTerms();