Project

General

Profile

Download (19.2 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

    
10
package eu.etaxonomy.taxeditor.ui.section.reference;
11

    
12

    
13

    
14
import java.util.ArrayList;
15
import java.util.Arrays;
16
import java.util.List;
17

    
18
import org.eclipse.swt.SWT;
19
import org.joda.time.DateTime;
20

    
21
import eu.etaxonomy.cdm.model.agent.AgentBase;
22
import eu.etaxonomy.cdm.model.agent.Institution;
23
import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
24
import eu.etaxonomy.cdm.model.reference.Reference;
25
import eu.etaxonomy.cdm.model.reference.ReferenceFactory;
26
import eu.etaxonomy.cdm.model.reference.ReferenceType;
27
import eu.etaxonomy.taxeditor.ui.combo.EnumComboElement;
28
import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
29
import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
30
import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
31
import eu.etaxonomy.taxeditor.ui.element.IErrorIntolerableElement;
32
import eu.etaxonomy.taxeditor.ui.element.IExceptionHandler;
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.selection.EntitySelectionElement;
40

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

    
52

    
53

    
54
    private ToggleableTextElement toggleableAbbrevCache;
55

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

    
78
	private EntitySelectionElement<Reference> selection_inSeries;
79
	private boolean isWizard;
80

    
81
	/**
82
	 * <p>
83
	 * Constructor for ReferenceBaseDetailElement.
84
	 * </p>
85
	 *
86
	 * @param cdmFormFactory
87
	 *            a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
88
	 *            object.
89
	 * @param formElement
90
	 *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
91
	 *            object.
92
	 * @param style
93
	 *            a int.
94
	 */
95
	public ReferenceDetailElement(CdmFormFactory cdmFormFactory,
96
			ICdmFormElement formElement, int style, boolean isWizard) {
97
		super(cdmFormFactory, formElement);
98
		this.isWizard = isWizard;
99
	}
100

    
101

    
102
	/** {@inheritDoc} */
103
	@Override
104
	protected void createControls(ICdmFormElement formElement,
105
			Reference entity, int style) {
106
		if (isWizard){
107
		    setWarnForReferencingObjects(formElement);
108
		}
109

    
110
		toggleable_cache = formFactory.createToggleableTextField(formElement,
111
				"Reference Cache", entity.getTitleCache(),
112
				entity.isProtectedTitleCache(), style);
113

    
114
		toggleableAbbrevCache = formFactory.createToggleableTextField(formElement,
115
		        "Abbrev. Cache", entity.getAbbrevTitleCache(),
116
		        entity.isProtectedAbbrevTitleCache(), style);
117

    
118
		combo_referenceType = formFactory.createEnumComboElement(ReferenceType.class,
119
						formElement, style);
120

    
121
		combo_referenceType.setSelection(entity.getType());
122

    
123
		// title
124
		text_title = formFactory.createTextWithLabelElement(formElement,
125
				"Title", entity.getTitle(), style);
126
		// abbreviated title
127
		text_abbrevTitle = formFactory.createTextWithLabelElement(formElement,
128
		        "Nomenclatural Title", entity.getAbbrevTitle(), style);
129

    
130
		// author team
131
		selection_authorTeam = formFactory
132
				.createSelectionElement(AgentBase.class,//getConversationHolder(),
133
				        formElement, "Author",
134
						entity.getAuthorship(),
135
						EntitySelectionElement.ALL, style);
136

    
137
		ReferenceType referenceType = entity.getType();
138

    
139
		if (referenceType != null) {
140

    
141
			createInReferenceByType(this, referenceType, entity, SWT.NULL);
142

    
143
			if (referenceType.equals(ReferenceType.Generic)) {
144
				createGenericControls(this, entity, SWT.NULL);
145
				createPublicationControls(this, referenceType, entity, SWT.NULL);
146

    
147
			} else {
148
				if (referenceType.isPrintedUnit()) {
149
					createPrintedUnitControls(this, referenceType, entity,
150
							SWT.NULL);
151
				}
152
				if (referenceType.isPublication()) {
153
					createPublicationControls(this, referenceType, entity,
154
							SWT.NULL);
155
				}
156
				if (referenceType.isVolumeReference()) {
157
					createVolumeControls(this, entity, SWT.NULL);
158
				}
159
				if (referenceType.isSection()) {
160
					createSectionControls(this, entity, SWT.NULL);
161
				}
162

    
163
			}
164
		}
165

    
166
		// date published
167
		element_timePeriod = formFactory.createVerbatimTimePeriodElement(formElement,
168
				"Date Published", entity.getDatePublished(), style);
169

    
170
		createUriAndAbstract(this, entity, SWT.NULL);
171
		handleToggleableAbbrevTitleField();
172
		handleToggleableCacheField();
173
	}
174

    
175
	private void createWebPageControls(ReferenceDetailElement referenceDetailElement, Reference reference, int style) {
176
		DateTime accessed = reference.getAccessed();
177

    
178
		 text_accessed = formFactory.createDateElement(referenceDetailElement, "Accessed", accessed, style, false);
179

    
180
	}
181

    
182
	/*
183
	 * (non-Javadoc)
184
	 *
185
	 * @see
186
	 * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
187
	 * #updateContent()
188
	 */
189
	/** {@inheritDoc} */
190
	@Override
191
	protected void updateContent() {
192
		if (getEntity() == null) {
193
			setEntity(ReferenceFactory.newGeneric());
194
		}
195

    
196
		super.updateContent();
197

    
198
		// enable elements according to state of cache protection
199
		// setEnabled(getEntity().isProtectedTitleCache(), Arrays.asList(new
200
		// Object[]{text_cache}));
201
		toggleable_cache.setEnabled(getEntity().isProtectedTitleCache());
202
		toggleableAbbrevCache.setEnabled(getEntity().isProtectedAbbrevTitleCache());
203
		setIrrelevantReferenceDetail(false);
204
		setIrrelevantReferenceDetail(true);
205
	}
206

    
207
	/**
208
	 * Creates an in reference for reference types that do hav this.
209
	 *
210
	 * @param element
211
	 * @param referenceType
212
	 * @param reference
213
	 * @param style
214
	 */
215
	private void createInReferenceByType(ICdmFormElement element,
216
			ReferenceType referenceType, Reference reference, int style) {
217
		boolean createInReferenceWidget = true;
218
		String label = "In Reference";
219

    
220
		switch (referenceType) {
221
		case Generic:
222
			break;
223
		case Section:
224
		    break;
225
		case BookSection:
226
			label = "Book";
227
			break;
228
		case InProceedings:
229
			label = "Print Series";
230
			break;
231
		case Article:
232
			label = "Journal";
233
			break;
234
		case WebPage:
235
			break;
236
		default:
237
			createInReferenceWidget = false;
238
		}
239

    
240
		if (createInReferenceWidget) {
241
			selection_inReference = formFactory
242
					.createSelectionElement(Reference.class,//getConversationHolder(),
243
					        element, label,
244
							reference.getInReference(),
245
							EntitySelectionElement.ALL, style);
246
		}
247
	}
248

    
249
	/**
250
	 * Creates additional controls to edit a generic reference
251
	 *
252
	 * @param element
253
	 * @param reference
254
	 * @param listener
255
	 * @param style
256
	 */
257
	private void createGenericControls(ICdmFormElement element,
258
			Reference reference, int style) {
259

    
260
		// editor
261
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
262
				reference.getEditor(), style);
263

    
264
		// series
265
		text_series = formFactory.createTextWithLabelElement(element, "Series",
266
				reference.getSeriesPart(), style);
267

    
268
		// volume
269
		text_volume = formFactory.createTextWithLabelElement(element, "Volume",
270
				reference.getVolume(), style);
271

    
272
		// pages
273
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
274
				reference.getPages(), style);
