Project

General

Profile

Download (20.7 KB) Statistics
| Branch: | Tag: | Revision:
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
package eu.etaxonomy.taxeditor.ui.section.reference;
10

    
11
import java.util.ArrayList;
12
import java.util.Arrays;
13
import java.util.List;
14

    
15
import org.eclipse.swt.SWT;
16
import org.joda.time.DateTime;
17

    
18
import eu.etaxonomy.cdm.model.agent.Institution;
19
import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
20
import eu.etaxonomy.cdm.model.reference.Reference;
21
import eu.etaxonomy.cdm.model.reference.ReferenceFactory;
22
import eu.etaxonomy.cdm.model.reference.ReferenceType;
23
import eu.etaxonomy.taxeditor.store.StoreUtil;
24
import eu.etaxonomy.taxeditor.ui.combo.EnumComboElement;
25
import eu.etaxonomy.taxeditor.ui.element.CacheRelevance;
26
import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
27
import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
28
import eu.etaxonomy.taxeditor.ui.element.DoiWithLabelElement;
29
import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
30
import eu.etaxonomy.taxeditor.ui.element.IErrorIntolerableElement;
31
import eu.etaxonomy.taxeditor.ui.element.IExceptionHandler;
32
import eu.etaxonomy.taxeditor.ui.element.LsidWithExceptionLabelElement;
33
import eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement;
34
import eu.etaxonomy.taxeditor.ui.element.ToggleableTextElement;
35
import eu.etaxonomy.taxeditor.ui.element.UriWithLabelElement;
36
import eu.etaxonomy.taxeditor.ui.element.VerbatimTimePeriodElement;
37
import eu.etaxonomy.taxeditor.ui.mvc.element.DateElement;
38
import eu.etaxonomy.taxeditor.ui.section.AbstractIdentifiableEntityDetailElement;
39
import eu.etaxonomy.taxeditor.ui.section.common.ExternalLinksSection;
40
import eu.etaxonomy.taxeditor.ui.selection.EntitySelectionElement;
41

    
42
/**
43
 * @author n.hoffmann
44
 * @created Mar 2, 2010
45
 */
