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
.List
;
16 import java
.util
.UUID
;
18 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
19 import org
.eclipse
.swt
.widgets
.Display
;
21 import eu
.etaxonomy
.cdm
.api
.service
.IAgentService
;
22 import eu
.etaxonomy
.cdm
.api
.service
.IGroupService
;
23 import eu
.etaxonomy
.cdm
.api
.service
.INameService
;
24 import eu
.etaxonomy
.cdm
.api
.service
.IOccurrenceService
;
25 import eu
.etaxonomy
.cdm
.api
.service
.IReferenceService
;
26 import eu
.etaxonomy
.cdm
.api
.service
.IService
;
27 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonService
;
28 import eu
.etaxonomy
.cdm
.api
.service
.IUserService
;
29 import eu
.etaxonomy
.cdm
.api
.service
.config
.IFindTaxaAndNamesConfigurator
;
30 import eu
.etaxonomy
.cdm
.api
.service
.config
.IIdentifiableEntityServiceConfigurator
;
31 import eu
.etaxonomy
.cdm
.model
.agent
.AgentBase
;
32 import eu
.etaxonomy
.cdm
.model
.agent
.TeamOrPersonBase
;
33 import eu
.etaxonomy
.cdm
.model
.common
.Group
;
34 import eu
.etaxonomy
.cdm
.model
.common
.ICdmBase
;
35 import eu
.etaxonomy
.cdm
.model
.common
.IdentifiableEntity
;
36 import eu
.etaxonomy
.cdm
.model
.common
.RelationshipBase
;
37 import eu
.etaxonomy
.cdm
.model
.common
.User
;
38 import eu
.etaxonomy
.cdm
.model
.name
.NameRelationship
;
39 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
40 import eu
.etaxonomy
.cdm
.model
.occurrence
.DerivedUnit
;
41 import eu
.etaxonomy
.cdm
.model
.occurrence
.FieldUnit
;
42 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
43 import eu
.etaxonomy
.cdm
.model
.reference
.Reference
;
44 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
45 import eu
.etaxonomy
.cdm
.persistence
.dto
.UuidAndTitleCache
;
46 import eu
.etaxonomy
.taxeditor
.preference
.IPreferenceKeys
;
47 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
51 * @created Dec 8, 2010
54 public class SearchManager
{
56 public static final List NO_RESULTS
= Arrays
.asList(new Object
[]{});
58 public static final String WILDCARD
= "*";
60 public static int NO_COUNT
= -1;
62 // TODO make this configurable via preferences
63 private static final int MAX_RESULTS_BEFORE_WARNING
= 500;
65 public List
<TaxonNameBase
> findNames(IIdentifiableEntityServiceConfigurator configurator
){
66 if(checkLargeResult(CdmStore
.getService(INameService
.class).countByTitle(configurator
))){
67 List
<TaxonNameBase
> records
= CdmStore
.getService(INameService
.class).findByTitle(configurator
).getRecords();
68 addUuidSearchResults(records
, configurator
, INameService
.class);
74 public List
<NameRelationship
> findNameRelationships(
75 IIdentifiableEntityServiceConfigurator configurator
) {
77 //if activated again remember to add uuid search results like in other searches
81 List
<NameRelationship
> relationships
= new ArrayList
<NameRelationship
>();
82 List
<RelationshipBase
> all
= CdmStore
.getService(INameService
.class).getAllRelationships(0, 0);
84 for (RelationshipBase relationship
: all
){
85 if(relationship
instanceof NameRelationship
){
86 relationships
.add((NameRelationship
) relationship
);
92 public List
<UuidAndTitleCache
<IdentifiableEntity
>> findTaxaAndNames(IFindTaxaAndNamesConfigurator
<TaxonBase
> configurator
){
93 return CdmStore
.getService(ITaxonService
.class).findTaxaAndNamesForEditor(configurator
);
96 public List
<Reference
> findReferences(IIdentifiableEntityServiceConfigurator configurator
){
97 if(checkLargeResult(CdmStore
.getService(IReferenceService
.class).countByTitle(configurator
))){
98 List
<Reference
> records
= CdmStore
.getService(IReferenceService
.class).findByTitle(configurator
).getRecords();
99 addUuidSearchResults(records
, configurator
, IReferenceService
.class);
105 public List
<AgentBase
> findAgents(IIdentifiableEntityServiceConfigurator configurator
){
106 if(checkLargeResult(CdmStore
.getService(IAgentService
.class).countByTitle(configurator
))){
107 List
<AgentBase
> records
= CdmStore
.getService(IAgentService
.class).findByTitle(configurator
).getRecords();
108 addUuidSearchResults(records
, configurator
, IAgentService
.class);
115 * Check search string if it is a {@link UUID} and, if <code>true</code>, search for the corresponding entity.
116 * @param records the list to which the search results are added
117 * @param configurator the configurator holding the search string
118 * @param service the service to use for searching
120 private <T
extends ICdmBase
> void addUuidSearchResults(List
<T
> records
, IIdentifiableEntityServiceConfigurator configurator
, Class
<?
extends IService
<T
>> service
) {
121 String titleSearchString
= configurator
.getTitleSearchString();
123 UUID uuid
= UUID
.fromString(titleSearchString
);
124 records
.add(CdmStore
.getService(service
).find(uuid
));
125 } catch (IllegalArgumentException e
) {
126 //search string was no UUID
130 @SuppressWarnings("unchecked")
131 public List
<TeamOrPersonBase
> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator
){
132 configurator
.setClazz(TeamOrPersonBase
.class);
133 return (List
)findAgents(configurator
);
137 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
138 * {@link IIdentifiableEntityServiceConfigurator}<br>
140 * Note: FieldUnits are omitted by default. See {@link #findOccurrences(IIdentifiableEntityServiceConfigurator, boolean)}
142 * @param configurator the configurator to use for the search
143 * @return a list of the SpecimenOrObservationBases matching the search parameters found
145 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator configurator
){
146 // by default we do not show field units. This may be configured via preferences
147 return findOccurrences(configurator
, PreferencesUtil
.getPreferenceStore().getBoolean(IPreferenceKeys
.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS
));
152 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
153 * {@link IIdentifiableEntityServiceConfigurator}
155 * @param configurator the configurator to use for the search
156 * @return a list of the SpecimenOrObservationBases found
157 * @param showFieldUnits if <code>true</code> then also FieldUnits are searched
160 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator
<SpecimenOrObservationBase
> configurator
, boolean showFieldUnits
){
161 List
<SpecimenOrObservationBase
> records
= new ArrayList
<SpecimenOrObservationBase
>();
162 if(configurator
.getClazz()==null){
164 configurator
.setClazz(SpecimenOrObservationBase
.class);
167 configurator
.setClazz(DerivedUnit
.class);
170 if(configurator
.getClazz().equals(SpecimenOrObservationBase
.class)){
171 //get FieldUnits + DerivedUnits
172 configurator
.setClazz(DerivedUnit
.class);
173 int derivedUnitCount
= CdmStore
.getService(IOccurrenceService
.class).countOccurrences(configurator
);
174 configurator
.setClazz(FieldUnit
.class);
175 int fieldUnitCount
= CdmStore
.getService(IOccurrenceService
.class).countOccurrences(configurator
);
177 if(checkLargeResult(derivedUnitCount
+fieldUnitCount
)){
178 configurator
.setClazz(DerivedUnit
.class);
179 records
.addAll(CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords());
180 configurator
.setClazz(FieldUnit
.class);
181 records
.addAll(CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords());
185 else if(checkLargeResult(CdmStore
.getService(IOccurrenceService
.class).countOccurrences(configurator
))){
186 records
= CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords();
188 addUuidSearchResults(records
, configurator
, IOccurrenceService
.class);
192 public List
<User
> findUsers(IIdentifiableEntityServiceConfigurator configurator
){
193 String userNameSearchString
= sqlizeTitleSearchString(configurator
);
194 // TODO why are users not identifiable entities?
195 List
<User
> records
= CdmStore
.getService(IUserService
.class).listByUsername(userNameSearchString
, null, null, null, null, null, null);
196 addUuidSearchResults(records
, configurator
, IUserService
.class);
201 public List
<Group
> findGroups(IIdentifiableEntityServiceConfigurator configurator
){
202 String groupNameSearchString
= sqlizeTitleSearchString(configurator
);
203 // TODO why are groups not identifiable entities?
204 List
<Group
> records
= CdmStore
.getService(IGroupService
.class).listByName(groupNameSearchString
, null, null, null, null, null, null);
205 addUuidSearchResults(records
, configurator
, IGroupService
.class);
210 private boolean checkLargeResult(int count
) {
211 if(count
> MAX_RESULTS_BEFORE_WARNING
){
212 return MessageDialog
.openConfirm(Display
.getDefault().getActiveShell(), "Large result expected",
213 String
.format("The current search will return %s objects. This will " +
214 "take a long time and/or might render the editor unusable. Please consider refining your search.", count
));
220 private String
sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator
){
221 return configurator
.getTitleSearchString().replace(WILDCARD
, "%");
224 public List
findTaxa(IIdentifiableEntityServiceConfigurator configurator
) {
225 if(checkLargeResult(CdmStore
.getService(ITaxonService
.class).countByTitle(configurator
))){
226 List
<TaxonBase
> records
= CdmStore
.getService(ITaxonService
.class).findByTitle(configurator
).getRecords();
227 addUuidSearchResults(records
, configurator
, ITaxonService
.class);