eu.etaxonomy.taxeditor.navigation/src/main/java/eu/etaxonomy/taxeditor/navigation/search/SearchResultView.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.navigation.search;
  11
  12 import java.util.ArrayList;
  13 import java.util.List;
  14
  15 import org.eclipse.core.runtime.IProgressMonitor;
  16 import org.eclipse.core.runtime.IStatus;
  17 import org.eclipse.core.runtime.Status;
  18 import org.eclipse.core.runtime.jobs.Job;
  19 import org.eclipse.jface.action.GroupMarker;
  20 import org.eclipse.jface.action.MenuManager;
  21 import org.eclipse.jface.viewers.ArrayContentProvider;
  22 import org.eclipse.jface.viewers.DoubleClickEvent;
  23 import org.eclipse.jface.viewers.IDoubleClickListener;
  24 import org.eclipse.jface.viewers.TableViewer;
  25 import org.eclipse.swt.SWT;
  26 import org.eclipse.swt.layout.GridData;
  27 import org.eclipse.swt.layout.GridLayout;
  28 import org.eclipse.swt.widgets.Composite;
  29 import org.eclipse.swt.widgets.Control;
  30 import org.eclipse.swt.widgets.Display;
  31 import org.eclipse.swt.widgets.Label;
  32 import org.eclipse.swt.widgets.Menu;
  33 import org.eclipse.swt.widgets.Text;
  34 import org.eclipse.ui.IMemento;
  35 import org.eclipse.ui.IWorkbenchActionConstants;
  36 import org.eclipse.ui.part.ViewPart;
  37
  38 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  39 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  40 import eu.etaxonomy.cdm.api.service.config.IFindTaxaAndNamesConfigurator;
  41 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  42 import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;
  43 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  44 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  45 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  46 import eu.etaxonomy.taxeditor.model.ContextListenerAdapter;
  47 import eu.etaxonomy.taxeditor.model.IContextListener;
  48 import eu.etaxonomy.taxeditor.navigation.NavigationUtil;
  49 import eu.etaxonomy.taxeditor.navigation.search.SearchBar.SearchOption;
  50 import eu.etaxonomy.taxeditor.store.CdmStore;
  51
  52 /**
  53  * <p>SearchResultView class.</p>
  54  *
  55  * @author p.ciardelli
  56  * @author n.hoffmann
  57  * @created 19.01.2009
  58  * @version 1.0
  59  */
  60 public class SearchResultView extends ViewPart implements IConversationEnabled{
  61
  62         private static Object[] EMPTY = new Object[0];
  63
  64         private class ContextListener extends ContextListenerAdapter{
  65                 /* (non-Javadoc)
  66                  * @see eu.etaxonomy.taxeditor.model.IContextListener#contextStop(org.eclipse.ui.IMemento, org.eclipse.core.runtime.IProgressMonitor)
  67                  */
  68                 @Override
  69                 public void contextStop(IMemento memento, IProgressMonitor monitor) {
  70                         monitor.subTask("Getting rid of search results");
  71                         AbstractUtility.hideView(SearchResultView.this);
  72                 }
  73         }
  74
  75         /** Constant <code>ID="eu.etaxonomy.taxeditor.navigation.searc"{trunked}</code> */
  76         public static final String ID =
  77                         "eu.etaxonomy.taxeditor.navigation.search.searchResultView"; //$NON-NLS-1$
  78
  79         private TableViewer resultViewer;
  80
  81         private ConversationHolder conversation;
  82
  83         private Text searchString;
  84
  85         private Text configurationLabel;
  86
  87         private Text status;
  88
  89         private SearchJob searchJob;
  90
  91         private IContextListener contextListener;
  92
  93         /* (non-Javadoc)
  94          * @see org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets.Composite)
  95          */
  96         /** {@inheritDoc} */
  97         @Override
  98         public void createPartControl(Composite parent) {
  99
 100                 conversation = CdmStore.createConversation();
 101                 contextListener = new ContextListener();
 102                 CdmStore.getContextManager().addContextListener(contextListener);
 103
 104                 GridLayout layout = new GridLayout();
 105                 layout.marginWidth = 0;
 106                 layout.marginHeight = 0;
 107
 108                 parent.setLayout(layout);
 109
 110                 Composite infoComposite = createInfoComposite(parent);
 111                 infoComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
 112
 113                 resultViewer = new TableViewer(parent, SWT.NONE);
 114                 resultViewer.setContentProvider(new ArrayContentProvider());
 115                 resultViewer.setLabelProvider(new SearchResultLabelProvider());
 116                 resultViewer.addDoubleClickListener(new IDoubleClickListener() {
 117                         @Override
 118             public void doubleClick(DoubleClickEvent event) {
 119                                 NavigationUtil.executeEditHandler();
 120                         }
 121                 });
 122
 123                 resultViewer.getControl().setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 124
 125                 getSite().setSelectionProvider(resultViewer);
 126
 127                 // register context menu
 128                 MenuManager menuMgr = new MenuManager();
 129                 menuMgr.add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));
 130                 getSite().registerContextMenu(menuMgr, resultViewer);
 131
 132                 Control control = resultViewer.getControl();
 133                 Menu menu = menuMgr.createContextMenu(control);
 134                 control.setMenu(menu);
 135         }
 136
 137         private Composite createInfoComposite(Composite parent){
 138                 Composite composite = new Composite(parent, SWT.NULL);
 139
 140                 composite.setLayout(new GridLayout(2, false));
 141
 142                 Label searchStringLabel = new Label(composite, SWT.NULL);
 143                 searchStringLabel.setText("Search String:");
 144
 145                 searchString = new Text(composite, SWT.NULL);
 146                 searchString.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 147                 searchString.setEditable(false);
 148 //              searchString.setText("                                               ");
 149
 150                 Label configurationDescriptionLabel = new Label(composite, SWT.NULL);
 151                 configurationDescriptionLabel.setText("Search for:");
 152
 153                 configurationLabel = new Text(composite, SWT.WRAP);
 154                 configurationLabel.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 155                 configurationLabel.setEditable(false);
 156
 157                 Label statusLabel = new Label(composite, SWT.NULL);
 158                 statusLabel.setText("Status:");
 159
 160                 status = new Text(composite, SWT.NULL);
 161                 status.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
 162                 status.setEditable(false);
 163
 164                 return composite;
 165         }
 166
 167         /**
 168          * <p>performSearch</p>
 169          *
 170          * @param configurator a {@link eu.etaxonomy.cdm.api.service.config.ITaxonServiceConfigurator} object.
 171          */
 172         public void performSearch(IFindTaxaAndNamesConfigurator configurator){
 173                 setPartName("Search: '" + configurator.getTitleSearchString() + "'");
 174
 175                 searchString.setText(configurator.getTitleSearchString());
 176
 177                 List<String> includedEntities = new ArrayList<String>();
 178                 if(configurator.isDoTaxa()) {
 179             includedEntities.add(SearchOption.TAXON.getLabel());
 180         }
 181                 if(configurator.isDoSynonyms()) {
 182             includedEntities.add(SearchOption.SYNONYM.getLabel());
 183         }
 184                 if(configurator.isDoNamesWithoutTaxa()) {
 185             includedEntities.add(SearchOption.NAME.getLabel());
 186         }
 187                 if(configurator.isDoTaxaByCommonNames()){
 188                         includedEntities.add(SearchOption.COMMON_NAME.getLabel());
 189                 }
 190
 191                 String includedEntitiesString = "";
 192                 for (int i = 0; i < includedEntities.size(); i++){
 193                         includedEntitiesString += includedEntities.get(i);
 194                         if(i < includedEntities.size() -1){
 195                                 includedEntitiesString += ", ";
 196                         }
 197                 }
 198
 199                 configurationLabel.setText(includedEntitiesString);
 200
 201                 status.setText("Searching...");
 202
 203                 searchJob = new SearchJob(Display.getCurrent(), configurator);
 204                 searchJob.schedule();
 205
 206         }
 207
 208         /**
 209          * <p>displaySearchResult</p>
 210          *
 211          * @param result a {@link java.util.List} object.
 212          */
 213         protected void displaySearchResult(List<UuidAndTitleCache<IdentifiableEntity>> result) {
 214                 if(result.size() > 0){
 215                         resultViewer.setInput(result);
 216                         status.setText(result.size() + " entities found");
 217                 }else{
 218                         resultViewer.setInput(EMPTY);
 219                         status.setText("Search returned no results");
 220                 }
 221         }
 222
 223         /* (non-Javadoc)
 224          * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
 225          */
 226         /** {@inheritDoc} */
 227         @Override
 228         public void setFocus() {
 229                 //logger.warn("Setting focus to search result viewer");
 230                 conversation.bind();
 231                 // pass focus to resultViewer
 232                 resultViewer.getControl().setFocus();
 233         }
 234
 235         /* (non-Javadoc)
 236          * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
 237          */
 238         /**
 239          * <p>getConversationHolder</p>
 240          *
 241          * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
 242          */
 243         @Override
 244     public ConversationHolder getConversationHolder() {
 245                 return this.conversation;
 246         }
 247
 248         /* (non-Javadoc)
 249          * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
 250          */
 251         /** {@inheritDoc} */
 252         @Override
 253     public void update(CdmDataChangeMap changeEvents) {
 254                 // TODO Auto-generated method stub
 255
 256         }
 257
 258         /* (non-Javadoc)
 259          * @see org.eclipse.ui.part.WorkbenchPart#dispose()
 260          */
 261         /** {@inheritDoc} */
 262         @Override
 263         public void dispose() {
 264                 super.dispose();
 265                 conversation.close();
 266                 if(searchJob != null) {
 267             searchJob.cancel();
 268         }
 269                 CdmStore.getContextManager().removeContextListener(contextListener);
 270         }
 271
 272         /**
 273          *
 274          * @author n.hoffmann
 275          * @created Feb 2, 2010
 276          * @version 1.0
 277          */
 278         class SearchJob extends Job{
 279
 280                 private final IFindTaxaAndNamesConfigurator configurator;
 281
 282                 private final Display display;
 283
 284                 /**
 285                  * @param name
 286                  */
 287                 public SearchJob(Display display, IFindTaxaAndNamesConfigurator configurator) {
 288                         super("Performing Search");
 289                         this.display = display;
 290                         this.configurator = configurator;
 291                 }
 292
 293                 /* (non-Javadoc)
 294                  * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor)
 295                  */
 296                 @Override
 297                 protected IStatus run(IProgressMonitor monitor) {
 298                         monitor.beginTask("", 100);
 299                         monitor.worked(20);
 300
 301                         final List<UuidAndTitleCache<IdentifiableEntity>> searchResult = CdmStore.getSearchManager().findTaxaAndNames(configurator);
 302                         monitor.worked(40);
 303
 304                         if(! monitor.isCanceled()){
 305                                 display.asyncExec(new Runnable() {
 306                                         @Override
 307                     public void run() {
 308                                                 displaySearchResult(searchResult);
 309                                         }
 310                                 });
 311                         }else{
 312                                 display.asyncExec(new Runnable() {
 313                                         @Override
 314                     public void run() {
 315                                                 status.setText("Cancelled");
 316                                         }
 317                                 });
 318                         }
 319                         monitor.done();
 320                         return Status.OK_STATUS;
 321                 }
 322
 323         }
 324 }