46
public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElement<Reference>
47
		implements IErrorIntolerableElement, IExceptionHandler {
48

    
49
	boolean isNomenclaturalReference = false;
50

    
51
	private ToggleableTextElement toggleableAbbrevCache;
52

    
53
	private TextWithLabelElement text_edition;
54
	private TextWithLabelElement text_editor;
55
	private TextWithLabelElement text_isbn;
56
	private TextWithLabelElement text_issn;
57
	private TextWithLabelElement text_organisation;
58
	private TextWithLabelElement text_pages;
59
	private TextWithLabelElement text_placePublished;
60
	private TextWithLabelElement text_publisher;
61
	private TextWithLabelElement text_referenceAbstract;
62
	private TextWithLabelElement text_series;
63
//	private TextWithLabelElement text_seriesPart;
64
	private TextWithLabelElement text_volume;
65
	private TextWithLabelElement text_abbrevTitle;
66
	private TextWithLabelElement text_title;
67
	private DoiWithLabelElement text_doi;
68
	private UriWithLabelElement text_uri;
69
	private LsidWithExceptionLabelElement text_lsid;
70
	private DateElement text_accessed;
71
	private EntitySelectionElement<TeamOrPersonBase> selection_authorTeam;
72
	private VerbatimTimePeriodElement element_timePeriod;
73
	private EntitySelectionElement<Reference> selection_inReference;
74
	private EntitySelectionElement<Institution> selection_institution;
75
	private EnumComboElement<ReferenceType> combo_referenceType;
76
	private ExternalLinksSection externalLinks;
77
	private EntitySelectionElement<Reference> selection_inSeries;
78

    
79
    private void registerCacheElements() {
80
        registerCacheRelevance(text_edition, toggleable_cache, toggleableAbbrevCache);
81
        registerCacheRelevance(text_pages,   toggleable_cache);
82
        registerCacheRelevance(text_series,  toggleable_cache, toggleableAbbrevCache);
83
        registerCacheRelevance(text_volume,  toggleable_cache, toggleableAbbrevCache);
84
        registerCacheRelevance(text_abbrevTitle, toggleableAbbrevCache);
85
        registerCacheRelevance(text_title,   toggleable_cache);
86
        registerCacheRelevance(text_accessed, toggleable_cache, toggleableAbbrevCache);
87
        registerCacheRelevance(selection_authorTeam,  toggleable_cache, toggleableAbbrevCache);
88
        registerCacheRelevance(element_timePeriod,  toggleable_cache, toggleableAbbrevCache);
89
        registerCacheRelevance(selection_inReference, toggleable_cache, toggleableAbbrevCache);
90
        registerCacheRelevance(combo_referenceType,   toggleable_cache, toggleableAbbrevCache);
91
    }
92

    
93
	/**
94
	 * Constructor for ReferenceBaseDetailElement.
95
	 */
96
	public ReferenceDetailElement(CdmFormFactory cdmFormFactory,
97
			ICdmFormElement formElement, int style) {
98
		super(cdmFormFactory, formElement);
99
	}
100

    
101
	public ReferenceDetailElement(CdmFormFactory cdmFormFactory,
102
			ICdmFormElement formElement, boolean isNomenclaturalReference, int style) {
103
		this(cdmFormFactory, formElement, style);
104
		this.isNomenclaturalReference = isNomenclaturalReference;
105

    
106
	}
107
	public boolean isNomenclaturalReference() {
108
		return isNomenclaturalReference;
109
	}
110

    
111
	public void setNomenclaturalReference(boolean isNomenclaturalReference) {
112
		this.isNomenclaturalReference = isNomenclaturalReference;
113
	}
114

    
115
	@Override
116
	protected void createControls(ICdmFormElement formElement,
117
			Reference entity, int style) {
118
		setWarnForReferencingObjects(formElement);
119
		toggleable_cache = formFactory.createToggleableTextField(formElement,
120
				"Reference Cache", entity.getTitleCache(),
121
				entity.isProtectedTitleCache(), style);
122

    
123
		toggleableAbbrevCache = formFactory.createToggleableTextField(formElement,
124
		        "Nomencl. Cache", entity.getAbbrevTitleCache(),
125
		        entity.isProtectedAbbrevTitleCache(), CacheRelevance.CACHE2, style);
126

    
127
		combo_referenceType = formFactory.createEnumComboElement(ReferenceType.class,
128
						formElement, style);
129

    
130
		combo_referenceType.setSelection(entity.getType());
131

    
132
		// title
133
		text_title = formFactory.createMultiLineTextWithLabel(formElement,
134
				"Title",  60, style);
135
		text_title.setText(entity.getTitle());
136
		// abbreviated title
137
		text_abbrevTitle = formFactory.createTextWithLabelElement(formElement,
138
		        "Nomencl. Title", entity.getAbbrevTitle(), style);
139
		ReferenceType referenceType = entity.getType();
140
		// author team
141
		if(referenceType != null && !referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries) ) {
142
			if (isNomenclaturalReference){
143
				selection_authorTeam = formFactory
144
	            		.createSelectionElementWithAbbreviatedTitle(TeamOrPersonBase.class,
145
	            		        formElement, "Author",
146
	            				entity.getAuthorship(),
147
	            				EntitySelectionElement.ALL, style);
148
			}else{
149
	            selection_authorTeam = formFactory
150
	            		.createSelectionElement(TeamOrPersonBase.class,
151
	            		        formElement, "Author",
152
	            				entity.getAuthorship(),
153
	            				EntitySelectionElement.ALL, style);
154
			}
155
        }
156

    
157
		if (referenceType != null) {
158

    
159
			createInReferenceByType(this, referenceType, entity, SWT.NULL);
160

    
161
			if (referenceType.equals(ReferenceType.Generic)) {
162
				createGenericControls(this, entity, SWT.NULL);
163
				createPublicationControls(this, referenceType, entity, SWT.NULL);
164

    
165
			} else {
166
				if (referenceType.isPrintedUnit()) {
167
					createPrintedUnitControls(this, referenceType, entity,
168
							SWT.NULL);
169
				}
170
//				if (referenceType.equals(ReferenceType.Proceedings)) {
171
//				    text_isbn = formFactory.createTextWithLabelElement(this, "ISBN",
172
//		                    entity.getIsbn(), style);
173
//              }
174
				if (referenceType.isPublication()) {
175
					createPublicationControls(this, referenceType, entity,
176
							SWT.NULL);
177
				}
178
				if (referenceType.isVolumeReference()) {
179
					createVolumeControls(this, entity, SWT.NULL);
180
				}
181
				if (referenceType.isSection()) {
182
					createSectionControls(this, entity, SWT.NULL);
183
				}
184
			}
185
		}
186

    
187
		// date published
188
		if(referenceType != null && !referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries)){
189
		    element_timePeriod = formFactory.createVerbatimTimePeriodElement(formElement,
190
		            "Date Published", entity.getDatePublished(), style);
191
		}
