-// $Id$
/**
* Copyright (C) 2007 EDIT
* European Distributed Institute of Taxonomy
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.swt.widgets.Display;
+import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
import eu.etaxonomy.cdm.api.service.IAgentService;
import eu.etaxonomy.cdm.api.service.IGroupService;
+import eu.etaxonomy.cdm.api.service.IMediaService;
import eu.etaxonomy.cdm.api.service.INameService;
import eu.etaxonomy.cdm.api.service.IOccurrenceService;
import eu.etaxonomy.cdm.api.service.IReferenceService;
import eu.etaxonomy.cdm.api.service.ITaxonService;
+import eu.etaxonomy.cdm.api.service.ITermService;
import eu.etaxonomy.cdm.api.service.IUserService;
import eu.etaxonomy.cdm.api.service.config.IFindTaxaAndNamesConfigurator;
import eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator;
import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
import eu.etaxonomy.cdm.model.common.RelationshipBase;
import eu.etaxonomy.cdm.model.common.User;
+import eu.etaxonomy.cdm.model.location.NamedArea;
+import eu.etaxonomy.cdm.model.media.Media;
import eu.etaxonomy.cdm.model.name.NameRelationship;
-import eu.etaxonomy.cdm.model.name.TaxonNameBase;
-import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;
-import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
+import eu.etaxonomy.cdm.model.name.TaxonName;
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
import eu.etaxonomy.cdm.model.reference.Reference;
import eu.etaxonomy.cdm.model.taxon.TaxonBase;
+import eu.etaxonomy.cdm.model.term.TermVocabulary;
import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
+import eu.etaxonomy.taxeditor.l10n.Messages;
import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
/**
* @author n.hoffmann
* @created Dec 8, 2010
- * @version 1.0
*/
public class SearchManager {
public static final List NO_RESULTS = Arrays.asList(new Object[]{});
- public static final String WILDCARD = "*";
+ public static final String WILDCARD = "*"; //$NON-NLS-1$
public static int NO_COUNT = -1;
- // TODO make this configurable via preferences
- private static final int MAX_RESULTS_BEFORE_WARNING = 500;
+ private static final int MAX_RESULTS_BEFORE_WARNING = 500;
- /**
- * <p>findNames</p>
- *
- * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
- * @return a {@link java.util.List} object.
- */
- public List<TaxonNameBase> findNames(IIdentifiableEntityServiceConfigurator configurator){
- if(checkLargeResult(CdmStore.getService(INameService.class).countByTitle(configurator))){
- return CdmStore.getService(INameService.class).findByTitle(configurator).getRecords();
- }
- return NO_RESULTS;
+ public List<TaxonName> findNames(IIdentifiableEntityServiceConfigurator configurator, ConversationHolder conversation){
+ List<TaxonName> records = CdmStore.getService(INameService.class).findByTitle(configurator).getRecords();
+ return records;
}
public List<NameRelationship> findNameRelationships(
IIdentifiableEntityServiceConfigurator configurator) {
if(true){
+ //if activated again remember to add uuid search results like in other searches
return NO_RESULTS;
}
- List<NameRelationship> relationships = new ArrayList<NameRelationship>();
+ List<NameRelationship> relationships = new ArrayList<>();
List<RelationshipBase> all = CdmStore.getService(INameService.class).getAllRelationships(0, 0);
- for (RelationshipBase relationship : all){
+ for (RelationshipBase<?,?,?> relationship : all){
if(relationship instanceof NameRelationship){
relationships.add((NameRelationship) relationship);
}
}
-
-
return relationships;
-
}
- /**
- * <p>findTaxaAndNames</p>
- *
- * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator} object.
- * @return a {@link java.util.List} object.
- */
- public List<UuidAndTitleCache<IdentifiableEntity>> findTaxaAndNames(IFindTaxaAndNamesConfigurator<TaxonBase> configurator){
+ public List<UuidAndTitleCache<? extends IdentifiableEntity>> findTaxaAndNames(IFindTaxaAndNamesConfigurator configurator){
return CdmStore.getService(ITaxonService.class).findTaxaAndNamesForEditor(configurator);
}
-
-
- /**
- * <p>findReferences</p>
- *
- * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
- * @return a {@link java.util.List} object.
- */
- public List<Reference> findReferences(IIdentifiableEntityServiceConfigurator configurator){
- if(checkLargeResult(CdmStore.getService(IReferenceService.class).countByTitle(configurator))){
- return CdmStore.getService(IReferenceService.class).findByTitle(configurator).getRecords();
- }
- return NO_RESULTS;
+ @SuppressWarnings("unchecked")
+ public List<Reference> findReferences(IIdentifiableEntityServiceConfigurator configurator){
+ List<Reference> records = CdmStore.getService(IReferenceService.class).findByTitle(configurator).getRecords();
+ return records;
}
-
- /**
- * <p>findAgents</p>
- *
- * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
- * @return a {@link java.util.List} object.
- */
public List<AgentBase> findAgents(IIdentifiableEntityServiceConfigurator configurator){
- if(checkLargeResult(CdmStore.getService(IAgentService.class).countByTitle(configurator))){
- return CdmStore.getService(IAgentService.class).findByTitle(configurator).getRecords();
- }
- return NO_RESULTS;
+ List<AgentBase> records = CdmStore.getService(IAgentService.class).findByTitle(configurator).getRecords();
+ return records;
}
- /**
- * <p>findTeamOrPersons</p>
- *
- * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.IIdentifiableEntityServiceConfigurator} object.
- * @return a {@link java.util.List} object.
- */
@SuppressWarnings("unchecked")
public List<TeamOrPersonBase> findTeamOrPersons(IIdentifiableEntityServiceConfigurator configurator){
- configurator.setClazz(TeamOrPersonBase.class);
- return (List)findAgents(configurator);
+ configurator.setClazz(TeamOrPersonBase.class);
+ return (List)findAgents(configurator);
}
/**
* @param configurator the configurator to use for the search
* @return a list of the SpecimenOrObservationBases matching the search parameters found
*/
- public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator configurator){
+ public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator configurator, boolean showCountWarning){
// by default we do not show field units. This may be configured via preferences
- return findOccurrences(configurator, PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS));
+ return findOccurrences(configurator, PreferencesUtil.getBooleanValue(IPreferenceKeys.BULK_EDITOR_OCCURRENCE_SHOW_FIELD_UNITS), showCountWarning);
}
* @param showFieldUnits if <code>true</code> then also FieldUnits are searched
* @return
*/
- public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator<SpecimenOrObservationBase> configurator, boolean showFieldUnits){
- if(configurator.getClazz()==null){
- if(showFieldUnits){
- configurator.setClazz(SpecimenOrObservationBase.class);
- }
- else{
- configurator.setClazz(DerivedUnit.class);
- }
- }
- if(configurator.getClazz().equals(SpecimenOrObservationBase.class)){
- //get FieldUnits + DerivedUnits
- List<SpecimenOrObservationBase> records = new ArrayList<SpecimenOrObservationBase>();
- configurator.setClazz(DerivedUnit.class);
- int derivedUnitCount = CdmStore.getService(IOccurrenceService.class).countOccurrences(configurator);
- configurator.setClazz(FieldUnit.class);
- int fieldUnitCount = CdmStore.getService(IOccurrenceService.class).countOccurrences(configurator);
-
- if(checkLargeResult(derivedUnitCount+fieldUnitCount)){
- configurator.setClazz(DerivedUnit.class);
- records.addAll(CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords());
- configurator.setClazz(FieldUnit.class);
- records.addAll(CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords());
- }
- return records;
-
+ public List<SpecimenOrObservationBase> findOccurrences(IIdentifiableEntityServiceConfigurator<SpecimenOrObservationBase> configurator, boolean showFieldUnits,
+ boolean showCountWarning){
+ List<SpecimenOrObservationBase> records = new ArrayList<SpecimenOrObservationBase>();
+ final List<String> BASE_OCCURRENCE_INIT_STRATEGY = Arrays.asList(new String[] {
+ "collection", //$NON-NLS-1$
+ "descriptions", //$NON-NLS-1$
+ "identifiers", //$NON-NLS-1$
+ "derivationEvents.originals", //$NON-NLS-1$
+ "derivedFrom.originals", //$NON-NLS-1$
+ "gatheringEvent.country.representations", //$NON-NLS-1$
+ "gatheringEvent.collector", //$NON-NLS-1$
+ "gatheringEvent.locality", //$NON-NLS-1$
+ "descriptions.descriptionElements", //$NON-NLS-1$
+ "kindOfUnit", //$NON-NLS-1$
+ "amplificationResults", //$NON-NLS-1$
+ "sequences.singleReadAlignments", //$NON-NLS-1$
+ "mediaSpecimen" //$NON-NLS-1$
+ });
+
+ List<String> occurrencePropertyPaths = new ArrayList<String>();
+ occurrencePropertyPaths.addAll(BASE_OCCURRENCE_INIT_STRATEGY);
+ for(String propertyPath:BASE_OCCURRENCE_INIT_STRATEGY) {
+ occurrencePropertyPaths.add("derivationEvents.derivatives." + propertyPath); //$NON-NLS-1$
}
- if(checkLargeResult(CdmStore.getService(IOccurrenceService.class).countOccurrences(configurator))){
- return CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords();
- }
- return NO_RESULTS;
+ configurator.setPropertyPaths(occurrencePropertyPaths);
+
+ if(showCountWarning && checkLargeResult(CdmStore.getService(IOccurrenceService.class).countOccurrences(configurator))){
+ records = CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords();
+ }
+ else{
+ records = CdmStore.getService(IOccurrenceService.class).findByTitle(configurator).getRecords();
+ }
+ return records;
}
public List<User> findUsers(IIdentifiableEntityServiceConfigurator configurator){
String userNameSearchString = sqlizeTitleSearchString(configurator);
// TODO why are users not identifiable entities?
- return CdmStore.getService(IUserService.class).listByUsername(userNameSearchString, null, null, null, null, null, null);
+ List<User> records = CdmStore.getService(IUserService.class).listByUsername(userNameSearchString,
+ configurator.getMatchMode(), configurator.getCriteria(), configurator.getPageSize(),
+ configurator.getPageNumber(), configurator.getOrderHints(), configurator.getPropertyPaths());
+ return records;
}
+
+ private boolean checkLargeResult(long count) {
+ return checkLargeResult(count, MAX_RESULTS_BEFORE_WARNING);
+ }
+
+ private boolean checkLargeResult(long count, int maxBeforWarning) {
+ if(count > maxBeforWarning){
+ return MessageDialog.openConfirm(Display.getDefault().getActiveShell(), Messages.SearchManager_LARGE_RESULT_EXPECTED,
+ String.format(Messages.SearchManager_LONG_SEARCH_WARNING, count));
+ }else{
+ return true;
+ }
+ }
+
public List<Group> findGroups(IIdentifiableEntityServiceConfigurator configurator){
String groupNameSearchString = sqlizeTitleSearchString(configurator);
// TODO why are groups not identifiable entities?
- return CdmStore.getService(IGroupService.class).listByName(groupNameSearchString, null, null, null, null, null, null);
+ List<Group> records = CdmStore.getService(IGroupService.class).listByName(groupNameSearchString,
+ configurator.getMatchMode(), configurator.getCriteria(), configurator.getPageSize(),
+ configurator.getPageNumber(), configurator.getOrderHints(), configurator.getPropertyPaths());
+ return records;
}
- /**
- * @param count
- * @return
- */
- private boolean checkLargeResult(int count) {
- if(count > MAX_RESULTS_BEFORE_WARNING){
- return MessageDialog.openConfirm(Display.getDefault().getActiveShell(), "Large result expected",
- String.format("The current search will return %s objects. This will " +
- "take a long time and/or might render the editor unusable. Please consider refining your search.", count));
- }else{
- return true;
- }
- }
-
- /**
- *
- * @param configurator
- * @return
- */
private String sqlizeTitleSearchString(IIdentifiableEntityServiceConfigurator configurator){
- return configurator.getTitleSearchString().replace(WILDCARD, "%");
+ return configurator.getTitleSearchString().replace(WILDCARD, "%"); //$NON-NLS-1$
}
public List findTaxa(IIdentifiableEntityServiceConfigurator configurator) {
- if(checkLargeResult(CdmStore.getService(ITaxonService.class).countByTitle(configurator))){
- return CdmStore.getService(ITaxonService.class).findByTitle(configurator).getRecords();
- }
- return NO_RESULTS;
+ List<TaxonBase> records = CdmStore.getService(ITaxonService.class).findByTitle(configurator).getRecords();
+ return records;
}
+ public List findMedia(IIdentifiableEntityServiceConfigurator configurator) {
+ List<Media> records = CdmStore.getService(IMediaService.class).findByTitle(configurator).getRecords();
+ return records;
+ }
+
+ /**
+ * @param searchConfigurator
+ * @return
+ */
+ public List<UuidAndTitleCache<NamedArea>> findNamedAreas(
+ IIdentifiableEntityServiceConfigurator searchConfigurator, List<TermVocabulary> vocs) {
+ List<UuidAndTitleCache<NamedArea>> entities = CdmStore.getService(ITermService.class).getUuidAndTitleCacheNamedArea(vocs, null, searchConfigurator.getTitleSearchString(), PreferencesUtil.getGlobalLanguage());
+ return entities;
+ }
}
BGBM BDI Projects / taxeditor.git / blobdiff