3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
11 package eu
.etaxonomy
.taxeditor
.ui
.dialogs
.filteredSelection
;
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
;
19 import java
.util
.UUID
;
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
.widgets
.Composite
;
36 import org
.eclipse
.swt
.widgets
.Control
;
37 import org
.eclipse
.swt
.widgets
.Link
;
38 import org
.eclipse
.swt
.widgets
.Shell
;
39 import org
.eclipse
.swt
.widgets
.Text
;
40 import org
.eclipse
.ui
.IMemento
;
41 import org
.eclipse
.ui
.dialogs
.FilteredItemsSelectionDialog
;
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
.model
.common
.UuidAndTitleCache
;
49 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
50 import eu
.etaxonomy
.taxeditor
.newWizard
.AbstractNewEntityWizard
;
51 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
52 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
55 * <p>Abstract AbstractFilteredCdmResourceSelectionDialog class.</p>
61 public abstract class AbstractFilteredCdmResourceSelectionDialog
<T
extends ICdmBase
> extends
62 FilteredItemsSelectionDialog
implements IConversationEnabled
{
64 private ConversationHolder conversation
;
66 protected List
<UuidAndTitleCache
<T
>> model
;
67 private Set
<T
> transientCdmObjects
= new HashSet
<T
>();
68 private String settings
;
71 * <p>Constructor for AbstractFilteredCdmResourceSelectionDialog.</p>
73 * @param shell a {@link org.eclipse.swt.widgets.Shell} object.
75 * @param title a {@link java.lang.String} object.
76 * @param multi a boolean.
77 * @param settings a {@link java.lang.String} object.
78 * @param cdmObject a T object.
79 * @param <T> a T object.
81 protected AbstractFilteredCdmResourceSelectionDialog(Shell shell
, ConversationHolder conversation
, String title
, boolean multi
, String settings
, T cdmObject
) {
84 setMessage("Use * for wildcard, or ? to see all entries");
85 this.settings
= settings
;
87 this.conversation
= conversation
;
93 String objectTitle
= getTitle(cdmObject
);
94 if (objectTitle
!= null) {
95 setInitialPattern(objectTitle
);
98 setListLabelProvider(createListLabelProvider());
99 setDetailsLabelProvider(createDetailsLabelProvider());
101 setSelectionHistory(new ResourceSelectionHistory());
105 * By default, we are returning the standard list label provider
107 * Override in subclasses if you want different behavior
111 protected ILabelProvider
createDetailsLabelProvider() {
112 return createListLabelProvider();
119 protected ILabelProvider
createListLabelProvider() {
120 return new FilteredCdmResourceLabelProvider();
124 * Override in subclasses.
125 * Will run before initModel()
127 protected void init() {
132 * <p>getSelectionFromDialog</p>
134 * @param dialog a {@link eu.etaxonomy.taxeditor.ui.dialogs.filteredSelection.AbstractFilteredCdmResourceSelectionDialog} object.
135 * @param <TYPE> a TYPE object.
136 * @return a TYPE object.
138 protected static <TYPE
extends CdmBase
> TYPE
getSelectionFromDialog(AbstractFilteredCdmResourceSelectionDialog
<TYPE
> dialog
) {
139 //dialog.setInitialPattern("");
140 int result
= dialog
.open();
142 if (result
== Window
.CANCEL
) {
146 UUID uuid
= dialog
.getSelectedUuidAndTitleCache().getUuid();
150 return dialog
.getCdmObjectByUuid(uuid
);
154 * Check if object was created during the life of this dialog. If not,
155 * retrieve it from the CdmStore.
157 * @param cdmUuid a {@link java.util.UUID} object.
158 * @return a T object.
160 protected T
getCdmObjectByUuid(UUID cdmUuid
) {
161 for (T cdmObject
: transientCdmObjects
) {
162 if (cdmObject
.getUuid().equals(cdmUuid
)) {
166 return getPersistentObject(cdmUuid
);
170 * <p>getPersistentObject</p>
172 * @param uuid a {@link java.util.UUID} object.
173 * @return a T object.
175 abstract protected T
getPersistentObject(UUID uuid
);
180 // protected void addObjectToModel(T cdmObject) {
181 // model.add(new UuidAndTitleCache(cdmObject.getClass(), cdmObject.getUuid(), getTitle(cdmObject)));
182 // transientCdmObjects.add(cdmObject);
186 * <p>isObjectTransient</p>
188 * @param cdmObject a T object.
191 protected boolean isObjectTransient(T cdmObject
) {
192 return (getPersistentObject(cdmObject
.getUuid()) == null);
198 * @param cdmObject a T object.
199 * @return a {@link java.lang.String} object.
201 protected String
getTitle(T cdmObject
) {
202 if (cdmObject
instanceof IIdentifiableEntity
) {
203 return ((IIdentifiableEntity
) cdmObject
).getTitleCache();
205 throw new IllegalArgumentException("Generic method only" +
206 " supports cdmObject of type IIdentifiableEntity." +
207 " Please implement specific method in subclass.");
213 public void refresh() {
221 abstract protected void initModel();
224 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createFilter()
228 protected ItemsFilter
createFilter() {
229 return new ItemsFilter() {
232 * Always returns false to enforce refiltering even if the pattern is equal
235 public boolean equalsFilter(ItemsFilter filter
) {
240 public boolean isConsistentItem(Object item
) {
245 public boolean matchItem(Object item
) {
247 if(item
instanceof UuidAndTitleCache
){
248 text
= ((UuidAndTitleCache
) item
).getTitleCache();
249 }else if(item
instanceof String
){
250 text
= (String
) item
;
252 return text
!= null ?
matches(text
) : false;
260 * Set the filter input to the Agent's title cache
262 * @param cdmObject a T object.
264 protected void setPattern(T cdmObject
) {
265 // FilteredSelection does some very tricky caching to make sure it
266 // runs with high performance.
267 // This works for most use cases, but we want to change the model while the dialog is open
268 // and all the clever caching prevents the content provider from knowing that the model has changed
269 // I am aware, that this is a hack, but the FilteredSelectionDialog API does not offer a convenient
270 // way to solve the problem.
272 Field lastCompletedFilter
= this.getClass().getSuperclass().getSuperclass().getDeclaredField("lastCompletedFilter");
273 lastCompletedFilter
.setAccessible(true);
274 lastCompletedFilter
.set(this, null);
275 } catch (SecurityException e
) {
276 StoreUtil
.error(getClass(), e
);
277 } catch (NoSuchFieldException e
) {
278 StoreUtil
.error(getClass(), e
);
279 } catch (IllegalArgumentException e
) {
280 StoreUtil
.error(getClass(), e
);
281 } catch (IllegalAccessException e
) {
282 StoreUtil
.error(getClass(), e
);
285 // this also is not the nicest way to do it.
286 // I am still amazed, that FilteredSelectionDialog does not offer any methods to change its data
287 // once it was opened. Am I doing it wrong?
288 String pattern
= getTitle(cdmObject
);
289 ((Text
) getPatternControl()).setText(pattern
);
293 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#fillContentProvider(org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.AbstractContentProvider, org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.ItemsFilter, org.eclipse.core.runtime.IProgressMonitor)
297 protected void fillContentProvider(AbstractContentProvider contentProvider
,
298 ItemsFilter itemsFilter
, IProgressMonitor progressMonitor
)
299 throws CoreException
{
302 progressMonitor
.beginTask("Looking for entities", model
.size());
303 for(UuidAndTitleCache
<T
> element
: model
){
304 contentProvider
.add(element
, itemsFilter
);
305 if (progressMonitor
.isCanceled()) {
306 throw new OperationCanceledException();
308 progressMonitor
.worked(1);
311 StoreUtil
.warn(getClass(), "Model for Filtered Selection is null:" + this.getClass().getSimpleName());
315 progressMonitor
.done();
320 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getDialogSettings()
324 protected IDialogSettings
getDialogSettings() {
325 IDialogSettings settings
= TaxeditorStorePlugin
.getDefault().getDialogSettings().getSection(getSettings());
327 if (settings
== null) {
328 settings
= TaxeditorStorePlugin
.getDefault().getDialogSettings().addNewSection(getSettings());
334 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getElementName(java.lang.Object)
338 public String
getElementName(Object item
) {
339 return ((UuidAndTitleCache
) item
).getTitleCache();
343 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#getItemsComparator()
347 protected Comparator
getItemsComparator() {
348 return new Comparator
<UuidAndTitleCache
>() {
349 public int compare(UuidAndTitleCache entity1
,
350 UuidAndTitleCache entity2
) {
351 Collator collator
= Collator
.getInstance();
352 return collator
.compare(entity1
.getTitleCache(), entity2
.getTitleCache());
358 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#validateItem(java.lang.Object)
362 protected IStatus
validateItem(Object item
) {
363 return Status
.OK_STATUS
;
367 * <p>getSelectedUuidAndTitleCache</p>
369 * @return a {@link eu.etaxonomy.cdm.model.common.UuidAndTitleCache} object.
371 protected UuidAndTitleCache
getSelectedUuidAndTitleCache() {
372 Object
[] result
= getResult();
373 return result
[0] == null ?
null : (UuidAndTitleCache
) result
[0];
377 * <p>Getter for the field <code>settings</code>.</p>
379 * @return a {@link java.lang.String} object.
381 public String
getSettings() {
382 if(settings
== null){
383 throw new IllegalStateException("No SETTINGS set.");
391 * @created Oct 19, 2009
394 private class ResourceSelectionHistory
extends SelectionHistory
{
396 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#restoreItemFromMemento(org.eclipse.ui.IMemento)
398 protected Object
restoreItemFromMemento(IMemento element
) {
399 return element
.getString("resource"); //$NON-NLS-1$
402 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog.SelectionHistory#storeItemToMemento(java.lang.Object,
403 * org.eclipse.ui.IMemento)
405 protected void storeItemToMemento(Object item
, IMemento element
) {
406 element
.putString("resource", item
.toString()); //$NON-NLS-1$
411 * <p>getNewWizardLinkText</p>
413 * @return a {@link java.lang.String} object.
415 protected abstract String
getNewWizardLinkText();
418 * <p>getNewEntityWizard</p>
420 * @return a {@link eu.etaxonomy.taxeditor.newWizard.AbstractNewEntityWizard} object.
422 protected abstract AbstractNewEntityWizard
getNewEntityWizard(String parameter
);
424 public class FilteredCdmResourceLabelProvider
extends LabelProvider
{
425 public String
getText(Object element
) {
426 if (element
== null) {
429 return ((UuidAndTitleCache
) element
).getTitleCache();
434 * @see org.eclipse.ui.dialogs.FilteredItemsSelectionDialog#createExtendedContentArea(org.eclipse.swt.widgets.Composite)
438 protected Control
createExtendedContentArea(Composite parent
) {
439 if(getNewWizardLinkText() != null){
440 Link link
= new Link(parent
, SWT
.NONE
);
441 link
.setText(getNewWizardLinkText());
442 link
.addSelectionListener(getNewWizardLinkSelectionListener());
448 protected SelectionListener
getNewWizardLinkSelectionListener(){
449 return new SelectionAdapter() {
452 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
455 public void widgetSelected(SelectionEvent e
) {
457 AbstractNewEntityWizard wizard
= getNewEntityWizard(e
.text
);
458 wizard
.init(null, null);
459 WizardDialog dialog
= new WizardDialog(getShell(), wizard
);
460 int status
= dialog
.open();
462 if (status
== IStatus
.OK
) {
464 T entity
= (T
) wizard
.getEntity();
466 // addObjectToModel(teamOrPerson);
476 * <p>getConversationHolder</p>
478 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
480 public ConversationHolder
getConversationHolder() {
485 public void update(CdmDataChangeMap changeEvents
) {}