192

    
193
		createUri(this, entity, SWT.NULL);
194

    
195
//		externalLinks = formFactory.createExternalLinksSection(getConversationHolder(), formElement, StoreUtil.getSectionStyle(ExternalLinksSection.class, DescriptionElementSource.class.getCanonicalName()));
196
//        externalLinks.setLayoutData(LayoutConstants.FILL_HORIZONTALLY(2, 3));
197
//        externalLinks.setEntity(entity);
198
//        externalLinks.setFont(AbstractUtility.getFont(Resources.COLOR_FONT_DEFAULT));
199
//        externalLinks.setEmptySectionString("No links yet.");
200

    
201
		if(referenceType != null && (!referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries) && !referenceType.equals(ReferenceType.PersonalCommunication))) {
202
            text_doi = formFactory.createDoiWithLabelElement(formElement, "DOI", entity.getDoi(), style);
203
        }
204

    
205
		createLsid(this, entity, SWT.NULL);
206
		createAbstract(this, entity, SWT.NULL);
207

    
208
		registerCacheElements();
209

    
210
		handleToggleableAbbrevTitleField();
211
		handleToggleableCacheField();
212

    
213
	}
214

    
215
    private void createWebPageControls(ReferenceDetailElement referenceDetailElement, Reference reference, int style) {
216
		DateTime accessed = reference.getAccessed();
217

    
218
		text_accessed = formFactory.createDateElement(referenceDetailElement, "Accessed", accessed, style, false);
219
	}
220

    
221
	@Override
222
	protected void updateContent() {
223
		if (getEntity() == null) {
224
			setEntity(ReferenceFactory.newGeneric());
225
		}
226

    
227
		super.updateContent();
228

    
229
		// enable elements according to state of cache protection
230
		toggleable_cache.setCacheEnabled(getEntity().isProtectedTitleCache());
231
		toggleableAbbrevCache.setCacheEnabled(getEntity().isProtectedAbbrevTitleCache());
232
	}
233

    
234
	/**
235
	 * Creates an in reference for reference types that do hav this.
236
	 */
237
	private void createInReferenceByType(ICdmFormElement element,
238
			ReferenceType referenceType, Reference reference, int style) {
239

    
240
		String label;
241

    
242
		switch (referenceType) {
243
		case Book:
244
		case Proceedings:
245
		    label = "In Series";
246
            break;
247
		case BookSection:
248
			label = "Book";
249
			break;
250
		case InProceedings:
251
			label = "Proceedings";
252
			break;
253
		case Article:
254
			label = "Journal";
255
			break;
256
		default:
257
		    label = "In Reference";
258
		}
259

    
260
		boolean createInReferenceWidget = !ReferenceType.inReferenceContraints(referenceType).isEmpty();
261

    
262
		if (createInReferenceWidget) {
263
			selection_inReference = formFactory
264
					.createSelectionElement(Reference.class,
265
					        element, label,
266
							reference.getInReference(),
267
							EntitySelectionElement.ALL, style);
268
		}
269
	}