275

    
276

    
277
	}
278

    
279
	/**
280
	 * Creates additional controls to edit a publication
281
	 *
282
	 * @param element
283
	 * @param reference
284
	 * @param listener
285
	 * @param style
286
	 */
287
	private void createPublicationControls(ICdmFormElement element,
288
			ReferenceType referenceType, Reference reference, int style) {
289

    
290
		// placePublished
291
		text_placePublished = formFactory.createTextWithLabelElement(element,
292
				"Place Published", reference.getPlacePublished(), style);
293

    
294
		// publisher
295
		text_publisher = formFactory.createTextWithLabelElement(element,
296
				"Publisher", reference.getPublisher(), style);
297

    
298
		if (referenceType.equals(ReferenceType.Journal)) {
299
			// issn
300
			text_issn = formFactory.createTextWithLabelElement(element, "ISSN",
301
					reference.getIssn(), style);
302
		}
303

    
304
		if (referenceType.equals(ReferenceType.Report)) {
305
			// institution
306
			selection_institution = formFactory
307
					.createSelectionElement(Institution.class,//getConversationHolder(),
308
					        element, "Institution",
309
							reference.getInstitution(),
310
							EntitySelectionElement.ALL, style);
311
		}
312

    
313
		if (referenceType.equals(ReferenceType.Thesis)) {
314
			// school
315
			selection_institution = formFactory
316
					.createSelectionElement(Institution.class,//getConversationHolder(),
317
					        element, "School",
318
							reference.getSchool(),
319
							EntitySelectionElement.ALL, style);
320
		}
321

    
322
		if (referenceType.equals(ReferenceType.Proceedings)) {
323
			// organization
324
			text_organisation = formFactory.createTextWithLabelElement(element,
325
					"Organisation", reference.getOrganization(), style);
326
		}
327
	}
