eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/store/SearchManager.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.taxeditor.store;
  11
  12 import java.util.ArrayList;
  13 import java.util.Arrays;
  14 import java.util.List;
  15
  16 import org.eclipse.jface.dialogs.MessageDialog;
  17 import org.eclipse.swt.widgets.Display;
  18
  19 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  20 import eu.etaxonomy.cdm.api.service.IAgentService;
  21 import eu.etaxonomy.cdm.api.service.IGroupService;
  22 import eu.etaxonomy.cdm.api.service.IMediaService;
  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.ITaxonService;
  27 import eu.etaxonomy.cdm.api.service.ITermService;
  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.permission.Group;
  34 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  35 import eu.etaxonomy.cdm.model.common.RelationshipBase;
  36 import eu.etaxonomy.cdm.model.permission.User;
  37 import eu.etaxonomy.cdm.model.location.NamedArea;
  38 import eu.etaxonomy.cdm.model.media.Media;
  39 import eu.etaxonomy.cdm.model.name.NameRelationship;
  40 import eu.etaxonomy.cdm.model.name.TaxonName;
  41 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  42 import eu.etaxonomy.cdm.model.reference.Reference;
  43 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  44 import eu.etaxonomy.cdm.model.term.TermVocabulary;
  45 import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
  46 import eu.etaxonomy.taxeditor.l10n.Messages;
  47 import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
  48 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
  49
  50 /**
  51  * @author n.hoffmann
  52  * @created Dec 8, 2010
  53  */
  54 public class SearchManager {
  55
  56         public static final List NO_RESULTS = Arrays.asList(new Object[]{});
  57
  58         public static final String WILDCARD = "*"; //$NON-NLS-1$
  59
  60         public static int NO_COUNT = -1;
  61
  62     private static final int MAX_RESULTS_BEFORE_WARNING = 500;
  63
  64         public List<TaxonName> findNames(IIdentifiableEntityServiceConfigurator configurator, ConversationHolder conversation){
  65             List<TaxonName> records = CdmStore.getService(INameService.class).findByTitle(configurator).getRecords();
  66             return records;
  67         }
  68
  69         public List<NameRelationship> findNameRelationships(
  70                         IIdentifiableEntityServiceConfigurator configurator) {
  71                 if(true){
  72                     //if activated again remember to add uuid search results like in other searches
  73                         return NO_RESULTS;
  74                 }
  75
  76                 List<NameRelationship> relationships = new ArrayList<>();
  77                 List<RelationshipBase> all = CdmStore.getService(INameService.class).getAllRelationships(0, 0);
  78
  79                 for (RelationshipBase<?,?,?> relationship : all){
  80                         if(relationship instanceof NameRelationship){
  81                                 relationships.add((NameRelationship) relationship);
  82                         }
  83                 }
  84                 return relationships;
  85         }
  86
  87         public List<UuidAndTitleCache<? extends IdentifiableEntity>> findTaxaAndNames(IFindTaxaAndNamesConfigurator configurator){
  88                 return CdmStore.getService(ITaxonService.class).findTaxaAndNamesForEditor(configurator);
  89         }
  90
  91
  92         @SuppressWarnings("unchecked")
  93     public List<Reference> findReferences(IIdentifiableEntityServiceConfigurator configurator){
  94                 List<Reference> records = CdmStore.getService(IReferenceService.class).findByTitle(configurator).getRecords();
  95             return records;
  96         }
  97
  98         public List<AgentBase> findAgents(IIdentifiableEntityServiceConfigurator configurator){
  99             List<AgentBase> records = CdmStore.getService(IAgentService.class).findByTitle(configurator).getRecords();
 100             return records;
 101         }
 102
 103         @SuppressWarnings("unchecked")
 104         public List<TeamOrPersonBase> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator){
 105             configurator.setClazz(TeamOrPersonBase.class);
 106             return (List)findAgents(configurator);
 107         }
 108
 109         /**
 110          * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
 111          * {@link IIdentifiableEntityServiceConfigurator}<br>
 112          * <br>
 113          * Note: FieldUnits are omitted by default. See {@link #findOccurrences(IIdentifiableEntityServiceConfigurator, boolean)}
 114          *
 115          * @param configurator the configurator to use for the search
 116          * @return a list of the SpecimenOrObservationBases matching the search parameters found
 117          */
 118         public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator configurator, boolean showCountWarning){
 119             // by default we do not show field units. This may be configured via preferences
 120             return findOccurrences(configurator, PreferencesUtil.getBooleanValue(IPreferenceKeys.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS), showCountWarning);
 121         }
 122
 123
 124         /**
 125          * Searches for {@link SpecimenOrObservationBase} with the parameters specified in the
 126          * {@link IIdentifiableEntityServiceConfigurator}
 127          *
 128          * @param configurator the configurator to use for the search
 129          * @return a list of the SpecimenOrObservationBases found
 130          * @param showFieldUnits if <code>true</code> then also FieldUnits are searched
 131          * @return
 132          */
 133         public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator<SpecimenOrObservationBase> configurator, boolean showFieldUnits,
 134                 boolean showCountWarning){
 135             List<SpecimenOrObservationBase> records = new ArrayList<SpecimenOrObservationBase>();
 136                 final List<String> BASE_OCCURRENCE_INIT_STRATEGY = Arrays.asList(new String[] {
 137                         "collection", //$NON-NLS-1$
 138                         "descriptions", //$NON-NLS-1$
 139                         "identifiers", //$NON-NLS-1$
 140                         "derivationEvents.originals", //$NON-NLS-1$
 141                         "derivedFrom.originals", //$NON-NLS-1$
 142                         "gatheringEvent.country.representations", //$NON-NLS-1$
 143                         "gatheringEvent.collector", //$NON-NLS-1$
 144                         "gatheringEvent.locality", //$NON-NLS-1$
 145                         "descriptions.descriptionElements", //$NON-NLS-1$
 146                         "kindOfUnit", //$NON-NLS-1$
 147                         "amplificationResults", //$NON-NLS-1$
 148                         "sequences.singleReadAlignments", //$NON-NLS-1$
 149                         "mediaSpecimen" //$NON-NLS-1$
 150                 });
 151
 152                 List<String> occurrencePropertyPaths = new ArrayList<String>();
 153                 occurrencePropertyPaths.addAll(BASE_OCCURRENCE_INIT_STRATEGY);
 154                 for(String propertyPath:BASE_OCCURRENCE_INIT_STRATEGY) {
 155                     occurrencePropertyPaths.add("derivationEvents.derivatives." + propertyPath); //$NON-NLS-1$
 156                 }
 157                 configurator.setPropertyPaths(occurrencePropertyPaths);
 158
 159         if(showCountWarning && checkLargeResult(CdmStore.getService(IOccurrenceService.class).countOccurrences(configurator))){
 160             records = CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords();
 161         }
 162         else{
 163             records = CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords();
 164         }
 165                 return records;
 166         }
 167
 168         public List<User> findUsers(IIdentifiableEntityServiceConfigurator configurator){
 169                 String userNameSearchString = sqlizeTitleSearchString(configurator);
 170                 // TODO why are users not identifiable entities?
 171         List<User> records = CdmStore.getService(IUserService.class).listByUsername(userNameSearchString,
 172                 configurator.getMatchMode(), configurator.getCriteria(), configurator.getPageSize(),
 173                 configurator.getPageNumber(), configurator.getOrderHints(), configurator.getPropertyPaths());
 174         return records;
 175         }
 176
 177
 178
 179     private boolean checkLargeResult(long count) {
 180         return checkLargeResult(count, MAX_RESULTS_BEFORE_WARNING);
 181     }
 182
 183     private boolean checkLargeResult(long count, int maxBeforWarning) {
 184         if(count > maxBeforWarning){
 185             return MessageDialog.openConfirm(Display.getDefault().getActiveShell(), Messages.SearchManager_LARGE_RESULT_EXPECTED,
 186                     String.format(Messages.SearchManager_LONG_SEARCH_WARNING, count));
 187         }else{
 188             return true;
 189         }
 190     }
 191
 192         public List<Group> findGroups(IIdentifiableEntityServiceConfigurator configurator){
 193                 String groupNameSearchString = sqlizeTitleSearchString(configurator);
 194                 // TODO why are groups not identifiable entities?
 195         List<Group> records = CdmStore.getService(IGroupService.class).listByName(groupNameSearchString,
 196                 configurator.getMatchMode(), configurator.getCriteria(), configurator.getPageSize(),
 197                 configurator.getPageNumber(), configurator.getOrderHints(), configurator.getPropertyPaths());
 198         return records;
 199         }
 200
 201
 202         private String sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator){
 203                 return configurator.getTitleSearchString().replace(WILDCARD, "%"); //$NON-NLS-1$
 204         }
 205
 206         public List findTaxa(IIdentifiableEntityServiceConfigurator configurator) {
 207             List<TaxonBase> records = CdmStore.getService(ITaxonService.class).findByTitle(configurator).getRecords();
 208             return records;
 209         }
 210
 211         public List findMedia(IIdentifiableEntityServiceConfigurator configurator) {
 212             List<Media> records = CdmStore.getService(IMediaService.class).findByTitle(configurator).getRecords();
 213             return records;
 214     }
 215
 216     /**
 217      * @param searchConfigurator
 218      * @return
 219      */
 220     public List<UuidAndTitleCache<NamedArea>> findNamedAreas(
 221             IIdentifiableEntityServiceConfigurator searchConfigurator, List<TermVocabulary> vocs) {
 222         List<UuidAndTitleCache<NamedArea>> entities = CdmStore.getService(ITermService.class).getUuidAndTitleCacheNamedArea(vocs, null, searchConfigurator.getTitleSearchString(), PreferencesUtil.getGlobalLanguage());
 223         return entities;
 224     }
 225
 226 }