270

    
271
	/**
272
	 * Creates additional controls to edit a generic reference
273
	 */
274
	private void createGenericControls(ICdmFormElement element,
275
			Reference reference, int style) {
276

    
277
		// editor
278
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
279
				reference.getEditor(), style);
280

    
281
		// series
282
		text_series = formFactory.createTextWithLabelElement(element, "Series",
283
				reference.getSeriesPart(), style);
284

    
285
		// volume
286
		text_volume = formFactory.createTextWithLabelElement(element, "Volume",
287
				reference.getVolume(), style);
288

    
289
		// pages
290
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
291
				reference.getPages(), style);
292
	}
293

    
294
	/**
295
	 * Creates additional controls to edit a publication
296
	 */
297
	private void createPublicationControls(ICdmFormElement element,
298
			ReferenceType referenceType, Reference reference, int style) {
299

    
300
		// placePublished
301
		text_placePublished = formFactory.createTextWithLabelElement(element,
302
				"Place Published", reference.getPlacePublished(), style);
303

    
304
		// publisher
305
		text_publisher = formFactory.createTextWithLabelElement(element,
306
				"Publisher", reference.getPublisher(), style);
307

    
308
		if (referenceType.equals(ReferenceType.Journal)) {
309
			// issn
310
			text_issn = formFactory.createTextWithLabelElement(element, "ISSN",
311
					reference.getIssn(), style);
312
		}
313

    
314
		if (referenceType.equals(ReferenceType.Report)) {
315
			// institution
316
			selection_institution = formFactory
317
					.createSelectionElement(Institution.class,
318
					        element, "Institution",
319
							reference.getInstitution(),
320
							EntitySelectionElement.ALL, style);
321
		}
322

    
323
		if (referenceType.equals(ReferenceType.Thesis)) {
324
			// school
325
			selection_institution = formFactory
326
					.createSelectionElement(Institution.class,
327
					        element, "School",
328
							reference.getSchool(),
329
							EntitySelectionElement.ALL, style);
330
		}
331

    
332
		if (referenceType.equals(ReferenceType.Proceedings)) {
333
			// organization
334
			text_organisation = formFactory.createTextWithLabelElement(element,
335
					"Organisation", reference.getOrganization(), style);
336
		}
337
	}
338

    
339
	/**
340
	 * Creates additional controls to edit a section
341
	 */
342
	private void createSectionControls(ICdmFormElement element,
343
			Reference reference, int style) {
344
		// pages
345
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
346
				reference.getPages(), style);
347
	}
348

    
349
	/**
350
	 * Creates additional controls to edit a volume
351
	 */
352
	private void createVolumeControls(ICdmFormElement element,
353
			Reference reference, int style) {
354

    
355
		text_volume = formFactory.createTextWithLabelElement(element, "Volume",
356
				reference.getVolume(), style);
357

    
358
		text_series = formFactory.createTextWithLabelElement(element, "Series",
359
				reference.getSeriesPart(), style);
360
	}
361

    
362
	private void createPrintedUnitControls(ICdmFormElement element,
363
			ReferenceType referenceType, Reference reference, int style) {
364
		// in series
365
	    //handled in generic in-Reference part
366

    
367
		// editor
368
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
369
				reference.getEditor(), style);
370

    
371
		/* series part
372
		text_seriesPart = formFactory.createTextWithLabelElement(element,
373
				"Series", reference.getSeriesPart(), style);
374
*/
375
		if (referenceType.equals(ReferenceType.Book)) {
376
			// edition
377
			text_edition = formFactory.createTextWithLabelElement(element,
378
					"Edition", reference.getEdition(), style);
379
		}
380

    
381
		// isbn
382
        text_isbn = formFactory.createTextWithLabelElement(element, "ISBN",
383
                reference.getIsbn(), style);
384
	}