328

    
329
	/**
330
	 * Creates additional controls to edit a section
331
	 *
332
	 * @param element
333
	 * @param reference
334
	 * @param style
335
	 */
336
	private void createSectionControls(ICdmFormElement element,
337
			Reference reference, int style) {
338
		// pages
339
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
340
				reference.getPages(), style);
341
	}
342

    
343
	/**
344
	 * Creates additional controls to edit a volume
345
	 *
346
	 * @param element
347
	 * @param reference
348
	 * @param style
349
	 */
350
	private void createVolumeControls(ICdmFormElement element,
351
			Reference reference, int style) {
352

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

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

    
360
	/**
361
	 *
362
	 * @param element
363
	 * @param referenceType
364
	 * @param reference
365
	 * @param style
366
	 */
367
	private void createPrintedUnitControls(ICdmFormElement element,
368
			ReferenceType referenceType, Reference reference, int style) {
369
		// in series
370
		selection_inSeries = formFactory
371
				.createSelectionElement(Reference.class,//getConversationHolder(),
372
				        element, "In Series",
373
						(Reference) reference.getInSeries(),
374
						EntitySelectionElement.ALL, style);
375

    
376
		// editor
377
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
378
				reference.getEditor(), style);
379

    
380
		/* series part
381
		text_seriesPart = formFactory.createTextWithLabelElement(element,
382
				"Series", reference.getSeriesPart(), style);
383
*/
384
		if (referenceType.equals(ReferenceType.Book)) {
385
			// edition
386
			text_edition = formFactory.createTextWithLabelElement(element,
387
					"Edition", reference.getEdition(), style);
388

    
389
			// isbn
390
			text_isbn = formFactory.createTextWithLabelElement(element, "ISBN",
391
					reference.getIsbn(), style);
392
		}
393
	}
394

    
395
	private void createUriAndAbstract(ICdmFormElement element,
396
			Reference reference, int style) {
397
		// uri
398
		text_uri = formFactory.createUriWithLabelElement(element, "URI",
399
				reference.getUri(), style);
400
		if (reference.getType().equals(ReferenceType.WebPage)){
401
			createWebPageControls(this, reference, style);
402
		}
403
		// abstract
404
		text_referenceAbstract = formFactory.createMultiLineTextWithLabel(
405
				element, "Reference Abstract", 100, style);
406
		text_referenceAbstract.setText(reference.getReferenceAbstract());
407
	}
408

    
409
	/** {@inheritDoc} */
410
	@Override
411
	public void handleEvent(Object eventSource) {
412
		if (eventSource == combo_referenceType) {
413
			getEntity().setType(combo_referenceType.getSelection());
414
			updateContent();
415
		} else if (eventSource == element_timePeriod) {
416
			getEntity().setDatePublished(element_timePeriod.getTimePeriod());
417
			clearException();
418
		}
419
		// selections
420
		else if (eventSource == selection_authorTeam) {
421
			getEntity().setAuthorship(
422
					(TeamOrPersonBase) selection_authorTeam.getEntity());
423
		} else if (eventSource == selection_inReference) {
424
			getEntity().setInReference(selection_inReference.getSelection());
425
		} else if (eventSource == selection_inSeries) {
426
			getEntity().setInReference(selection_inSeries.getSelection());
427
		} else if (eventSource == selection_institution) {
428
			getEntity().setInstitution(selection_institution.getSelection());
429
		}
430

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

    
475
		if (eventSource != text_title && eventSource != text_abbrevTitle) {
476
		    // set abbrev title cache to null to force new generation
477
		    // for the standard title cache this is done by a PropertyChangeListener registered
478
		    // in IdentifiableEntity.initListeners()
479
		    if(!getEntity().isProtectedAbbrevTitleCache()){
480
		        getEntity().setAbbrevTitleCache(null, getEntity().isProtectedAbbrevTitleCache());
481
		    }
482
		    if(!getEntity().isProtectedTitleCache()){
483
                getEntity().setTitleCache(null, getEntity().isProtectedTitleCache());
484
            }
485

    
486
			toggleable_cache.setText(getEntity().getTitleCache());
487
			toggleableAbbrevCache.setText(getEntity().getAbbrevTitleCache());
488
		}
489

    
490
		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
491
	}
