eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/selection/EntitySelectionElement.java

   1 /**
   2  *
   3  */
   4 package eu.etaxonomy.taxeditor.ui.selection;
   5
   6 import java.util.EnumSet;
   7 import java.util.Observable;
   8 import java.util.Observer;
   9
  10 import org.eclipse.core.runtime.IStatus;
  11 import org.eclipse.core.runtime.NullProgressMonitor;
  12 import org.eclipse.jface.wizard.WizardDialog;
  13 import org.eclipse.swt.SWT;
  14 import org.eclipse.swt.events.SelectionAdapter;
  15 import org.eclipse.swt.events.SelectionEvent;
  16 import org.eclipse.swt.events.SelectionListener;
  17 import org.eclipse.swt.graphics.Color;
  18 import org.eclipse.swt.widgets.Button;
  19 import org.eclipse.swt.widgets.Composite;
  20 import org.eclipse.swt.widgets.Label;
  21 import org.eclipse.swt.widgets.Shell;
  22 import org.eclipse.swt.widgets.Text;
  23 import org.springframework.security.core.GrantedAuthority;
  24
  25 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  26 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  27 import eu.etaxonomy.cdm.api.service.IAgentService;
  28 import eu.etaxonomy.cdm.api.service.ICollectionService;
  29 import eu.etaxonomy.cdm.api.service.INameService;
  30 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  31 import eu.etaxonomy.cdm.api.service.IReferenceService;
  32 import eu.etaxonomy.cdm.api.service.IService;
  33 import eu.etaxonomy.cdm.api.service.IUserService;
  34 import eu.etaxonomy.cdm.api.service.molecular.IAmplificationService;
  35 import eu.etaxonomy.cdm.api.service.molecular.IPrimerService;
  36 import eu.etaxonomy.cdm.common.CdmUtils;
  37 import eu.etaxonomy.cdm.model.agent.Institution;
  38 import eu.etaxonomy.cdm.model.agent.Person;
  39 import eu.etaxonomy.cdm.model.agent.Team;
  40 import eu.etaxonomy.cdm.model.common.CdmBase;
  41 import eu.etaxonomy.cdm.model.common.Group;
  42 import eu.etaxonomy.cdm.model.common.ICdmBase;
  43 import eu.etaxonomy.cdm.model.common.IIdentifiableEntity;
  44 import eu.etaxonomy.cdm.model.common.User;
  45 import eu.etaxonomy.cdm.model.molecular.Amplification;
  46 import eu.etaxonomy.cdm.model.molecular.Primer;
  47 import eu.etaxonomy.cdm.model.name.NonViralName;
  48 import eu.etaxonomy.cdm.model.occurrence.Collection;
  49 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  50 import eu.etaxonomy.cdm.model.reference.Reference;
  51 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  52 import eu.etaxonomy.cdm.persistence.hibernate.permission.CRUD;
  53 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  54 import eu.etaxonomy.taxeditor.model.ImageResources;
  55 import eu.etaxonomy.taxeditor.model.MessagingUtils;
  56 import eu.etaxonomy.taxeditor.preference.Resources;
  57 import eu.etaxonomy.taxeditor.store.CdmStore;
  58 import eu.etaxonomy.taxeditor.store.LoginManager;
  59 import eu.etaxonomy.taxeditor.store.StoreUtil;
  60 import eu.etaxonomy.taxeditor.ui.dialog.selection.SelectionDialogFactory;
  61 import eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement;
  62 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
  63 import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
  64 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
  65 import eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement;
  66 import eu.etaxonomy.taxeditor.ui.element.IEntityElement;
  67 import eu.etaxonomy.taxeditor.ui.element.ILabeledElement;
  68 import eu.etaxonomy.taxeditor.ui.element.ISelectableElement;
  69 import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;
  70 import eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator;
  71 import eu.etaxonomy.taxeditor.ui.section.grantedAuthority.GrantedAuthorityLabelTextProvider;
  72
  73 /**
  74  * <p>
  75  * Abstract AbstractSelectionElement class.
  76  * </p>
  77  *
  78  * @author n.hoffmann
  79  * @created Nov 17, 2009
  80  * @version 1.0
  81  * @param <T>
  82  */
  83 public class EntitySelectionElement<T extends ICdmBase> extends
  84                 AbstractCdmFormElement implements  SelectionListener, IEnableableFormElement, ISelectableElement, IEntityElement<T>, ILabeledElement, IConversationEnabled, Observer {
  85
  86         private static final EnumSet<CRUD> UPDATE = EnumSet.of(CRUD.UPDATE);
  87         private static final EnumSet<CRUD> DELETE = EnumSet.of(CRUD.DELETE);
  88         private static final EnumSet<CRUD> CREATE = EnumSet.of(CRUD.CREATE);
  89
  90         /**
  91          * Bitmask for configuring functionality of selection element
  92          */
  93         public static final int NOTHING = 0; // 000
  94         public static final int EDITABLE = 1 << 0; // 001
  95         public static final int DELETABLE = 1 << 1; // 010
  96         public static final int SELECTABLE = 1 << 2; // 100
  97         public static final int ALL = EDITABLE | DELETABLE | SELECTABLE; // 111
  98
  99         protected T entity;
 100
 101         protected Label label;
 102         protected Text text;
 103         protected Button button_selection;
 104
 105         private SelectionArbitrator selectionArbitrator;
 106
 107         protected Button button_edit;
 108
 109         private final String labelString;
 110
 111         private Composite selectableComposite;
 112
 113         private Button button_remove;
 114
 115         private final boolean isEditable;
 116
 117         private final boolean isDeletable;
 118
 119         private final ConversationHolder conversation;
 120         private Class<T> clazz;
 121
 122         /**
 123          * <p>
 124          * Constructor for AbstractSelectionElement.
 125          * </p>
 126          *
 127          * @param formFactory
 128          *            a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
 129          *            object.
 130          * @param conversation
 131          *            TODO
 132          * @param parentElement
 133          *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
 134          *            object.
 135          * @param labelString
 136          *            a {@link java.lang.String} object.
 137          * @param entity
 138          *            a T object.
 139          * @param isEditable
 140          *            a boolean.
 141          * @param isSelectable
 142          *            a boolean.
 143          * @param isDeletable
 144          *            a boolean.
 145          * @param style
 146          *            a int.
 147          * @param <T>
 148          *            a T object.
 149          */
 150         public EntitySelectionElement(CdmFormFactory formFactory,
 151                         ConversationHolder conversation, ICdmFormElement parentElement,
 152                         String labelString, T entity, int mode, int style) {
 153                 super(formFactory, parentElement);
 154
 155                 this.isEditable = (mode & EDITABLE) == EDITABLE;
 156                 this.isDeletable = (mode & DELETABLE) == DELETABLE;
 157                 boolean isSelectable = (mode & SELECTABLE) == SELECTABLE;
 158
 159                 this.labelString = (labelString == null || labelString.equals("")) ? "" : labelString + " : ";
 160
 161                 this.conversation = conversation;
 162
 163                 if (isSelectable && formFactory.getSelectionProvider() != null) {
 164                         selectionArbitrator = formFactory.createSelectionArbitrator(this);
 165                 }
 166
 167                 createControls(getLayoutComposite(), SWT.NULL);
 168
 169                 setEntity(entity);
 170         }
 171
 172         public EntitySelectionElement(CdmFormFactory formFactory,
 173                         ConversationHolder conversation, ICdmFormElement parentElement, Class<T> clazz,
 174                         String labelString, T entity, int mode, int style) {
 175                 this(formFactory, conversation, parentElement, labelString, entity, mode, style);
 176                 this.clazz = clazz;
 177         }
 178
 179         private void createControls(Composite parent, int style) {
 180
 181                 label = formFactory.createLabel(getLayoutComposite(), labelString,
 182                                 SWT.NULL);
 183
 184                 addControl(label);
 185
 186                 selectableComposite = formFactory.createComposite(getLayoutComposite());
 187
 188                 int columns = 2;
 189                 if (isEditable) {
 190                         columns += 1;
 191                 }
 192                 if (isDeletable) {
 193                         columns += 1;
 194                 }
 195
 196                 selectableComposite.setLayout(LayoutConstants.LAYOUT(columns, false));
 197                 selectableComposite.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
 198
 199                 addControl(selectableComposite);
 200
 201                 text = formFactory.createText(selectableComposite, null, SWT.WRAP);
 202                 text.setEditable(false);
 203                 addControl(text);
 204
 205                 text.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());
 206                 text.setBackground(StoreUtil
 207                                 .getColor(Resources.COLOR_TEXT_DISABLED_BACKGROUND));
 208
 209                 button_selection = formFactory.createButton(selectableComposite, null,
 210                                 SWT.PUSH);
 211                 button_selection.setImage(ImageResources
 212                                 .getImage(ImageResources.BROWSE_ICON));
 213                 button_selection.setToolTipText("Browse existing");
 214
 215                 addControl(button_selection);
 216                 button_selection.addSelectionListener(this);
 217
 218                 if (isEditable) {
 219                         button_edit = formFactory.createButton(selectableComposite, null,
 220                                         SWT.PUSH);
 221                         button_edit.setImage(ImageResources
 222                                         .getImage(ImageResources.EDIT_ICON));
 223                         button_edit.setToolTipText("Edit");
 224                         addControl(button_edit);
 225                         button_edit.addSelectionListener(new EditListener(this));
 226                 }
 227
 228                 if (isDeletable) {
 229                         button_remove = formFactory.createButton(selectableComposite, null,
 230                                         SWT.PUSH);
 231                         button_remove.setImage(ImageResources
 232                                         .getImage(ImageResources.TRASH_ICON));
 233                         button_remove.setToolTipText("Remove");
 234                         addControl(button_remove);
 235                         button_remove.addSelectionListener(new DeleteListener(this));
 236                 }
 237         }
 238
 239         @Override
 240     public void widgetSelected(SelectionEvent e) {
 241                 T selection = SelectionDialogFactory.getSelectionFromDialog(clazz, getShell(), getConversationHolder(), getEntity());
 242                 setSelectionInternal(selection);
 243         }
 244
 245         /**
 246          * Return the selected object
 247          *
 248          * @return a T object.
 249          */
 250         public T getSelection() {
 251                 return entity;
 252         }
 253
 254         /*
 255          * (non-Javadoc)
 256          *
 257          * @see
 258          * eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
 259          */
 260         /** {@inheritDoc} */
 261         @Override
 262         public void setEnabled(boolean enabled) {
 263                 button_selection.setEnabled(enabled);
 264                 if (isEditable) {
 265                         updateButtonStates();
 266                 }
 267         }
 268
 269         /* (non-Javadoc)
 270          * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#isEnabled()
 271          */
 272         @Override
 273         public boolean isEnabled() {
 274             return button_selection.isEnabled();
 275         }
 276
 277         /**
 278          * <p>
 279          * setSelectionInternal
 280          * </p>
 281          *
 282          * @param selection
 283          *            a T object.
 284          */
 285         protected void setSelectionInternal(T selection) {
 286                 if (selection != null && !selection.equals(this.entity)) {
 287                         setEntity(selection);
 288                         firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
 289                 }
 290         }
 291
 292         /**
 293          * <p>
 294          * Setter for the field <code>entity</code>.
 295          * </p>
 296          *
 297          * @param selection
 298          *            a T object.
 299          */
 300         public void setEntity(T selection) {
 301                 this.entity = selection;
 302                 updateElement();
 303         }
 304
 305         /**
 306          * Updates this elements view
 307          */
 308         protected void updateElement() {
 309                 String title = CdmUtils.Nz(getTitle());
 310                 text.setText(title); // title can be null
 311                 if (isEditable) {
 312                         updateButtonStates();
 313                 }
 314         }
 315
 316     public void updateFromWizard() {
 317                 updateElement();
 318                 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
 319         }
 320
 321         /**
 322          * <p>
 323          * getTitle
 324          * </p>
 325          *
 326          * @return a {@link java.lang.String} object.
 327          */
 328         protected String getTitle() {
 329                 if (entity != null){
 330                         if(entity instanceof IIdentifiableEntity) {
 331                                 return ((IIdentifiableEntity) entity).getTitleCache();
 332                         } else if(entity instanceof Group){
 333                                 return ((Group) entity).getName();
 334                         } else if(entity instanceof GrantedAuthority){
 335                                 return GrantedAuthorityLabelTextProvider.getText(((GrantedAuthority) entity));
 336                         } else if(entity instanceof User){
 337                 return ((User) entity).getUsername();
 338             } else if (entity instanceof Primer){
 339                 return ((Primer) entity).getLabel();
 340             } else if (entity instanceof Amplification){
 341                 return ((Amplification) entity).getLabelCache();
 342             }
 343
 344                 }
 345                 return "";
 346         }
 347
 348         /** {@inheritDoc} */
 349         @Override
 350         public void setSelected(boolean selected) {
 351                 setBackground(selected ? SELECTED : getPersistentBackground());
 352         }
 353
 354         /*
 355          * (non-Javadoc)
 356          *
 357          * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()
 358          */
 359         /**
 360          * <p>
 361          * Getter for the field <code>entity</code>.
 362          * </p>
 363          *
 364          * @return a T object.
 365          */
 366         @Override
 367         public T getEntity() {
 368                 return entity;
 369         }
 370
 371         /*
 372          * (non-Javadoc)
 373          *
 374          * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.ISelectableElement#
 375          * getSelectionArbitrator()
 376          */
 377         /**
 378          * <p>
 379          * Getter for the field <code>selectionArbitrator</code>.
 380          * </p>
 381          *
 382          * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator}
 383          *         object.
 384          */
 385         @Override
 386         public SelectionArbitrator getSelectionArbitrator() {
 387                 return selectionArbitrator;
 388         }
 389
 390         /**
 391          * Convenient access to current shell
 392          *
 393          * @return a {@link org.eclipse.swt.widgets.Shell} object.
 394          */
 395     public Shell getShell() {
 396                 return getLayoutComposite().getShell();
 397         }
 398
 399         /** {@inheritDoc} */
 400         @Override
 401         public void setIrrelevant(boolean irrelevant) {
 402                 String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT
 403                                 : Resources.COLOR_TEXT_DISABLED_BACKGROUND;
 404
 405                 Color color = StoreUtil.getColor(colorId);
 406                 text.setBackground(color);
 407         }
 408
 409         private class DeleteListener extends SelectionAdapter {
 410
 411                 private final EntitySelectionElement<T> selectionElement;
 412
 413                 public DeleteListener(EntitySelectionElement<T> selectionElement) {
 414                         this.selectionElement = selectionElement;
 415                 }
 416
 417                 @Override
 418                 public void widgetSelected(SelectionEvent e) {
 419                         setEntity(null);
 420                         firePropertyChangeEvent(new CdmPropertyChangeEvent(
 421                                         selectionElement, null));
 422                 }
 423         }
 424
 425         private class EditListener extends SelectionAdapter {
 426
 427         private static final String TRANSIENT_EDITING_WARNING_TEXT = "Warning: All changes for this element are directly reflected in the data base.\nThe \"Cancel\" button has no effect";
 428         private static final String TRANSIENT_EDITING_WARNING_TITLE = "CDM element not yet saved.";
 429         private final EntitySelectionElement<T> selectionElement;
 430
 431                 public EditListener(EntitySelectionElement<T> selectionElement) {
 432                         this.selectionElement = selectionElement;
 433                 }
 434
 435                 /** {@inheritDoc} */
 436                 @Override
 437                 public void widgetSelected(SelectionEvent e) {
 438                     T originalEntity = selectionElement.getEntity();
 439                     T clonedEntity = null;
 440                     IService<T> service = null;
 441                     if(originalEntity instanceof CdmBase){
 442                         //get corresponding service
 443                         if(entity instanceof Reference<?>){
 444                             service = (IService<T>) CdmStore.getService(IReferenceService.class);
 445                         }
 446                         else if (entity instanceof Team || entity instanceof Person || entity instanceof Institution) {
 447                             service = (IService<T>) CdmStore.getService(IAgentService.class);
 448                         }
 449                         else if (entity instanceof NonViralName) {
 450                             service = (IService<T>) CdmStore.getService(INameService.class);
 451                         }
 452                         else if (entity instanceof SpecimenOrObservationBase) {
 453                             service = (IService<T>) CdmStore.getService(IOccurrenceService.class);
 454                         }
 455                         else if (entity instanceof Collection) {
 456                             service = (IService<T>) CdmStore.getService(ICollectionService.class);
 457                         }
 458                         else if (entity instanceof User) {
 459                             service = (IService<T>) CdmStore.getService(IUserService.class);
 460                         }
 461                         else if (entity instanceof Primer) {
 462                             service = (IService<T>) CdmStore.getService(IPrimerService.class);
 463                         }
 464                         else if (entity instanceof Amplification) {
 465                             service = (IService<T>) CdmStore.getService(IAmplificationService.class);
 466                         }
 467                         //check if original already exists in data base. If not then do not clone and all changes will be persisted directly -> Warning to user.
 468                 if(service !=null && service.find(originalEntity.getUuid())==null && originalEntity.getId() != 0){
 469                     if(MessagingUtils.confirmDialog(TRANSIENT_EDITING_WARNING_TITLE, "["+originalEntity.getClass().getSimpleName()+"]"+originalEntity + " has to be saved before it can be edited. Save now?")){
 470                         service.save(originalEntity);
 471                         AbstractUtility.getActiveEditor().doSave(new NullProgressMonitor());
 472                     }
 473                     else{
 474                         //transient CDM elements should not be edited to avoid merge conflicts
 475                         // when the elements are cascaded
 476                         return;
 477                     }
 478                 }
 479                 else{
 480                     //FIXME temporarily disabled cloning re-opening bug #2645 (EditFromSelectionWizard persists data even when canceled)
 481 //                    try {
 482 //                        //clone original
 483 //                        clonedEntity = (T) ((CdmBase) originalEntity).clone();
 484 //                    } catch (CloneNotSupportedException e1) {
 485 //                        MessagingUtils.warningDialog(TRANSIENT_EDITING_WARNING_TITLE, this, TRANSIENT_EDITING_WARNING_TEXT);
 486 //                    }
 487                 }
 488
 489                     }
 490                     if(clonedEntity!=null){
 491                         selectionElement.setEntity(clonedEntity);
 492                     }
 493                         WizardDialog dialog = new WizardDialog(selectionElement.getShell(),
 494                                         new EditFromSelectionWizard(selectionElement));
 495                         if (dialog.open() == IStatus.OK) {
 496                             if(service!=null && clonedEntity!=null){//check if cloning happened
 497                                 T editedClonedEntity = selectionElement.getEntity();
 498                                 editedClonedEntity.setId(originalEntity.getId());
 499                                 editedClonedEntity.setUuid(originalEntity.getUuid());
 500
 501                                 //merge clone and original
 502                                 service.merge(editedClonedEntity);
 503                                 originalEntity = service.load(originalEntity.getUuid());
 504
 505                             }
 506                             selectionElement.setEntity(originalEntity);
 507                                 selectionElement.updateFromWizard();
 508                         }
 509                         //be sure to reset to original in all cases
 510                         selectionElement.setEntity(originalEntity);
 511                         selectionElement.refresh();
 512                 }
 513         }
 514
 515         // not used
 516         /** {@inheritDoc} */
 517         @Override
 518         public void widgetDefaultSelected(SelectionEvent e) {
 519         }
 520
 521         /**
 522          * <p>
 523          * getConversationHolder
 524          * </p>
 525          *
 526          * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
 527          *         object.
 528          */
 529         @Override
 530         public ConversationHolder getConversationHolder() {
 531                 return conversation;
 532         }
 533
 534         /** {@inheritDoc} */
 535         @Override
 536         public void setBackground(Color color) {
 537             if(!label.isDisposed()){
 538                 label.setBackground(color);
 539             }
 540         }
 541
 542         /** {@inheritDoc} */
 543         @Override
 544         public void setLabel(String labelString) {
 545                 if (label != null) {
 546                         label.setText(labelString);
 547                 }
 548         }
 549
 550         /**
 551          * <p>
 552          * Getter for the field <code>label</code>.
 553          * </p>
 554          *
 555          * @return a {@link java.lang.String} object.
 556          */
 557         @Override
 558         public String getLabel() {
 559                 if (label != null) {
 560                         return label.getText() + " : ";
 561                 }
 562                 return null;
 563         }
 564
 565         /** {@inheritDoc} */
 566         @Override
 567         public void update(CdmDataChangeMap changeEvents) {
 568         }
 569
 570         /* (non-Javadoc)
 571          * @see eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement#removeElements()
 572          */
 573         @Override
 574     public void removeElements(){
 575                 super.removeElements();
 576                 LoginManager loginManager = CdmStore.getLoginManager();
 577                 loginManager.addObserver(this);
 578         }
 579
 580         @Override
 581         public void update(Observable o, Object arg) {
 582                 if(o instanceof LoginManager){
 583                         updateButtonStates();
 584                 }
 585         }
 586
 587         private void updateButtonStates() {
 588             if(button_edit != null && !button_selection.isDisposed()){
 589                 button_edit.setEnabled(isEditable && button_selection.isEnabled() && getEntity() != null  && CdmStore.currentAuthentiationHasPermission((CdmBase) getEntity(), UPDATE));
 590             }
 591         }
 592 }