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
.IIdentifiableEntityServiceConfigurator
;
28 import eu
.etaxonomy
.cdm
.api
.service
.config
.ITaxonServiceConfigurator
;
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
.IIdentifiableEntity
;
33 import eu
.etaxonomy
.cdm
.model
.common
.RelationshipBase
;
34 import eu
.etaxonomy
.cdm
.model
.common
.User
;
35 import eu
.etaxonomy
.cdm
.model
.common
.UuidAndTitleCache
;
36 import eu
.etaxonomy
.cdm
.model
.name
.NameRelationship
;
37 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
38 import eu
.etaxonomy
.cdm
.model
.occurrence
.DerivedUnitBase
;
39 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
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(ITaxonServiceConfigurator configurator
){
101 return CdmStore
.getService(ITaxonService
.class).findTaxaAndNamesForEditor(configurator
);
106 * <p>findReferences</p>
108 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
109 * @return a {@link java.util.List} object.
111 public List
<Reference
> findReferences(IIdentifiableEntityServiceConfigurator configurator
){
112 if(checkLargeResult(CdmStore
.getService(IReferenceService
.class).countByTitle(configurator
))){
113 return CdmStore
.getService(IReferenceService
.class).findByTitle(configurator
).getRecords();
122 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
123 * @return a {@link java.util.List} object.
125 public List
<AgentBase
> findAgents(IIdentifiableEntityServiceConfigurator configurator
){
126 if(checkLargeResult(CdmStore
.getService(IAgentService
.class).countByTitle(configurator
))){
127 return CdmStore
.getService(IAgentService
.class).findByTitle(configurator
).getRecords();
133 * <p>findTeamOrPersons</p>
135 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
136 * @return a {@link java.util.List} object.
138 public List
<AgentBase
> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator
){
139 configurator
.setClazz(TeamOrPersonBase
.class);
140 return findAgents(configurator
);
145 * <p>findOccurrences</p>
147 * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
148 * @return a {@link java.util.List} object.
150 public List
<SpecimenOrObservationBase
> findOccurrences(IIdentifiableEntityServiceConfigurator configurator
){
151 // by default we do not show field observations. This may be configured via preferences
152 boolean showFieldObservations
= PreferencesUtil
.getPreferenceStore().getBoolean(IPreferenceKeys
.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_OBSERVATIONS
);
153 if(! showFieldObservations
){
154 configurator
.setClazz(DerivedUnitBase
.class);
156 if(checkLargeResult(CdmStore
.getService(IOccurrenceService
.class).countByTitle(configurator
))){
157 return CdmStore
.getService(IOccurrenceService
.class).findByTitle(configurator
).getRecords();
163 public List
<User
> findUsers(IIdentifiableEntityServiceConfigurator configurator
){
164 String userNameSearchString
= sqlizeTitleSearchString(configurator
);
165 // TODO why are users not identifiable entities?
166 return CdmStore
.getService(IUserService
.class).listByUsername(userNameSearchString
, null, null, null, null, null, null);
170 public List
<Group
> findGroups(IIdentifiableEntityServiceConfigurator configurator
){
171 String groupNameSearchString
= sqlizeTitleSearchString(configurator
);
172 // TODO why are groups not identifiable entities?
173 return CdmStore
.getService(IGroupService
.class).listByName(groupNameSearchString
, null, null, null, null, null, null);
181 private boolean checkLargeResult(int count
) {
182 if(count
> MAX_RESULTS_BEFORE_WARNING
){
183 return MessageDialog
.openConfirm(Display
.getDefault().getActiveShell(), "Large result expected",
184 String
.format("The current search will return %s objects. This will " +
185 "take a long time and/or might render the editor unusable. Please consider refining your search.", count
));
193 * @param configurator
196 private String
sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator
){
197 return configurator
.getTitleSearchString().replace(WILDCARD
, "%");