385

    
386
	private void createAbstract(ICdmFormElement element,
387
			Reference reference, int style) {
388

    
389
		text_referenceAbstract = formFactory.createMultiLineTextWithLabel(
390
				element, "Reference Abstract", 100, style);
391
		text_referenceAbstract.setText(reference.getReferenceAbstract());
392
	}
393

    
394
	private void createLsid(ICdmFormElement element,
395
            Reference reference, int style) {
396
        text_lsid = formFactory.createLsidWithExceptionLabelElement(element, "LSID",
397
                reference.getLsid(), style);
398
    }
399

    
400
	private void createUri(ICdmFormElement element,
401
            Reference reference, int style) {
402

    
403
        text_uri = formFactory.createUriWithLabelElement(element, "URI",
404
                reference.getUri(), style);
405
        if (reference.isDynamic()){
406
            createWebPageControls(this, reference, style);
407
        }
408
    }
409

    
410
	@Override
411
	public void handleEvent(Object eventSource) {
412
		if (eventSource == combo_referenceType) {
413
			getEntity().setType(combo_referenceType.getSelection());
414
			updateContent();
415
	        //this is needed for the "new" wizards in order to redraw correctly
416
			StoreUtil.reflowParentScrolledForm(getLayoutComposite(), true);
417
		} else if (eventSource == element_timePeriod) {
418
			getEntity().setDatePublished(element_timePeriod.getTimePeriod());
419
			clearException();
420
		}
421
		// selections
422
		else if (eventSource == selection_authorTeam) {
423
			getEntity().setAuthorship(
424
					selection_authorTeam.getEntity());
425
		} else if (eventSource == selection_inReference) {
426
			getEntity().setInReference(selection_inReference.getSelection());
427
		} else if (eventSource == selection_inSeries) {
428
			getEntity().setInReference(selection_inSeries.getSelection());
429
		} else if (eventSource == selection_institution) {
430
			getEntity().setInstitution(selection_institution.getSelection());
431
		}
432

    
433
		// textfields
434
		else if (eventSource == toggleable_cache) {
435
			handleToggleableCacheField();
436
		}
437
		else if (eventSource == toggleableAbbrevCache) {
438
		    handleToggleableAbbrevTitleField();
439
		} else if (eventSource == text_edition) {
440
			getEntity().setEdition(text_edition.getText());
441
		} else if (eventSource == text_editor) {
442
			getEntity().setEditor(text_editor.getText());
443
		} else if (eventSource == text_isbn) {
444
			getEntity().setIsbn(text_isbn.getText());
445
		} else if (eventSource == text_issn) {
446
			getEntity().setIssn(text_issn.getText());
447
		} else if (eventSource == text_organisation) {
448
			getEntity().setOrganization(text_organisation.getText());
449
		} else if (eventSource == text_pages) {
450
			getEntity().setPages(text_pages.getText());
451
		} else if (eventSource == text_placePublished) {
452
			getEntity().setPlacePublished(text_placePublished.getText());
453
		} else if (eventSource == text_publisher) {
454
			getEntity().setPublisher(text_publisher.getText());
455
		} else if (eventSource == text_referenceAbstract) {
456
			getEntity().setReferenceAbstract(text_referenceAbstract.getText());
457
		} else if (eventSource == text_series) {
458
			getEntity().setSeriesPart(text_series.getText());
459
		} else if (eventSource == text_title ) {
460
			getEntity().setTitle(text_title.getText());
461
			if (!toggleable_cache.isCacheEnabled()){
462
			    toggleable_cache.setText(getEntity().generateTitle());
463
			}
464
		} else if (eventSource == text_abbrevTitle ) {
465
		    getEntity().setAbbrevTitle(text_abbrevTitle.getText());
466
		    if (!toggleableAbbrevCache.isCacheEnabled()){
467
		        toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
468
		    }
469
		} else if (eventSource == text_uri) {
470
			getEntity().setUri(text_uri.parseText());
471
		} else if (eventSource == text_lsid) {
472
            getEntity().setLsid(text_lsid.parseText());
473
        } else if (eventSource == text_volume) {
474
			getEntity().setVolume(text_volume.getText());
475
		}else if (eventSource == text_doi) {
476
            getEntity().setDoi(text_doi.parseText());
477
        }else if (text_accessed != null && eventSource == text_accessed.getController()) {
478
            getEntity().setAccessed(text_accessed.getController().getDateTime());
479
        }
480

    
481
		if (eventSource != text_title && eventSource != text_abbrevTitle) {
482
		    // set abbrev title cache to null to force new generation
483
		    // for the standard title cache this is done by a PropertyChangeListener registered
484
		    // in IdentifiableEntity.initListeners()
485
		    if(!getEntity().isProtectedAbbrevTitleCache()){
486
		        getEntity().setAbbrevTitleCache(null, getEntity().isProtectedAbbrevTitleCache());
487
		    }
488
		    if(!getEntity().isProtectedTitleCache()){
489
                getEntity().setTitleCache(null, getEntity().isProtectedTitleCache());
490
            }
491

    
492
			toggleable_cache.setText(getEntity().getTitleCache());
493
			toggleableAbbrevCache.setText(getEntity().getAbbrevTitleCache());
494
		}
495

    
496
		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
497
	}
