Project

General

Profile

Download (19.3 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.TimePeriodElement;
35
import eu.etaxonomy.taxeditor.ui.element.ToggleableTextElement;
36
import eu.etaxonomy.taxeditor.ui.element.UriWithLabelElement;
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
 * @version 1.0
49
 */
50
public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElement<Reference>
51
		implements IErrorIntolerableElement, IExceptionHandler {
52

    
53

    
54

    
55
    private ToggleableTextElement toggleableAbbrevCache;
56

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

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

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

    
102
	/*
103
	 * (non-Javadoc)
104
	 *
105
	 * @see
106
	 * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
107
	 * #createControl(org.eclipse.swt.widgets.Composite, int)
108
	 */
109
	/** {@inheritDoc} */
110
	@Override
111
	protected void createControls(ICdmFormElement formElement,
112
			Reference entity, int style) {
113
		ICdmFormElement o = this.getParentElement();
114
		Class clazz=o.getClass();
115
		if (isWizard){
116
		    setWarnForReferencingObjects(formElement);
117
		}
118

    
119

    
120
		toggleable_cache = formFactory.createToggleableTextField(formElement,
121
				"Reference Cache", entity.getTitleCache(),
122
				entity.isProtectedTitleCache(), style);
123

    
124
		toggleableAbbrevCache = formFactory.createToggleableTextField(formElement,
125
		        "Abbrev. Cache", entity.getAbbrevTitleCache(),
126
		        entity.isProtectedAbbrevTitleCache(), style);
127

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

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

    
133
		// title
134
		text_title = formFactory.createTextWithLabelElement(formElement,
135
				"Title", entity.getTitle(), style);
136
		// abbreviated title
137
		text_abbrevTitle = formFactory.createTextWithLabelElement(formElement,
138
		        "Nomenclatural Title", entity.getAbbrevTitle(), style);
139

    
140
		// author team
141
		selection_authorTeam = formFactory
142
				.createSelectionElement(AgentBase.class,//getConversationHolder(),
143
				        formElement, "Author",
144
						entity.getAuthorship(),
145
						EntitySelectionElement.ALL, style);
146

    
147
		ReferenceType referenceType = entity.getType();
148

    
149
		if (referenceType != null) {
150

    
151
			createInReferenceByType(this, referenceType, entity, SWT.NULL);
152

    
153
			if (referenceType.equals(ReferenceType.Generic)) {
154
				createGenericControls(this, entity, SWT.NULL);
155
				createPublicationControls(this, referenceType, entity, SWT.NULL);
156

    
157
			} else {
158
				if (referenceType.isPrintedUnit()) {
159
					createPrintedUnitControls(this, referenceType, entity,
160
							SWT.NULL);
161
				}
162
				if (referenceType.isPublication()) {
163
					createPublicationControls(this, referenceType, entity,
164
							SWT.NULL);
165
				}
166
				if (referenceType.isVolumeReference()) {
167
					createVolumeControls(this, entity, SWT.NULL);
168
				}
169
				if (referenceType.isSection()) {
170
					createSectionControls(this, entity, SWT.NULL);
171
				}
172

    
173
			}
174
		}
175

    
176
		// date published
177
		element_timePeriod = formFactory.createTimePeriodElement(formElement,
178
				"Date Published", entity.getDatePublished(), style);
179

    
180
		createUriAndAbstract(this, entity, SWT.NULL);
181
		handleToggleableAbbrevTitleField();
182
		handleToggleableCacheField();
183
	}
184

    
185
	private void createWebPageControls(ReferenceDetailElement referenceDetailElement, Reference reference, int style) {
186
		DateTime accessed = reference.getAccessed();
187

    
188
		 text_accessed = formFactory.createDateElement(referenceDetailElement, "Accessed", accessed, style, false);
189

    
190
	}
191

    
192
	/*
193
	 * (non-Javadoc)
194
	 *
195
	 * @see
196
	 * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
197
	 * #updateContent()
198
	 */
199
	/** {@inheritDoc} */
200
	@Override
201
	protected void updateContent() {
202
		if (getEntity() == null) {
203
			setEntity(ReferenceFactory.newGeneric());
204
		}
205

    
206
		super.updateContent();
207

    
208
		// enable elements according to state of cache protection
209
		// setEnabled(getEntity().isProtectedTitleCache(), Arrays.asList(new
210
		// Object[]{text_cache}));
211
		toggleable_cache.setEnabled(getEntity().isProtectedTitleCache());
212
		toggleableAbbrevCache.setEnabled(getEntity().isProtectedAbbrevTitleCache());
213
		setIrrelevantReferenceDetail(false);
214
		setIrrelevantReferenceDetail(true);
215
	}
216

    
217
	/**
218
	 * Creates an in reference for reference types that do hav this.
219
	 *
220
	 * @param element
221
	 * @param referenceType
222
	 * @param reference
223
	 * @param style
224
	 */
225
	private void createInReferenceByType(ICdmFormElement element,
226
			ReferenceType referenceType, Reference reference, int style) {
227
		boolean createInReferenceWidget = true;
228
		String label = "In Reference";
229

    
230
		switch (referenceType) {
231
		case Generic:
232
			break;
233
		case Section:
234
		    break;
235
		case BookSection:
236
			label = "Book";
237
			break;
238
		case InProceedings:
239
			label = "Print Series";
240
			break;
241
		case Article:
242
			label = "Journal";
243
			break;
244
		case WebPage:
245
			break;
246
		default:
247
			createInReferenceWidget = false;
248
		}
249

    
250
		if (createInReferenceWidget) {
251
			selection_inReference = formFactory
252
					.createSelectionElement(Reference.class,//getConversationHolder(),
253
					        element, label,
254
							reference.getInReference(),
255
							EntitySelectionElement.ALL, style);
256
		}
257
	}
258

    
259
	/**
260
	 * Creates additional controls to edit a generic reference
261
	 *
262
	 * @param element
263
	 * @param reference
264
	 * @param listener
265
	 * @param style
266
	 */
267
	private void createGenericControls(ICdmFormElement element,
268
			Reference reference, int style) {
269

    
270
		// editor
271
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
272
				reference.getEditor(), style);
273

    
274
		// series
275
		text_series = formFactory.createTextWithLabelElement(element, "Series",
276
				reference.getSeriesPart(), style);
277

    
278
		// volume
279
		text_volume = formFactory.createTextWithLabelElement(element, "Volume",
280
				reference.getVolume(), style);
281

    
282
		// pages
283
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
284
				reference.getPages(), style);
285

    
286

    
287
	}
