Implement taxon assignment filter and refactor DerivativeEditor
[taxeditor.git] / 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.widgets.Composite;
19 import org.eclipse.swt.widgets.Event;
20 import org.eclipse.swt.widgets.Listener;
21 import org.eclipse.swt.widgets.Widget;
22
23 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
24 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
25 import eu.etaxonomy.cdm.api.service.config.FindOccurrencesConfigurator;
26 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
27 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
28 import eu.etaxonomy.cdm.model.taxon.Taxon;
29 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
30 import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView;
31 import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateViewEditorInput;
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
69 }
70
71 private void searchDerivates(){
72 // if(!conversation.isBound()){
73 // conversation.bind();
74 // }
75
76 String queryString = derivateSearchComposite.getSearchField().getText();
77 SpecimenOrObservationType specimenType = comboSpecimenTypeController.getSelection();
78
79 FindOccurrencesConfigurator config = new FindOccurrencesConfigurator();
80 config.setAssociatedTaxonUuid(selectedTaxon!=null?selectedTaxon.getUuid():null);
81 config.setSpecimenType(specimenType.equals(SpecimenOrObservationType.Unknown)?null:specimenType);//unknown := all types
82 config.setTitleSearchString(queryString);
83 if(selectedTaxon!=null){
84 config.setRetrieveIndirectlyAssociatedSpecimens(true);
85 config.setSpecimenType(null);
86 }
87
88 SearchManager searchManager = new SearchManager();
89 List<SpecimenOrObservationBase> occurrences = searchManager.findOccurrences(config, true);
90
91 //filter out specimens of wrong type (only if an associated taxon was selected)
92 if(selectedTaxon!=null && !specimenType.equals(SpecimenOrObservationType.Unknown)){
93 List<SpecimenOrObservationBase> specimensOfCorrectType = new ArrayList<SpecimenOrObservationBase>();
94 for(SpecimenOrObservationBase<?> occurrence:occurrences){
95 if(occurrence.getRecordBasis().equals(specimenType)
96 || occurrence.getRecordBasis().isKindOf(specimenType)){
97 specimensOfCorrectType.add(occurrence);
98 }
99 }
100 occurrences = specimensOfCorrectType;
101 }
102
103 //filter out (un-)assigned specimens
104 DerivateViewEditorInput editorInput = (DerivateViewEditorInput)derivativeEditor.getEditorInput();
105 int selectionIndex = derivateSearchComposite.getComboTaxonAssignment().getSelectionIndex();
106 List<SpecimenOrObservationBase<?>> specimenWithAssociations = new ArrayList<SpecimenOrObservationBase<?>>();
107 if(selectionIndex!=DerivateSearchComposite.ALL_SPECIMENS){
108 for (SpecimenOrObservationBase specimenOrObservationBase : occurrences) {
109 Collection<TaxonBase<?>> associatedTaxa = CdmStore.getService(IOccurrenceService.class).listAssociatedTaxa(specimenOrObservationBase, null, null, null, null);
110 if(!associatedTaxa.isEmpty()){
111 specimenWithAssociations.add(specimenOrObservationBase);
112 }
113 }
114 }
115 if(selectionIndex==DerivateSearchComposite.UNASSIGNED_SPECIMENS){
116 for (SpecimenOrObservationBase<?> specimenOrObservationBase : specimenWithAssociations) {
117 derivativeEditor.removeHierarchy(specimenOrObservationBase);
118 }
119 derivativeEditor.updateRootEntities();
120 }
121 else{
122 if(selectionIndex==DerivateSearchComposite.ASSIGNED_SPECIMENS){
123 occurrences = new ArrayList<SpecimenOrObservationBase>(specimenWithAssociations);
124 }
125 List<UUID> derivateUuids = new ArrayList<UUID>();
126 for (SpecimenOrObservationBase specimenOrObservationBase : occurrences) {
127 derivateUuids.add(specimenOrObservationBase.getUuid());
128 }
129 derivativeEditor.updateRootEntities(derivateUuids);
130 }
131 }
132
133 @Override
134 public void handleEvent(Event event) {
135 Widget eventSource = event.widget;
136 if(eventSource == derivateSearchComposite.getButtonSearch()
137 || (eventSource == derivateSearchComposite.getSearchField() && event.keyCode == SWT.CR)){
138 searchDerivates();
139 }
140 else if(eventSource==derivateSearchComposite.getBtnBrowseTaxa()){
141 selectedTaxon = SelectionDialogFactory.getSelectionFromDialog(Taxon.class, this.derivateSearchComposite.getShell(), derivativeEditor.getConversationHolder(), null);
142 if(selectedTaxon!=null){
143 derivateSearchComposite.getTextTaxonName().setText(selectedTaxon.getTitleCache());
144 }
145 }
146 else if(eventSource==derivateSearchComposite.getBtnClearTaxon()){
147 selectedTaxon = null;
148 derivateSearchComposite.getTextTaxonName().setText("");
149 }
150 }
151
152 /**
153 * Sets enable status of all input fields
154 * @param enabled
155 */
156 public void setEnabled(boolean enabled) {
157 if(!derivateSearchComposite.isDisposed()){
158 derivateSearchComposite.setEnabled(enabled);
159 }
160 }
161
162 public void setLayoutData(Object layoutData){
163 derivateSearchComposite.setLayoutData(layoutData);
164 }
165
166 /**
167 * Resets all input fields
168 */
169 public void reset(){
170 if(!derivateSearchComposite.isDisposed()){
171 derivateSearchComposite.getSearchField().setText("");
172 derivateSearchComposite.getComboDerivateType().deselectAll();
173 comboSpecimenTypeController.setSelection(SpecimenOrObservationType.Unknown);
174 }
175 selectedTaxon = null;
176 }
177
178 public void setConversation(ConversationHolder conversationHolder) {
179 labelProvider.setConversation(conversationHolder);
180 }
181
182 }