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
;
17 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
18 import org
.eclipse
.swt
.widgets
.Display
;
20 import eu
.etaxonomy
.cdm
.api
.service
.IAgentService
;
21 import eu
.etaxonomy
.cdm
.api
.service
.IGroupService
;
22 import eu
.etaxonomy
.cdm
.api
.service
.INameService
;
23 import eu
.etaxonomy
.cdm
.api
.service
.IOccurrenceService
;
24 import eu
.etaxonomy
.cdm
.api
.service
.IReferenceService
;
25 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonService
;
26 import eu
.etaxonomy
.cdm
.api
.service
.IUserService
;
27 import eu
.etaxonomy
.cdm
.api
.service
.config
.IFindTaxaAndNamesConfigurator
;
28 import eu
.etaxonomy
.cdm
.api
.service
.config
.IIdentifiableEntityServiceConfigurator
;
29 import eu
.etaxonomy
.cdm
.model
.agent
.AgentBase
;
30 import eu
.etaxonomy
.cdm
.model
.agent
.TeamOrPersonBase
;
31 import eu
.etaxonomy
.cdm
.model
.common
.Group
;
32 import eu
.etaxonomy
.cdm
.model
.common
.RelationshipBase
;
33 import eu
.etaxonomy
.cdm
.model
.common
.User
;
34 import eu
.etaxonomy
.cdm
.model
.common
.UuidAndTitleCache
;
35 import eu
.etaxonomy
.cdm
.model
.name
.NameRelationship
;
36 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
37 import eu
.etaxonomy
.cdm
.model
.occurrence
.DerivedUnit
;
38 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
39 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationType
;
40 import eu
.etaxonomy
.cdm
.model
.reference
.Reference
;
41 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
42 import eu
.etaxonomy
.taxeditor
.preference
.IPreferenceKeys
;
43 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
47 * @created Dec 8, 2010
50 public class SearchManager
{
52 public static final List NO_RESULTS
= Arrays
.asList(new Object
[]{});
54 public static final String WILDCARD
= "*";
56 public static int NO_COUNT
= -1;
58 // TODO make this configurable via preferences
59 private static final int MAX_RESULTS_BEFORE_WARNING
= 500;
64 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
65 * @return a {@link java.util.List} object.
67 public List
<TaxonNameBase
> findNames(IIdentifiableEntityServiceConfigurator configurator
){
68 if(checkLargeResult(CdmStore
.getService(INameService
.class).countByTitle(configurator
))){
69 return CdmStore
.getService(INameService
.class).findByTitle(configurator
).getRecords();
74 public List
<NameRelationship
> findNameRelationships(
75 IIdentifiableEntityServiceConfigurator configurator
) {
80 List
<NameRelationship
> relationships
= new ArrayList
<NameRelationship
>();
81 List
<RelationshipBase
> all
= CdmStore
.getService(INameService
.class).getAllRelationships(0, 0);
83 for (RelationshipBase relationship
: all
){
84 if(relationship
instanceof NameRelationship
){
85 relationships
.add((NameRelationship
) relationship
);
95 * <p>findTaxaAndNames</p>
97 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator} object.
98 * @return a {@link java.util.List} object.
100 public List
<UuidAndTitleCache
<TaxonBase
>> findTaxaAndNames(IFindTaxaAndNamesConfigurator
<TaxonBase
> configurator
){
101 return CdmStore
.getService(ITaxonService
.class).findTaxaAndNamesForEditor(configurator
);
108 * <p>findReferences</p>
110 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
111 * @return a {@link java.util.List} object.
113 public List
<Reference
> findReferences(IIdentifiableEntityServiceConfigurator configurator
){
114 if(checkLargeResult(CdmStore
.getService(IReferenceService
.class).countByTitle(configurator
))){
115 return CdmStore
.getService(IReferenceService
.class).findByTitle(configurator
).getRecords();
124 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
125 * @return a {@link java.util.List} object.
127 public List
<AgentBase
> findAgents(IIdentifiableEntityServiceConfigurator configurator
){
128 if(checkLargeResult(CdmStore
.getService(IAgentService
.class).countByTitle(configurator
))){
129 return CdmStore
.getService(IAgentService
.class).findByTitle(configurator
).getRecords();
135 * <p>findTeamOrPersons</p>
137 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
138 * @return a {@link java.util.List} object.
140 public List
<AgentBase
> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator
){
141 configurator
.setClazz(TeamOrPersonBase
.class);
142 return findAgents(configurator
);
146 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
147 * {@link IIdentifiableEntityServiceConfigurator}<br>
149 * Note: FieldUnits are omitted by default. See {@link #findOccurrences(IIdentifiableEntityServiceConfigurator, boolean)}
151 * @param configurator the configurator to use for the search
152 * @return a list of the SpecimenOrObservationBases matching the search parameters found
154 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator configurator
){
155 // by default we do not show field units. This may be configured via preferences
156 return findOccurrences(configurator
, PreferencesUtil
.getPreferenceStore().getBoolean(IPreferenceKeys
.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS
));
161 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
162 * {@link IIdentifiableEntityServiceConfigurator}
164 * @param configurator the configurator to use for the search
165 * @return a list of the SpecimenOrObservationBases found
166 * @param showFieldUnits if <code>true</code> then also FieldUnits are searched
169 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator configurator
, boolean showFieldUnits
){
170 if(! showFieldUnits
){
171 configurator
.setClazz(DerivedUnit
.class);
173 if(checkLargeResult(CdmStore
.getService(IOccurrenceService
.class).countByTitle(configurator
))){
174 return CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords();
180 * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the {@link IIdentifiableEntityServiceConfigurator}
181 * which match the given {@link SpecimenOrObservationType}
182 * @param configurator the configurator to use for the search
183 * @param type the type/record basis the specimens must have
184 * @return a list of the SpecimenOrObservationBases matching the search parameters found
186 * @deprecated method needs to be optimized with a direct SQL query instead of iterating over all specimens
189 //TODO: method needs to be optimized with a direct SQL query instead of iterating over all specimens
190 public List
<SpecimenOrObservationBase
> findOccurrencesByType(IIdentifiableEntityServiceConfigurator configurator
, SpecimenOrObservationType type
){
191 List
<SpecimenOrObservationBase
> filteredOccurrences
= new ArrayList
<SpecimenOrObservationBase
>();
192 List
<SpecimenOrObservationBase
> occurrences
= findOccurrences(configurator
, true);
194 for(SpecimenOrObservationBase occurrence
:occurrences
){
195 if(occurrence
.getRecordBasis().equals(type
)
196 || occurrence
.getRecordBasis().isKindOf(type
)
197 || type
== SpecimenOrObservationType
.Unknown
){
198 filteredOccurrences
.add(occurrence
);
203 filteredOccurrences
= occurrences
;
205 return filteredOccurrences
;
208 public List
<User
> findUsers(IIdentifiableEntityServiceConfigurator configurator
){
209 String userNameSearchString
= sqlizeTitleSearchString(configurator
);
210 // TODO why are users not identifiable entities?
211 return CdmStore
.getService(IUserService
.class).listByUsername(userNameSearchString
, null, null, null, null, null, null);
215 public List
<Group
> findGroups(IIdentifiableEntityServiceConfigurator configurator
){
216 String groupNameSearchString
= sqlizeTitleSearchString(configurator
);
217 // TODO why are groups not identifiable entities?
218 return CdmStore
.getService(IGroupService
.class).listByName(groupNameSearchString
, null, null, null, null, null, null);
226 private boolean checkLargeResult(int count
) {
227 if(count
> MAX_RESULTS_BEFORE_WARNING
){
228 return MessageDialog
.openConfirm(Display
.getDefault().getActiveShell(), "Large result expected",
229 String
.format("The current search will return %s objects. This will " +
230 "take a long time and/or might render the editor unusable. Please consider refining your search.", count
));
238 * @param configurator
241 private String
sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator
){
242 return configurator
.getTitleSearchString().replace(WILDCARD
, "%");
245 public List
findTaxa(IIdentifiableEntityServiceConfigurator configurator
) {
246 if(checkLargeResult(CdmStore
.getService(ITaxonService
.class).countByTitle(configurator
))){
247 return CdmStore
.getService(ITaxonService
.class).findByTitle(configurator
).getRecords();