288

    
289
	/**
290
	 * Creates additional controls to edit a publication
291
	 *
292
	 * @param element
293
	 * @param reference
294
	 * @param listener
295
	 * @param style
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,//getConversationHolder(),
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,//getConversationHolder(),
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
	 * @param element
343
	 * @param reference
344
	 * @param style
345
	 */
346
	private void createSectionControls(ICdmFormElement element,
347
			Reference reference, int style) {
348
		// pages
349
		text_pages = formFactory.createTextWithLabelElement(element, "Pages",
350
				reference.getPages(), style);
351
	}
352

    
353
	/**
354
	 * Creates additional controls to edit a volume
355
	 *
356
	 * @param element
357
	 * @param reference
358
	 * @param style
359
	 */
360
	private void createVolumeControls(ICdmFormElement element,
361
			Reference reference, int style) {
362

    
363
		text_volume = formFactory.createTextWithLabelElement(element, "Volume",
364
				reference.getVolume(), style);
365

    
366
		text_series = formFactory.createTextWithLabelElement(element, "Series",
367
				reference.getSeriesPart(), style);
368
	}
369

    
370
	/**
371
	 *
372
	 * @param element
373
	 * @param referenceType
374
	 * @param reference
375
	 * @param style
376
	 */
377
	private void createPrintedUnitControls(ICdmFormElement element,
378
			ReferenceType referenceType, Reference reference, int style) {
379
		// in series
380
		selection_inSeries = formFactory
381
				.createSelectionElement(Reference.class,//getConversationHolder(),
382
				        element, "In Series",
383
						(Reference) reference.getInSeries(),
384
						EntitySelectionElement.ALL, style);
385

    
386
		// editor
387
		text_editor = formFactory.createTextWithLabelElement(element, "Editor",
388
				reference.getEditor(), style);
389

    
390
		/* series part
391
		text_seriesPart = formFactory.createTextWithLabelElement(element,
392
				"Series", reference.getSeriesPart(), style);
393
*/
394
		if (referenceType.equals(ReferenceType.Book)) {
395
			// edition
396
			text_edition = formFactory.createTextWithLabelElement(element,
397
					"Edition", reference.getEdition(), style);
398

    
399
			// isbn
400
			text_isbn = formFactory.createTextWithLabelElement(element, "ISBN",
401
					reference.getIsbn(), style);
402
		}
403
	}
404

    
405
	private void createUriAndAbstract(ICdmFormElement element,
406
			Reference reference, int style) {
407
		// uri
408
		text_uri = formFactory.createUriWithLabelElement(element, "URI",
409
				reference.getUri(), style);
410
		if (reference.getType().equals(ReferenceType.WebPage)){
411
			createWebPageControls(this, reference, style);
412
		}
413
		// abstract
414
		text_referenceAbstract = formFactory.createMultiLineTextWithLabel(
415
				element, "Reference Abstract", 100, style);
416
		text_referenceAbstract.setText(reference.getReferenceAbstract());
417
	}
418

    
419
	/** {@inheritDoc} */
420
	@Override