492

    
493

    
494
    @Override
495
    public void updateToggleableCacheField() {
496
        if (!getEntity().isProtectedTitleCache()) {
497
            toggleable_cache.setText(getEntity().generateTitle());
498
        }
499
        if (!getEntity().isProtectedAbbrevTitleCache()) {
500
            toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
501
        }
502
    }
503

    
504
    protected void handleToggleableAbbrevTitleField() {
505
        boolean pushedAbbrevState = toggleableAbbrevCache.getState();
506
        getEntity().setAbbrevTitleCache(toggleableAbbrevCache.getText(), pushedAbbrevState);
507
        setIrrelevantReferenceDetail(true);
508
        updateToggleableCacheField();
509
    }
510

    
511
	/*
512
	 * (non-Javadoc)
513
	 *
514
	 * @see
515
	 * eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement#handleException
516
	 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
517
	 */
518
	/** {@inheritDoc} */
519
	@Override
520
	public void handleException(CdmPropertyChangeEvent event) {
521
		exceptionOccurred(event);
522
	}
523

    
524
	/*
525
	 * (non-Javadoc)
526
	 *
527
	 * @see eu.etaxonomy.taxeditor.forms.IExceptionHandler#clearException()
528
	 */
529
	/** {@inheritDoc} */
530
	@Override
531
	public void clearException() {
532
		exceptionOccurred(null);
533
	}
534

    
535
	private final List<IExceptionHandler> exceptionHandlers = new ArrayList<IExceptionHandler>();
536

    
537
	/*
538
	 * (non-Javadoc)
539
	 *
540
	 * @see
541
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#addExceptionHandler
542
	 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
543
	 */
544
	/** {@inheritDoc} */
545
	@Override
546
	public void addExceptionHandler(IExceptionHandler handler) {
547
		exceptionHandlers.add(handler);
548
	}
549

    
550
	/*
551
	 * (non-Javadoc)
552
	 *
553
	 * @see
554
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#removeExceptionHandler
555
	 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
556
	 */
557
	/** {@inheritDoc} */
558
	@Override
559
	public void removeExceptionHandler(IExceptionHandler handler) {
560
		exceptionHandlers.remove(handler);
561
	}
562

    
563
	/*
564
	 * (non-Javadoc)
565
	 *
566
	 * @see
567
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#exceptionOccurred
568
	 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
569
	 */
570
	/** {@inheritDoc} */
571
	@Override
572
	public void exceptionOccurred(CdmPropertyChangeEvent event) {
573
		for (IExceptionHandler handler : exceptionHandlers) {
574
			if (event == null) {
575
				handler.clearException();
576
			} else {
577
				handler.handleException(event);
578
			}
579
		}
580
	}
581

    
582
	@Override
583
	protected void handleToggleableCacheField() {
584

    
585
		boolean pushedState = toggleable_cache.getState();
586
        getEntity().setTitleCache(toggleable_cache.getText(), pushedState);
587
        setIrrelevantReferenceDetail(false);
588
        updateToggleableCacheField();
589
    }
590

    
591
	protected void setIrrelevantReferenceDetail(boolean abbrev){
592

    
593
		List<Object> except = new ArrayList();
594

    
595
	    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}));
596
	    boolean pushedState;
597
	    if (abbrev){
598
	      except.add(text_title);
599
	    } else{
600
	      except.add(text_abbrevTitle);
601
	    }
602
	    pushedState = toggleableAbbrevCache.getState() || toggleable_cache.getState();
603

    
604
	    switch( getEntity().getType()){
605
	    case Journal:
606
	    	except.add(element_timePeriod);
607
	    	break;
608
	    case Book:
609
	    	except.remove(text_series);
610
	    	except.remove(text_edition);
611
	    	break;
612
	    default:
613
	    	break;
614
	    }
615

    
616
	    setIrrelevant(pushedState, except);
617
	    text_title.setIrrelevant(toggleable_cache.getState());
618
	    text_abbrevTitle.setIrrelevant(toggleableAbbrevCache.getState());
619
	}
620

    
621

    
622

    
623

    
624
}
(3-3/6)