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
.SpecimenOrObservationBase
;
41 import eu
.etaxonomy
.cdm
.model
.reference
.Reference
;
42 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
43 import eu
.etaxonomy
.cdm
.persistence
.dto
.UuidAndTitleCache
;
44 import eu
.etaxonomy
.taxeditor
.preference
.IPreferenceKeys
;
45 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
49 * @created Dec 8, 2010
52 public class SearchManager
{
54 public static final List NO_RESULTS
= Arrays
.asList(new Object
[]{});
56 public static final String WILDCARD
= "*";
58 public static int NO_COUNT
= -1;
60 // TODO make this configurable via preferences
61 private static final int MAX_RESULTS_BEFORE_WARNING
= 500;
63 public List
<TaxonNameBase
> findNames(IIdentifiableEntityServiceConfigurator configurator
){
64 if(checkLargeResult(CdmStore
.getService(INameService
.class).countByTitle(configurator
))){
65 List
<TaxonNameBase
> records
= CdmStore
.getService(INameService
.class).findByTitle(configurator
).getRecords();
66 addUuidSearchResults(records
, configurator
, INameService
.class);
72 public List
<NameRelationship
> findNameRelationships(
73 IIdentifiableEntityServiceConfigurator configurator
) {
75 //if activated again remember to add uuid search results like in other searches
79 List
<NameRelationship
> relationships
= new ArrayList
<NameRelationship
>();
80 List
<RelationshipBase
> all
= CdmStore
.getService(INameService
.class).getAllRelationships(0, 0);
82 for (RelationshipBase relationship
: all
){
83 if(relationship
instanceof NameRelationship
){
84 relationships
.add((NameRelationship
) relationship
);
90 public List
<UuidAndTitleCache
<IdentifiableEntity
>> findTaxaAndNames(IFindTaxaAndNamesConfigurator
<TaxonBase
> configurator
){
91 return CdmStore
.getService(ITaxonService
.class).findTaxaAndNamesForEditor(configurator
);
94 public List
<Reference
> findReferences(IIdentifiableEntityServiceConfigurator configurator
){
95 if(checkLargeResult(CdmStore
.getService(IReferenceService
.class).countByTitle(configurator
))){
96 List
<Reference
> records
= CdmStore
.getService(IReferenceService
.class).findByTitle(configurator
).getRecords();
97 addUuidSearchResults(records
, configurator
, IReferenceService
.class);
103 public List
<AgentBase
> findAgents(IIdentifiableEntityServiceConfigurator configurator
){
104 if(checkLargeResult(CdmStore
.getService(IAgentService
.class).countByTitle(configurator
))){
105 List
<AgentBase
> records
= CdmStore
.getService(IAgentService
.class).findByTitle(configurator
).getRecords();
106 addUuidSearchResults(records
, configurator
, IAgentService
.class);
113 * Check search string if it is a {@link UUID} and, if <code>true</code>, search for the corresponding entity.
114 * @param records the list to which the search results are added
115 * @param configurator the configurator holding the search string
116 * @param service the service to use for searching
118 private <T
extends ICdmBase
> void addUuidSearchResults(List
<T
> records
, IIdentifiableEntityServiceConfigurator configurator
, Class
<?
extends IService
<T
>> service
) {
119 String titleSearchString
= configurator
.getTitleSearchString();
121 UUID uuid
= UUID
.fromString(titleSearchString
);
122 T foundRecord
= CdmStore
.getService(service
).find(uuid
);
123 if(foundRecord
!=null){
124 records
.add(foundRecord
);
126 } catch (IllegalArgumentException e
) {
127 //search string was no UUID
131 @SuppressWarnings("unchecked")
132 public List
<TeamOrPersonBase
> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator
){
133 configurator
.setClazz(TeamOrPersonBase
.class);
134 return (List
)findAgents(configurator
);
138 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
139 * {@link IIdentifiableEntityServiceConfigurator}<br>
141 * Note: FieldUnits are omitted by default. See {@link #findOccurrences(IIdentifiableEntityServiceConfigurator, boolean)}
143 * @param configurator the configurator to use for the search
144 * @return a list of the SpecimenOrObservationBases matching the search parameters found
146 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator configurator
){
147 // by default we do not show field units. This may be configured via preferences
148 return findOccurrences(configurator
, PreferencesUtil
.getPreferenceStore().getBoolean(IPreferenceKeys
.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS
));
153 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
154 * {@link IIdentifiableEntityServiceConfigurator}
156 * @param configurator the configurator to use for the search
157 * @return a list of the SpecimenOrObservationBases found
158 * @param showFieldUnits if <code>true</code> then also FieldUnits are searched
161 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator
<SpecimenOrObservationBase
> configurator
, boolean showFieldUnits
){
162 List
<SpecimenOrObservationBase
> records
= new ArrayList
<SpecimenOrObservationBase
>();
163 final List
<String
> BASE_OCCURRENCE_INIT_STRATEGY
= Arrays
.asList(new String
[] {
167 "derivationEvents.originals",
168 "derivedFrom.originals",
169 "gatheringEvent.country.representations",
170 "gatheringEvent.collector",
171 "gatheringEvent.locality",
172 "descriptions.descriptionElements",
174 "amplificationResults",
175 "sequences.singleReadAlignments",
179 List
<String
> occurrencePropertyPaths
= new ArrayList
<String
>();
180 occurrencePropertyPaths
.addAll(BASE_OCCURRENCE_INIT_STRATEGY
);
181 for(String propertyPath
:BASE_OCCURRENCE_INIT_STRATEGY
) {
182 occurrencePropertyPaths
.add("derivationEvents.derivatives." + propertyPath
);
184 configurator
.setPropertyPaths(occurrencePropertyPaths
);
186 if(checkLargeResult(CdmStore
.getService(IOccurrenceService
.class).countOccurrences(configurator
))){
187 records
= CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords();
189 addUuidSearchResults(records
, configurator
, IOccurrenceService
.class);
193 public List
<User
> findUsers(IIdentifiableEntityServiceConfigurator configurator
){
194 String userNameSearchString
= sqlizeTitleSearchString(configurator
);
195 // TODO why are users not identifiable entities?
196 List
<User
> records
= CdmStore
.getService(IUserService
.class).listByUsername(userNameSearchString
, null, null, null, null, null, null);
197 addUuidSearchResults(records
, configurator
, IUserService
.class);
202 public List
<Group
> findGroups(IIdentifiableEntityServiceConfigurator configurator
){
203 String groupNameSearchString
= sqlizeTitleSearchString(configurator
);
204 // TODO why are groups not identifiable entities?
205 List
<Group
> records
= CdmStore
.getService(IGroupService
.class).listByName(groupNameSearchString
, null, null, null, null, null, null);
206 addUuidSearchResults(records
, configurator
, IGroupService
.class);
211 private boolean checkLargeResult(int count
) {
212 return checkLargeResult(count
, MAX_RESULTS_BEFORE_WARNING
);
215 private boolean checkLargeResult(int count
, int maxBeforWarning
) {
216 if(count
> maxBeforWarning
){
217 return MessageDialog
.openConfirm(Display
.getDefault().getActiveShell(), "Large result expected",
218 String
.format("The current search will return %s objects. This will " +
219 "take a long time and/or might render the editor unusable. Please consider refining your search.", count
));
225 private String
sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator
){
226 return configurator
.getTitleSearchString().replace(WILDCARD
, "%");
229 public List
findTaxa(IIdentifiableEntityServiceConfigurator configurator
) {
230 if(checkLargeResult(CdmStore
.getService(ITaxonService
.class).countByTitle(configurator
))){
231 List
<TaxonBase
> records
= CdmStore
.getService(ITaxonService
.class).findByTitle(configurator
).getRecords();
232 addUuidSearchResults(records
, configurator
, ITaxonService
.class);