eu.etaxonomy.taxeditor.editor/src/main/java/eu/etaxonomy/taxeditor/editor/view/derivate/searchFilter/DerivateSearchCompositeController.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2013 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   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.
   9 */
  10 package eu.etaxonomy.taxeditor.editor.view.derivate.searchFilter;
  11
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.List;
  15 import java.util.UUID;
  16
  17 import org.eclipse.swt.SWT;
  18 import org.eclipse.swt.layout.GridData;
  19 import org.eclipse.swt.widgets.Composite;
  20 import org.eclipse.swt.widgets.Event;
  21 import org.eclipse.swt.widgets.Listener;
  22 import org.eclipse.swt.widgets.Widget;
  23
  24 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  25 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  26 import eu.etaxonomy.cdm.api.service.config.FindOccurrencesConfigurator;
  27 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  28 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
  29 import eu.etaxonomy.cdm.model.taxon.Taxon;
  30 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  31 import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView;
  32 import eu.etaxonomy.taxeditor.store.CdmStore;
  33 import eu.etaxonomy.taxeditor.store.SearchManager;
  34 import eu.etaxonomy.taxeditor.ui.dialog.selection.SelectionDialogFactory;
  35 import eu.etaxonomy.taxeditor.ui.mvc.combo.EnumTermComboController;
  36 import eu.etaxonomy.taxeditor.view.derivateSearch.DerivateLabelProvider;
  37
  38 /**
  39  * Controller class for the {@link DerivateSearchComposite}.<br>
  40  * This controller contains the logic to search the data base for {@link SpecimenOrObservationBase}s
  41  * and handles GUI events.
  42  *
  43  */
  44 public class DerivateSearchCompositeController implements Listener{
  45
  46     private final DerivateSearchComposite derivateSearchComposite;
  47     private EnumTermComboController<SpecimenOrObservationType> comboSpecimenTypeController;
  48         private DerivateLabelProvider labelProvider;
  49         private Taxon selectedTaxon;
  50     private DerivateView derivativeEditor;
  51
  52     public DerivateSearchCompositeController(Composite parent, DerivateView derivativeEditor) {
  53         this.derivateSearchComposite = new DerivateSearchComposite(parent, SWT.NONE);
  54         this.derivativeEditor = derivativeEditor;
  55         init();
  56     }
  57
  58     private void init(){
  59         //derivate type combo
  60         comboSpecimenTypeController = new EnumTermComboController<SpecimenOrObservationType>(derivateSearchComposite.getComboDerivateType(), null, null, SpecimenOrObservationType.class, 0);
  61         comboSpecimenTypeController.setSelection(SpecimenOrObservationType.Unknown);
  62
  63         //add listeners
  64         derivateSearchComposite.getSearchField().addListener(SWT.KeyDown, this);
  65         derivateSearchComposite.getButtonSearch().addListener(SWT.Selection, this);
  66         derivateSearchComposite.getBtnBrowseTaxa().addListener(SWT.Selection, this);
  67         derivateSearchComposite.getBtnClearTaxon().addListener(SWT.Selection, this);
  68         derivateSearchComposite.getButtonToggleLink().addListener(SWT.Selection, this);
  69
  70     }
  71
  72     private void searchDerivates(){
  73         String queryString = derivateSearchComposite.getSearchField().getText();
  74         SpecimenOrObservationType specimenType = comboSpecimenTypeController.getSelection();
  75
  76         FindOccurrencesConfigurator config = new FindOccurrencesConfigurator();
  77         config.setAssociatedTaxonUuid(selectedTaxon!=null?selectedTaxon.getUuid():null);
  78         config.setSpecimenType(specimenType.equals(SpecimenOrObservationType.Unknown)?null:specimenType);//unknown := all types
  79         config.setTitleSearchString(queryString);
  80         if(selectedTaxon!=null){
  81             config.setSpecimenType(null);
  82         }
  83
  84         SearchManager searchManager = new SearchManager();
  85         List<SpecimenOrObservationBase> occurrences = searchManager.findOccurrences(config, true);
  86
  87         //filter out specimens of wrong type (only if an associated taxon was selected)
  88         if(selectedTaxon!=null && !specimenType.equals(SpecimenOrObservationType.Unknown)){
  89             List<SpecimenOrObservationBase> specimensOfCorrectType = new ArrayList<SpecimenOrObservationBase>();
  90             for(SpecimenOrObservationBase<?> occurrence:occurrences){
  91                 if(occurrence.getRecordBasis().equals(specimenType)
  92                         || occurrence.getRecordBasis().isKindOf(specimenType)){
  93                     specimensOfCorrectType.add(occurrence);
  94                 }
  95             }
  96             occurrences = specimensOfCorrectType;
  97         }
  98
  99         //filter out (un-)assigned specimens
 100         if(selectedTaxon==null){
 101             int selectionIndex = derivateSearchComposite.getComboTaxonAssignment().getSelectionIndex();
 102             List<SpecimenOrObservationBase<?>> specimenWithAssociations = new ArrayList<SpecimenOrObservationBase<?>>();
 103             if(selectionIndex!=DerivateSearchComposite.ALL_SPECIMENS){
 104                 for (SpecimenOrObservationBase specimenOrObservationBase : occurrences) {
 105                     Collection<TaxonBase<?>> associatedTaxa = CdmStore.getService(IOccurrenceService.class).listAssociatedTaxa(specimenOrObservationBase, null, null, null, null);
 106                     if(!associatedTaxa.isEmpty()){
 107                         specimenWithAssociations.add(specimenOrObservationBase);
 108                         specimenWithAssociations.addAll(CdmStore.getService(IOccurrenceService.class).getFieldUnits(specimenOrObservationBase.getUuid()));
 109                     }
 110                 }
 111             }
 112             if(selectionIndex==DerivateSearchComposite.UNASSIGNED_SPECIMENS){
 113                 occurrences.removeAll(specimenWithAssociations);
 114             }
 115             else if(selectionIndex==DerivateSearchComposite.ASSIGNED_SPECIMENS){
 116                 occurrences = new ArrayList<SpecimenOrObservationBase>(specimenWithAssociations);
 117             }
 118         }
 119         List<UUID> derivateUuids = new ArrayList<UUID>();
 120         for (SpecimenOrObservationBase specimenOrObservationBase : occurrences) {
 121             derivateUuids.add(specimenOrObservationBase.getUuid());
 122         }
 123         derivativeEditor.updateRootEntities(derivateUuids);
 124     }
 125
 126     @Override
 127     public void handleEvent(Event event) {
 128         Widget eventSource = event.widget;
 129         if(eventSource == derivateSearchComposite.getButtonSearch()
 130                 || (eventSource == derivateSearchComposite.getSearchField() && event.keyCode == SWT.CR)){
 131             searchDerivates();
 132         }
 133         else if(eventSource==derivateSearchComposite.getBtnBrowseTaxa()){
 134             selectedTaxon = SelectionDialogFactory.getSelectionFromDialog(Taxon.class, this.derivateSearchComposite.getShell(), derivativeEditor.getConversationHolder(), null);
 135             if(selectedTaxon!=null){
 136                 derivateSearchComposite.getTextTaxonName().setText(selectedTaxon.getTitleCache());
 137             }
 138             derivateSearchComposite.getComboTaxonAssignment().select(DerivateSearchComposite.ASSIGNED_SPECIMENS);
 139             derivateSearchComposite.getComboTaxonAssignment().setEnabled(false);
 140             derivateSearchComposite.getLbltaxonAssignment().setEnabled(false);
 141         }
 142         else if(eventSource==derivateSearchComposite.getBtnClearTaxon()){
 143             selectedTaxon = null;
 144             derivateSearchComposite.getTextTaxonName().setText("");
 145             derivateSearchComposite.getComboTaxonAssignment().select(DerivateSearchComposite.ALL_SPECIMENS);
 146             derivateSearchComposite.getComboTaxonAssignment().setEnabled(true);
 147             derivateSearchComposite.getLbltaxonAssignment().setEnabled(true);
 148         }
 149         else if(eventSource==derivateSearchComposite.getButtonToggleLink()){
 150             derivativeEditor.toggleListenToSelectionChange();
 151         }
 152     }
 153
 154     /**
 155      * Sets enable status of all input fields
 156      * @param enabled
 157      */
 158     public void setEnabled(boolean enabled) {
 159         if(!derivateSearchComposite.isDisposed()){
 160             GridData layoutData = (GridData) derivateSearchComposite.getLayoutData();
 161             layoutData.exclude = !enabled;
 162             derivateSearchComposite.setVisible(enabled);
 163             derivateSearchComposite.getParent().layout(true);
 164         }
 165     }
 166
 167     public void setLayoutData(Object layoutData){
 168         derivateSearchComposite.setLayoutData(layoutData);
 169     }
 170
 171     /**
 172      * Resets all input fields
 173      */
 174     public void reset(){
 175         if(!derivateSearchComposite.isDisposed()){
 176             derivateSearchComposite.getSearchField().setText("");
 177             derivateSearchComposite.getComboDerivateType().deselectAll();
 178             comboSpecimenTypeController.setSelection(SpecimenOrObservationType.Unknown);
 179         }
 180         selectedTaxon = null;
 181     }
 182
 183     public void setConversation(ConversationHolder conversationHolder) {
 184         labelProvider.setConversation(conversationHolder);
 185     }
 186
 187 }