eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/dialog/selection/AbstractFilteredCdmResourceSelectionDialog.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 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
  11 package eu.etaxonomy.taxeditor.ui.dialog.selection;
  12
  13 import java.lang.reflect.Field;
  14 import java.text.Collator;
  15 import java.util.Comparator;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Set;
  19 import java.util.UUID;
  20
  21 import org.eclipse.core.runtime.CoreException;
  22 import org.eclipse.core.runtime.IProgressMonitor;
  23 import org.eclipse.core.runtime.IStatus;
  24 import org.eclipse.core.runtime.OperationCanceledException;
  25 import org.eclipse.core.runtime.Status;
  26 import org.eclipse.jface.dialogs.IDialogSettings;
  27 import org.eclipse.jface.viewers.ILabelProvider;
  28 import org.eclipse.jface.viewers.LabelProvider;
  29 import org.eclipse.jface.window.Window;
  30 import org.eclipse.jface.wizard.WizardDialog;
  31 import org.eclipse.swt.SWT;
  32 import org.eclipse.swt.events.SelectionAdapter;
  33 import org.eclipse.swt.events.SelectionEvent;
  34 import org.eclipse.swt.events.SelectionListener;
  35 import org.eclipse.swt.graphics.Cursor;
  36 import org.eclipse.swt.widgets.Composite;
  37 import org.eclipse.swt.widgets.Control;
  38 import org.eclipse.swt.widgets.Link;
  39 import org.eclipse.swt.widgets.Shell;
  40 import org.eclipse.swt.widgets.Text;
  41 import org.eclipse.ui.IMemento;
  42
  43 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  44 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  45 import eu.etaxonomy.cdm.model.common.CdmBase;
  46 import eu.etaxonomy.cdm.model.common.ICdmBase;
  47 import eu.etaxonomy.cdm.model.common.IIdentifiableEntity;
  48 import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
  49 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  50 import eu.etaxonomy.taxeditor.model.MessagingUtils;
  51 import eu.etaxonomy.taxeditor.newWizard.AbstractNewEntityWizard;
  52 import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
  53 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
  54 import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
  55
  56 /**
  57  * <p>Abstract AbstractFilteredCdmResourceSelectionDialog class.</p>
  58  *
  59  * @author n.hoffmann
  60  * @created 04.06.2009
  61  * @version 1.0
  62  */
  63 public abstract class AbstractFilteredCdmResourceSelectionDialog<T extends ICdmBase> extends
  64                 CdmFilteredItemsSelectionDialog implements IConversationEnabled {
  65
  66         private final ConversationHolder conversation;
  67
  68         protected List<UuidAndTitleCache<T>> model;
  69         private final Set<T> transientCdmObjects = new HashSet<T>();
  70         private final String settings;
  71         protected final int limitOfInitialElements = 100;
  72
  73         protected T cdmBaseToBeFiltered;
  74
  75
  76         /**
  77          * <p>Constructor for AbstractFilteredCdmResourceSelectionDialog.</p>
  78          *
  79          * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
  80          * @param conversation
  81          * @param title a {@link java.lang.String} object.
  82          * @param multi a boolean.
  83          * @param settings a {@link java.lang.String} object.
  84          * @param cdmObject a T object.
  85          * @param <T> a T object.
  86          */
  87         protected AbstractFilteredCdmResourceSelectionDialog(Shell shell, ConversationHolder conversation, String title, boolean multi, String settings, T cdmObject) {
  88                 super(shell, multi);
  89                 setTitle(title);
  90                 setMessage("Use * for wildcard, or ? to see all entries");
  91                 this.settings = settings;
  92
  93                 this.conversation = conversation;
  94                 this.cdmBaseToBeFiltered = cdmObject;
  95                 Cursor cursor = shell.getCursor();
  96                 shell.setCursor(shell.getDisplay().getSystemCursor(SWT.CURSOR_WAIT));
  97                 init();
  98                 initModel();
  99                 shell.setCursor(cursor);
 100                 String objectTitle = getTitle(cdmObject);
 101                 if (objectTitle != null) {
 102                         setInitialPattern(objectTitle);
 103                 }
 104
 105                 setListLabelProvider(createListLabelProvider());
 106                 setDetailsLabelProvider(createDetailsLabelProvider());
 107
 108                 setSelectionHistory(new ResourceSelectionHistory());
 109         }
 110
 111         /**
 112          * By default, we are returning the standard list label provider
 113          *
 114          * Override in subclasses if you want different behavior
 115          *
 116          * @return
 117          */
 118         protected ILabelProvider createDetailsLabelProvider() {
 119                 return createListLabelProvider();
 120         }
 121
 122         /**
 123          *
 124          * @return
 125          */
 126         protected ILabelProvider createListLabelProvider() {
 127                 return new FilteredCdmResourceLabelProvider();
 128         }
 129
 130         /**
 131          * Override in subclasses.
 132          * Will run before initModel()
 133          */
 134         protected void init() {
 135
 136         }
 137
 138         /**
 139          * <p>getSelectionFromDialog</p>
 140          *
 141          * @param dialog a {@link eu.etaxonomy.taxeditor.ui.dialog.selection.AbstractFilteredCdmResourceSelectionDialog} object.
 142          * @param <TYPE> a TYPE object.
 143          * @return a TYPE object.
 144          */
 145         protected static <TYPE extends CdmBase> TYPE getSelectionFromDialog(AbstractFilteredCdmResourceSelectionDialog<TYPE> dialog) {
 146                 //dialog.setInitialPattern("");
 147                 int result = dialog.open();
 148
 149                 if (result == Window.CANCEL) {
 150                         return null;
 151                 }
 152
 153                 UUID uuid = dialog.getSelectedUuidAndTitleCache().getUuid();
 154                 if(uuid == null){
 155                         return null;
 156                 }
 157                 return dialog.getCdmObjectByUuid(uuid);
 158         }
 159
 160         /**
 161          * Check if object was created during the life of this dialog. If not,
 162          * retrieve it from the CdmStore.
 163          *
 164          * @param cdmUuid a {@link java.util.UUID} object.
 165          * @return a T object.
 166          */
 167         protected T getCdmObjectByUuid(UUID cdmUuid) {
 168                 for (T cdmObject : transientCdmObjects) {
 169                         if (cdmObject.getUuid().equals(cdmUuid)) {
 170                                 return cdmObject;
 171                         }
 172                 }
 173                 return getPersistentObject(cdmUuid);
 174         }
 175
 176         /**
 177          * <p>getPersistentObject</p>
 178          *
 179          * @param uuid a {@link java.util.UUID} object.
 180          * @return a T object.
 181          */
 182         abstract protected T getPersistentObject(UUID uuid);
 183
 184         /**
 185          * @param cdmObject
 186          */
 187 //      protected void addObjectToModel(T cdmObject) {
 188 //              model.add(new UuidAndTitleCache(cdmObject.getClass(), cdmObject.getUuid(), getTitle(cdmObject)));
 189 //              transientCdmObjects.add(cdmObject);
 190 //      }
 191
 192         /**
 193          * <p>isObjectTransient</p>
 194          *
 195          * @param cdmObject a T object.
 196          * @return a boolean.
 197          */
 198         protected boolean isObjectTransient(T cdmObject) {
 199                 return (getPersistentObject(cdmObject.getUuid()) == null);
 200         }
 201
 202         /**
 203          * <p>getTitle</p>
 204          *
 205          * @param cdmObject a T object.
 206          * @return a {@link java.lang.String} object.
 207          */
 208         protected String getTitle(T cdmObject) {
 209                 if(cdmObject == null){
 210                         return "";
 211                 }
 212
 213                 if (cdmObject instanceof IIdentifiableEntity) {
 214                         return ((IIdentifiableEntity) cdmObject).getTitleCache();
 215                 }
 216
 217                 throw new IllegalArgumentException("Generic method only" +
 218                                 " supports cdmObject of type IIdentifiableEntity." +
 219                                 " Please implement specific method in subclass.");
 220         }
 221
 222
 223         /** {@inheritDoc} */
 224         @Override
 225         public void refresh() {
 226                 initModel();
 227                 filterExcludedObjects();
 228                 super.refresh();
 229         }
 230
 231         /**
 232          * <p>initModel</p>
 233          */
 234         abstract protected void initModel();
 235
 236         /* (non-Javadoc)
 237          * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createFilter()
 238          */
 239         /** {@inheritDoc} */
 240         @Override
 241         protected ItemsFilter createFilter() {
 242                 return new ItemsFilter() {
 243
 244                         /**
 245                          * Always returns false to enforce refiltering even if the pattern is equal
 246                          */
 247                         @Override
 248                         public boolean equalsFilter(ItemsFilter filter) {
 249                                 return false;
 250                         }
 251
 252                         @Override
 253                         public boolean isConsistentItem(Object item) {
 254                                 return false;
 255                         }
 256
 257                         @Override
 258                         public boolean matchItem(Object item) {
 259                                 String text = null;
 260                                 if(item instanceof UuidAndTitleCache){
 261                                         text = ((UuidAndTitleCache) item).getTitleCache();
 262                                 }else if(item instanceof String){
 263                                         text = (String) item;
 264                                 }
 265                                 return text != null ? matches(text) : false;
 266                         }
 267
 268                 };
 269         }
 270
 271
 272         /**
 273          * Set the filter input to the Agent's title cache
 274          *
 275          * @param cdmObject a T object.
 276          */
 277         protected void setPattern(T cdmObject) {
 278                 // FilteredSelection does some very tricky caching to make sure it
 279                 // runs with high performance.
 280                 // This works for most use cases, but we want to change the model while the dialog is open
 281                 // and all the clever caching prevents the content provider from knowing that the model has changed
 282                 // I am aware, that this is a hack, but the FilteredSelectionDialog API does not offer a convenient
 283                 // way to solve the problem.
 284                 try {
 285                         Field lastCompletedFilter = this.getClass().getSuperclass().getSuperclass().getDeclaredField("lastCompletedFilter");
 286                         lastCompletedFilter.setAccessible(true);
 287                         lastCompletedFilter.set(this, null);
 288                 } catch (SecurityException e) {
 289                         MessagingUtils.error(getClass(), e);
 290                 } catch (NoSuchFieldException e) {
 291                         MessagingUtils.error(getClass(), e);
 292                 } catch (IllegalArgumentException e) {
 293                         MessagingUtils.error(getClass(), e);
 294                 } catch (IllegalAccessException e) {
 295                         MessagingUtils.error(getClass(), e);
 296                 }
 297
 298                 // this also is not the nicest way to do it.
 299                 // I am still amazed, that FilteredSelectionDialog does not offer any methods to change its data
 300                 // once it was opened. Am I doing it wrong?
 301                 String pattern = getTitle(cdmObject);
 302                 ((Text) getPatternControl()).setText(pattern);
 303         }
 304
 305
 306
 307         /* (non-Javadoc)
 308         * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter, org.eclipse.core.runtime.IProgressMonitor)
 309         */
 310         /** {@inheritDoc} */
 311         @Override
 312         protected void fillContentProvider(AbstractContentProvider contentProvider,
 313                 ItemsFilter itemsFilter, IProgressMonitor progressMonitor)
 314                 throws CoreException {
 315                 try {
 316                         if(model != null){
 317                                 progressMonitor.beginTask("Looking for entities", model.size());
 318                                 for(UuidAndTitleCache<T> element : model){
 319                                         contentProvider.add(element, itemsFilter);
 320                                         if (progressMonitor.isCanceled()) {
 321                                                 throw new OperationCanceledException();
 322                                         }
 323                                         progressMonitor.worked(1);
 324                                 }
 325                         }else{
 326                                 MessagingUtils.warn(getClass(), "Model for Filtered Selection is null:" + this.getClass().getSimpleName());
 327                         }
 328                 }
 329                 finally {
 330                         progressMonitor.done();
 331                 }
 332         }
 333
 334         /* (non-Javadoc)
 335          * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getDialogSettings()
 336          */
 337         /** {@inheritDoc} */
 338         @Override
 339         protected IDialogSettings getDialogSettings() {
 340                 IDialogSettings settings = TaxeditorStorePlugin.getDefault().getDialogSettings().getSection(getSettings());
 341
 342                 if (settings == null) {
 343                         settings = TaxeditorStorePlugin.getDefault().getDialogSettings().addNewSection(getSettings());
 344                 }
 345                 return settings;
 346         }
 347
 348         /* (non-Javadoc)
 349          * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getElementName(java.lang.Object)
 350          */
 351         /** {@inheritDoc} */
 352         @Override
 353         public String getElementName(Object item) {
 354                 return ((UuidAndTitleCache) item).getTitleCache();
 355         }
 356
 357         /* (non-Javadoc)
 358          * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getItemsComparator()
 359          */
 360         /** {@inheritDoc} */
 361         @Override
 362         protected Comparator getItemsComparator() {
 363                 return new Comparator<UuidAndTitleCache>() {
 364                         @Override
 365                         public int compare(UuidAndTitleCache entity1,
 366                                         UuidAndTitleCache entity2) {
 367                                 Collator collator = Collator.getInstance();
 368                                 return collator.compare(entity1.getTitleCache(), entity2.getTitleCache());
 369                         }
 370                 };
 371         }
 372
 373         /* (non-Javadoc)
 374          * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#validateItem(java.lang.Object)
 375          */
 376         /** {@inheritDoc} */
 377         @Override
 378         protected IStatus validateItem(Object item) {
 379                 return Status.OK_STATUS;
 380         }
 381
 382         /**
 383          * <p>getSelectedUuidAndTitleCache</p>
 384          *
 385          * @return a {@link eu.etaxonomy.cdm.model.common.UuidAndTitleCache} object.
 386          */
 387         protected UuidAndTitleCache getSelectedUuidAndTitleCache() {
 388                 Object[] result = getResult();
 389                 return result[0] == null ? null : (UuidAndTitleCache) result[0];
 390         }
 391
 392         /**
 393          * <p>Getter for the field <code>settings</code>.</p>
 394          *
 395          * @return a {@link java.lang.String} object.
 396          */
 397         public String getSettings()  {
 398                 if(settings == null){
 399                         throw new IllegalStateException("No SETTINGS set.");
 400                 }
 401                 return settings;
 402         }
 403
 404         /**
 405          *
 406          * @author n.hoffmann
 407          * @created Oct 19, 2009
 408          * @version 1.0
 409          */
 410         private class ResourceSelectionHistory extends SelectionHistory {
 411             /*
 412             * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#restoreItemFromMemento(org.eclipse.ui.IMemento)
 413                 */
 414                 @Override
 415                 protected Object restoreItemFromMemento(IMemento element) {
 416                         return element.getString("resource"); //$NON-NLS-1$
 417                 }
 418                 /*
 419                  * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#storeItemToMemento(java.lang.Object,
 420                  *      org.eclipse.ui.IMemento)
 421                  */
 422                 @Override
 423                 protected void storeItemToMemento(Object item, IMemento element) {
 424                         element.putString("resource", item.toString()); //$NON-NLS-1$
 425                 }
 426         }
 427
 428         /**
 429          * <p>getNewWizardLinkText</p>
 430          *
 431          * @return a {@link java.lang.String} object.
 432          */
 433         protected abstract String getNewWizardLinkText();
 434
 435         /**
 436          * <p>getNewEntityWizard</p>
 437          * @param parameter
 438          * @return a {@link eu.etaxonomy.taxeditor.newWizard.AbstractNewEntityWizard} object.
 439          */
 440         protected abstract AbstractNewEntityWizard getNewEntityWizard(String parameter);
 441
 442         public class FilteredCdmResourceLabelProvider extends LabelProvider {
 443                 @Override
 444                 public String getText(Object element) {
 445                         if (element == null) {
 446                                 return null;
 447                         }
 448                         UuidAndTitleCache uuidAndTitleCache = (UuidAndTitleCache) element;
 449                         String titleCache = uuidAndTitleCache.getTitleCache();
 450                         if(PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.SHOW_ID_IN_ENTITY_SELECTION_DIAOLOG)){
 451                             titleCache += " ["+uuidAndTitleCache.getId()+"]";
 452                         }
 453             return titleCache;
 454                 }
 455         };
 456
 457         /* (non-Javadoc)
 458         * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createExtendedContentArea(org.eclipse.swt.widgets.Composite)
 459         */
 460         /** {@inheritDoc} */
 461         @Override
 462         protected Control createExtendedContentArea(Composite parent) {
 463                 String newWizardLinkText = getNewWizardLinkText();
 464         if(newWizardLinkText != null){
 465                         Link link = new Link(parent, SWT.NONE);
 466                         link.setText(newWizardLinkText);
 467                         link.addSelectionListener(getNewWizardLinkSelectionListener());
 468                         return link;
 469                 }
 470                 return null;
 471         }
 472
 473         protected SelectionListener getNewWizardLinkSelectionListener(){
 474                 return new SelectionAdapter() {
 475
 476                         /* (non-Javadoc)
 477                          * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
 478                          */
 479                         @Override
 480                         public void widgetSelected(SelectionEvent e) {
 481
 482                             AbstractNewEntityWizard wizard = getNewEntityWizard(e.text);
 483                             if(wizard!=null){
 484                                 wizard.init(null, null);
 485                                 if(wizard.getEntity() != null) {
 486                                     WizardDialog dialog = new WizardDialog(getShell(), wizard);
 487                                     int status = dialog.open();
 488
 489                                     if (status == IStatus.OK) {
 490
 491                                         T entity = (T) wizard.getEntity();
 492                                         model.add(new UuidAndTitleCache<T>(entity.getUuid(),
 493                                                 entity.getId(),
 494                                                 getTitle(entity)));
 495                                         refresh();
 496                                         setPattern(entity);
 497                                         getConversationHolder().bind();
 498                                     }
 499                                     //FIXME : Need to make sure this is a stable fix (ticket 3822)
 500                                     getConversationHolder().commit();
 501                                 }
 502                             }
 503                         }
 504                 };
 505         }
 506
 507         /**
 508          * <p>getConversationHolder</p>
 509          *
 510          * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
 511          */
 512         @Override
 513         public ConversationHolder getConversationHolder() {
 514                 return conversation;
 515         }
 516
 517         /** {@inheritDoc} */
 518         @Override
 519         public void update(CdmDataChangeMap changeEvents) {}
 520
 521         /**
 522          * Don't want to add for example a taxon or synonym to itself
 523          * so filter the list to remove the taxon in question
 524          * (<code>cdmBaseToBeFiltered</code>)
 525          * so it is not available in the filtered list.
 526          */
 527         private void filterExcludedObjects() {
 528                 if (model != null && cdmBaseToBeFiltered != null) {
 529
 530                         UuidAndTitleCache uuidAndTitleCacheToRemove = null;
 531
 532                         for (UuidAndTitleCache uuidAndTitleCache : model){
 533                                 if ((cdmBaseToBeFiltered.getUuid()).equals(uuidAndTitleCache.getUuid())) {
 534                                         uuidAndTitleCacheToRemove = uuidAndTitleCache;
 535                                 }
 536                         }
 537                         model.remove(uuidAndTitleCacheToRemove);
 538                 }
 539         }
 540 }