498

    
499
    @Override
500
    public void updateToggleableCacheField() {
501
        if (!getEntity().isProtectedTitleCache()) {
502
            toggleable_cache.setText(getEntity().generateTitle());
503
        }
504
        if (!getEntity().isProtectedAbbrevTitleCache()) {
505
            toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
506
        }
507
    }
508

    
509
    protected void handleToggleableAbbrevTitleField() {
510
        getEntity().setAbbrevTitleCache(
511
                toggleableAbbrevCache.getText(), toggleableAbbrevCache.getState());
512
        updateToggleableCacheField();
513
        updateCacheRelevance();
514
    }
515

    
516
	@Override
517
	public void handleException(CdmPropertyChangeEvent event) {
518
		exceptionOccurred(event);
519
	}
520

    
521
	@Override
522
	public void clearException() {
523
		exceptionOccurred(null);
524
	}
525

    
526
	private final List<IExceptionHandler> exceptionHandlers = new ArrayList<>();
527

    
528
	@Override
529
	public void addExceptionHandler(IExceptionHandler handler) {
530
		exceptionHandlers.add(handler);
531
	}
532

    
533
	@Override
534
	public void removeExceptionHandler(IExceptionHandler handler) {
535
		exceptionHandlers.remove(handler);
536
	}
537

    
538
	@Override
539
	public void exceptionOccurred(CdmPropertyChangeEvent event) {
540
		for (IExceptionHandler handler : exceptionHandlers) {
541
			if (event == null) {
542
				handler.clearException();
543
			} else {
544
				handler.handleException(event);
545
			}
546
		}
547
	}
548

    
549
	@Override
550
	protected void handleToggleableCacheField() {
551
        getEntity().setTitleCache(toggleable_cache.getText(), toggleable_cache.getState());
552
        updateToggleableCacheField();
553
        updateCacheRelevance();
554
    }
555

    
556
	protected void setIrrelevantReferenceDetail(boolean abbrev){
557

    
558
		List<Object> except = new ArrayList<>();
559

    
560
	    except.addAll( Arrays.asList(new Object[] { toggleable_cache, toggleableAbbrevCache, text_editor, text_isbn, text_issn, text_organisation, text_pages, text_placePublished, text_publisher, text_referenceAbstract,  text_uri, selection_institution}));
561

    
562
	    if (abbrev){
563
	      except.add(text_title);
564
	    } else{
565
	      except.add(text_abbrevTitle);
566
	    }
567

    
568
	    switch( getEntity().getType()){
569
	    case Journal:
570
	    	except.add(element_timePeriod);
571
	    	break;
572
	    case Book:
573
	    	except.remove(text_series);
574
	    	except.remove(text_edition);
575
	    	break;
576
	    default:
577
	    	break;
578
	    }
579

    
580
	    updateCacheRelevance();
581
	}
582
}
(8-8/15)