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
.section
.reference
;
13 import java
.net
.URISyntaxException
;
14 import java
.util
.ArrayList
;
15 import java
.util
.Arrays
;
16 import java
.util
.List
;
18 import org
.eclipse
.swt
.SWT
;
20 import eu
.etaxonomy
.cdm
.model
.agent
.AgentBase
;
21 import eu
.etaxonomy
.cdm
.model
.agent
.Institution
;
22 import eu
.etaxonomy
.cdm
.model
.agent
.TeamOrPersonBase
;
23 import eu
.etaxonomy
.cdm
.model
.reference
.Reference
;
24 import eu
.etaxonomy
.cdm
.model
.reference
.ReferenceFactory
;
25 import eu
.etaxonomy
.cdm
.model
.reference
.ReferenceType
;
26 import eu
.etaxonomy
.taxeditor
.model
.AuthorHelper
;
27 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
28 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmFormFactory
;
29 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmPropertyChangeEvent
;
30 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ICdmFormElement
;
31 import eu
.etaxonomy
.taxeditor
.ui
.forms
.IErrorIntolerableElement
;
32 import eu
.etaxonomy
.taxeditor
.ui
.forms
.IExceptionHandler
;
33 import eu
.etaxonomy
.taxeditor
.ui
.forms
.TextWithLabelElement
;
34 import eu
.etaxonomy
.taxeditor
.ui
.forms
.TimePeriodElement
;
35 import eu
.etaxonomy
.taxeditor
.ui
.forms
.ToggleableTextElement
;
36 import eu
.etaxonomy
.taxeditor
.ui
.forms
.UriWithLabelElement
;
37 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmFormFactory
.EnumComboType
;
38 import eu
.etaxonomy
.taxeditor
.ui
.forms
.CdmFormFactory
.SelectionType
;
39 import eu
.etaxonomy
.taxeditor
.ui
.section
.AbstractCdmDetailElement
;
40 import eu
.etaxonomy
.taxeditor
.ui
.selection
.AbstractSelectionElement
;
41 import eu
.etaxonomy
.taxeditor
.ui
.selection
.ReferenceSelectionElement
;
42 import eu
.etaxonomy
.taxeditor
.ui
.term
.ReferenceTypeComboElement
;
45 * <p>ReferenceBaseDetailElement class.</p>
48 * @created Mar 2, 2010
51 public class ReferenceDetailElement
extends AbstractCdmDetailElement
<Reference
> implements IErrorIntolerableElement
, IExceptionHandler
{
54 private ToggleableTextElement toggleable_cache
;
55 private TextWithLabelElement text_edition
;
56 private TextWithLabelElement text_editor
;
57 private TextWithLabelElement text_isbn
;
58 private TextWithLabelElement text_issn
;
59 private TextWithLabelElement text_organisation
;
60 private TextWithLabelElement text_pages
;
61 private TextWithLabelElement text_placePublished
;
62 private TextWithLabelElement text_publisher
;
63 private TextWithLabelElement text_referenceAbstract
;
64 private TextWithLabelElement text_series
;
65 private TextWithLabelElement text_seriesPart
;
66 private TextWithLabelElement text_title
;
67 private TextWithLabelElement text_volume
;
68 private UriWithLabelElement text_uri
;
69 private AbstractSelectionElement
<AgentBase
> selection_authorTeam
;
70 private TimePeriodElement element_timePeriod
;
71 private AbstractSelectionElement
<Reference
> selection_inReference
;
72 private AbstractSelectionElement
<Institution
> selection_institution
;
73 private ReferenceTypeComboElement combo_referenceType
;
75 private ReferenceSelectionElement selection_inSeries
;
79 * <p>Constructor for ReferenceBaseDetailElement.</p>
81 * @param cdmFormFactory a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
82 * @param formElement a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
85 public ReferenceDetailElement(CdmFormFactory cdmFormFactory
,
86 ICdmFormElement formElement
, int style
) {
87 super(cdmFormFactory
, formElement
);
92 * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite#createControl(org.eclipse.swt.widgets.Composite, int)
96 protected void createControls(ICdmFormElement formElement
, Reference entity
, int style
) {
97 toggleable_cache
= formFactory
.createToggleableTextField(formElement
, "Reference Cache", entity
.getTitleCache(), entity
.isProtectedTitleCache(), style
);
99 combo_referenceType
= (ReferenceTypeComboElement
) formFactory
.createEnumComboElement(EnumComboType
.REFERENCETYPE
, formElement
, style
);
101 combo_referenceType
.setSelection(entity
.getType());
104 text_title
= formFactory
.createTextWithLabelElement(formElement
, "Title", entity
.getTitle(), style
);
107 selection_authorTeam
= formFactory
.createSelectionElement(SelectionType
.TEAM
, getConversationHolder(), formElement
, "Author", AuthorHelper
.getAuthor(entity
.getAuthorTeam()), style
);
109 ReferenceType referenceType
= entity
.getType();
111 if(referenceType
!= null){
113 createInReferenceByType(this, referenceType
, entity
, SWT
.NULL
);
115 if(referenceType
.equals(ReferenceType
.Generic
)){
116 createGenericControls(this, entity
, SWT
.NULL
);
118 if(referenceType
.isPrintedUnit()){
119 createPrintedUnitControls(this, referenceType
, entity
, SWT
.NULL
);
121 if(referenceType
.isPublication()){
122 createPublicationControls(this, referenceType
, entity
, SWT
.NULL
);
124 if(referenceType
.isVolumeReference()){
125 createVolumeControls(this, entity
, SWT
.NULL
);
127 if(referenceType
.isSection()){
128 createSectionControls(this, entity
, SWT
.NULL
);
134 element_timePeriod
= formFactory
.createTimePeriodElement(formElement
, "Date Published", entity
.getDatePublished(), style
);
136 createUriAndAbstract(this, entity
, SWT
.NULL
);
141 * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite#updateContent()
145 protected void updateContent() {
146 if(getEntity() == null){
147 setEntity(ReferenceFactory
.newGeneric());
150 super.updateContent();
152 // enable elements according to state of cache protection
153 // setEnabled(getEntity().isProtectedTitleCache(), Arrays.asList(new Object[]{text_cache}));
154 toggleable_cache
.setEnabled(getEntity().isProtectedTitleCache());
155 setIrrelevant(toggleable_cache
.getState(), Arrays
.asList(new Object
[]{toggleable_cache
}));
159 * Creates an in reference for reference types that do hav this.
162 * @param referenceType
166 private void createInReferenceByType(
167 ICdmFormElement element
,
168 ReferenceType referenceType
, Reference reference
, int style
) {
169 boolean createInReferenceWidget
= true;
170 String label
= "In Reference";
172 switch(referenceType
){
179 label
= "Print Series";
187 createInReferenceWidget
= false;
190 if(createInReferenceWidget
){
191 selection_inReference
= formFactory
.createSelectionElement(SelectionType
.REFERENCE
, getConversationHolder(),
192 element
, label
, reference
.getInReference(), style
);
197 * Creates additional controls to edit a generic reference
204 private void createGenericControls(ICdmFormElement element
, Reference reference
, int style
){
207 text_editor
= formFactory
.createTextWithLabelElement(element
, "Editor", reference
.getEditor(), style
);
210 text_series
= formFactory
.createTextWithLabelElement(element
, "Series", reference
.getSeries(), style
);
213 text_volume
= formFactory
.createTextWithLabelElement(element
, "Volume", reference
.getVolume(), style
);
216 text_pages
= formFactory
.createTextWithLabelElement(element
, "Pages", reference
.getPages(), style
);
221 * Creates additional controls to edit a publication
228 private void createPublicationControls(ICdmFormElement element
, ReferenceType referenceType
, Reference reference
, int style
){
231 text_placePublished
= formFactory
.createTextWithLabelElement(element
, "Place Published", reference
.getPlacePublished(), style
);
234 text_publisher
= formFactory
.createTextWithLabelElement(element
, "Publisher", reference
.getPublisher(), style
);
236 if(referenceType
.equals(ReferenceType
.Journal
)){
238 text_issn
= formFactory
.createTextWithLabelElement(element
, "ISSN", reference
.getIssn(), style
);
241 if(referenceType
.equals(ReferenceType
.Report
)){
243 selection_institution
= formFactory
.createSelectionElement(SelectionType
.INSTITUTION
, getConversationHolder(), element
, "Institution", reference
.getInstitution(), style
);
246 if(referenceType
.equals(ReferenceType
.Thesis
)){
248 selection_institution
= formFactory
.createSelectionElement(SelectionType
.INSTITUTION
, getConversationHolder(), element
, "School", reference
.getSchool(), style
);
251 if(referenceType
.equals(ReferenceType
.Proceedings
)){
253 text_organisation
= formFactory
.createTextWithLabelElement(element
, "Organisation", reference
.getOrganization(), style
);
259 * Creates additional controls to edit a section
265 private void createSectionControls(ICdmFormElement element
, Reference reference
, int style
){
267 text_pages
= formFactory
.createTextWithLabelElement(element
, "Pages", reference
.getPages(), style
);
271 * Creates additional controls to edit a volume
277 private void createVolumeControls(ICdmFormElement element
, Reference reference
, int style
){
279 text_volume
= formFactory
.createTextWithLabelElement(element
, "Volume", reference
.getVolume(), style
);
281 text_series
= formFactory
.createTextWithLabelElement(element
, "Series", reference
.getSeries(), style
);
288 * @param referenceType
292 private void createPrintedUnitControls(ICdmFormElement element
, ReferenceType referenceType
, Reference reference
, int style
){
294 selection_inSeries
= (ReferenceSelectionElement
) formFactory
.createSelectionElement(SelectionType
.REFERENCE
, getConversationHolder(), element
, "In Series", (Reference
) reference
.getInSeries(), style
);
297 text_editor
= formFactory
.createTextWithLabelElement(element
, "Editor", reference
.getEditor(), style
);
300 text_seriesPart
= formFactory
.createTextWithLabelElement(element
, "Series Part", reference
.getSeriesPart(), style
);
302 if(referenceType
.equals(ReferenceType
.Book
)){
304 text_edition
= formFactory
.createTextWithLabelElement(element
, "Edition", reference
.getEdition(), style
);
307 text_isbn
= formFactory
.createTextWithLabelElement(element
, "ISBN", reference
.getIsbn(), style
);
311 private void createUriAndAbstract(ICdmFormElement element
,
312 Reference reference
, int style
) {
314 text_uri
= formFactory
.createUriWithLabelElement(element
, "URI", reference
.getUri(), style
);
316 text_referenceAbstract
= formFactory
.createMultilineTextWithLabel(element
, "Reference Abstract", 100, style
);
317 text_referenceAbstract
.setText(reference
.getReferenceAbstract());
323 public void handleEvent(Object eventSource
) {
324 if(eventSource
== combo_referenceType
){
325 getEntity().setType(combo_referenceType
.getSelection());
326 getParentElement().refresh();
328 else if(eventSource
== element_timePeriod
){
329 getEntity().setDatePublished(element_timePeriod
.getTimePeriod());
333 else if(eventSource
== selection_authorTeam
){
334 getEntity().setAuthorTeam((TeamOrPersonBase
)selection_authorTeam
.getSelection());
336 else if(eventSource
== selection_inReference
){
337 getEntity().setInReference(selection_inReference
.getSelection());
339 else if(eventSource
== selection_inSeries
){
340 getEntity().setInReference(selection_inSeries
.getSelection());
342 else if(eventSource
== selection_institution
){
343 getEntity().setInstitution(selection_institution
.getSelection());
347 else if(eventSource
== toggleable_cache
){
348 getEntity().setTitleCache(toggleable_cache
.getText(), toggleable_cache
.getState());
349 // setEnabled(! text_cache.getState(), Arrays.asList(new Object[]{text_cache}));
350 setIrrelevant(toggleable_cache
.getState(), Arrays
.asList(new Object
[]{toggleable_cache
}));
352 else if(eventSource
== text_edition
){
353 getEntity().setEdition(text_edition
.getText());
355 else if(eventSource
== text_editor
){
356 getEntity().setEditor(text_editor
.getText());
358 else if(eventSource
== text_isbn
){
359 getEntity().setIsbn(text_isbn
.getText());
361 else if(eventSource
== text_issn
){
362 getEntity().setIssn(text_issn
.getText());
364 else if(eventSource
== text_organisation
){
365 getEntity().setOrganization(text_organisation
.getText());
367 else if(eventSource
== text_pages
){
368 getEntity().setPages(text_pages
.getText());
370 else if(eventSource
== text_placePublished
){
371 getEntity().setPlacePublished(text_placePublished
.getText());
373 else if(eventSource
== text_publisher
){
374 getEntity().setPublisher(text_publisher
.getText());
376 else if(eventSource
== text_referenceAbstract
){
377 getEntity().setReferenceAbstract(text_referenceAbstract
.getText());
379 else if(eventSource
== text_series
){
380 getEntity().setSeries(text_series
.getText());
382 else if(eventSource
== text_seriesPart
){
383 getEntity().setSeriesPart(text_seriesPart
.getText());
385 else if(eventSource
== text_title
){
386 getEntity().setTitle(text_title
.getText());
388 else if(eventSource
== text_uri
){
390 getEntity().setUri(text_uri
.getUri());
391 } catch (URISyntaxException e
) {
392 StoreUtil
.warningDialog("Invlid URI", getClass(), e
.getLocalizedMessage());
395 else if(eventSource
== text_volume
){
396 getEntity().setVolume(text_volume
.getText());
399 else if(eventSource
!= toggleable_cache
){
400 toggleable_cache
.setText(getEntity().getTitleCache());
406 * @see eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement#handleException(eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
410 public void handleException(CdmPropertyChangeEvent event
) {
411 exceptionOccurred(event
);
415 * @see eu.etaxonomy.taxeditor.forms.IExceptionHandler#clearException()
419 public void clearException() {
420 exceptionOccurred(null);
423 private List
<IExceptionHandler
> exceptionHandlers
= new ArrayList
<IExceptionHandler
>();
426 * @see eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#addExceptionHandler(eu.etaxonomy.taxeditor.forms.IExceptionHandler)
430 public void addExceptionHandler(IExceptionHandler handler
) {
431 exceptionHandlers
.add(handler
);
435 * @see eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#removeExceptionHandler(eu.etaxonomy.taxeditor.forms.IExceptionHandler)
439 public void removeExceptionHandler(IExceptionHandler handler
) {
440 exceptionHandlers
.remove(handler
);
444 * @see eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#exceptionOccurred(eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
448 public void exceptionOccurred(CdmPropertyChangeEvent event
) {
449 for(IExceptionHandler handler
: exceptionHandlers
){
453 handler
.handleException(event
);