421
	public void handleEvent(Object eventSource) {
422
		if (eventSource == combo_referenceType) {
423
			getEntity().setType(combo_referenceType.getSelection());
424
			updateContent();
425
		} else if (eventSource == element_timePeriod) {
426
			getEntity().setDatePublished(element_timePeriod.getTimePeriod());
427
			clearException();
428
		}
429
		// selections
430
		else if (eventSource == selection_authorTeam) {
431
			getEntity().setAuthorship(
432
					(TeamOrPersonBase) selection_authorTeam.getEntity());
433
		} else if (eventSource == selection_inReference) {
434
			getEntity().setInReference(selection_inReference.getSelection());
435
		} else if (eventSource == selection_inSeries) {
436
			getEntity().setInReference(selection_inSeries.getSelection());
437
		} else if (eventSource == selection_institution) {
438
			getEntity().setInstitution(selection_institution.getSelection());
439
		}
440

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

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

    
496
			toggleable_cache.setText(getEntity().getTitleCache());
497
			toggleableAbbrevCache.setText(getEntity().getAbbrevTitleCache());
498
		}
499

    
500
		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
501
	}
502

    
503

    
504
    @Override
505
    public void updateToggleableCacheField() {
506
        if (!getEntity().isProtectedTitleCache()) {
507
            toggleable_cache.setText(getEntity().generateTitle());
508
        }
509
        if (!getEntity().isProtectedAbbrevTitleCache()) {
510
            toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
511
        }
512
    }
513

    
514
    protected void handleToggleableAbbrevTitleField() {
515
        boolean pushedAbbrevState = toggleableAbbrevCache.getState();
516
        getEntity().setAbbrevTitleCache(toggleableAbbrevCache.getText(), pushedAbbrevState);
517
        setIrrelevantReferenceDetail(true);
518
        updateToggleableCacheField();
519
    }
520

    
521
	/*
522
	 * (non-Javadoc)
523
	 *
524
	 * @see
525
	 * eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement#handleException
526
	 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
527
	 */
528
	/** {@inheritDoc} */
529
	@Override
530
	public void handleException(CdmPropertyChangeEvent event) {
531
		exceptionOccurred(event);
532
	}
533

    
534
	/*
535
	 * (non-Javadoc)
536
	 *
537
	 * @see eu.etaxonomy.taxeditor.forms.IExceptionHandler#clearException()
538
	 */
539
	/** {@inheritDoc} */
540
	@Override
541
	public void clearException() {
542
		exceptionOccurred(null);
543
	}
544

    
545
	private final List<IExceptionHandler> exceptionHandlers = new ArrayList<IExceptionHandler>();
546

    
547
	/*
548
	 * (non-Javadoc)
549
	 *
550
	 * @see
551
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#addExceptionHandler
552
	 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
553
	 */
554
	/** {@inheritDoc} */
555
	@Override
556
	public void addExceptionHandler(IExceptionHandler handler) {
557
		exceptionHandlers.add(handler);
558
	}
559

    
560
	/*
561
	 * (non-Javadoc)
562
	 *
563
	 * @see
564
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#removeExceptionHandler
565
	 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
566
	 */
567
	/** {@inheritDoc} */
568
	@Override
569
	public void removeExceptionHandler(IExceptionHandler handler) {
570
		exceptionHandlers.remove(handler);
571
	}
572

    
573
	/*
574
	 * (non-Javadoc)
575
	 *
576
	 * @see
577
	 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#exceptionOccurred
578
	 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
579
	 */
580
	/** {@inheritDoc} */
581
	@Override
582
	public void exceptionOccurred(CdmPropertyChangeEvent event) {
583
		for (IExceptionHandler handler : exceptionHandlers) {
584
			if (event == null) {
585
				handler.clearException();
586
			} else {
587
				handler.handleException(event);
588
			}
589
		}
590
	}
591

    
592
	@Override
593
	protected void handleToggleableCacheField() {
594

    
595
		boolean pushedState = toggleable_cache.getState();
596
        getEntity().setTitleCache(toggleable_cache.getText(), pushedState);
597
        setIrrelevantReferenceDetail(false);
598
        updateToggleableCacheField();
599
    }
600

    
601
	protected void setIrrelevantReferenceDetail(boolean abbrev){
602

    
603
		List<Object> except = new ArrayList();
604
	    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}));
605
	    boolean pushedState;
606
	    if (abbrev){
607
	      except.add(text_title);
608
	      pushedState = toggleableAbbrevCache.getState();
609
	    } else{
610
	    	except.add(text_abbrevTitle);
611
	    	pushedState = toggleable_cache.getState();
612
	    }
613
	    switch( getEntity().getType()){
614
	    case Journal:
615
	    	except.add(element_timePeriod);
616
	    	break;
617
	    case Book:
618
	    	except.remove(text_series);
619
	    	except.remove(text_edition);
620
	    	break;
621
	    default:
622
	    	break;
623
	    }
624
	    setIrrelevant(pushedState, except);
625
	}
626

    
627

    
628

    
629

    
630
}
(3-3/6)