Merge branch 'develop' into LibrAlign
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / reference / ReferenceDetailElement.java
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 import java.util.ArrayList;
14 import java.util.Arrays;
15 import java.util.List;
16
17 import org.eclipse.swt.SWT;
18 import org.eclipse.swt.widgets.Display;
19
20 import eu.etaxonomy.cdm.common.CdmUtils;
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.store.CdmStore;
28 import eu.etaxonomy.taxeditor.ui.combo.EnumComboElement;
29 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
30 import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
31 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
32 import eu.etaxonomy.taxeditor.ui.element.IErrorIntolerableElement;
33 import eu.etaxonomy.taxeditor.ui.element.IExceptionHandler;
34 import eu.etaxonomy.taxeditor.ui.element.LabelElement;
35 import eu.etaxonomy.taxeditor.ui.element.LayoutConstants;
36 import eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement;
37 import eu.etaxonomy.taxeditor.ui.element.TimePeriodElement;
38 import eu.etaxonomy.taxeditor.ui.element.ToggleableTextElement;
39 import eu.etaxonomy.taxeditor.ui.element.UriWithLabelElement;
40 import eu.etaxonomy.taxeditor.ui.section.AbstractIdentifiableEntityDetailElement;
41 import eu.etaxonomy.taxeditor.ui.selection.EntitySelectionElement;
42
43 /**
44 * <p>
45 * ReferenceBaseDetailElement class.
46 * </p>
47 *
48 * @author n.hoffmann
49 * @created Mar 2, 2010
50 * @version 1.0
51 */
52 public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElement<Reference>
53 implements IErrorIntolerableElement, IExceptionHandler {
54
55 private LabelElement warnForReferencedObjects;
56
57 private ToggleableTextElement toggleableAbbrevCache;
58
59 private TextWithLabelElement text_edition;
60 private TextWithLabelElement text_editor;
61 private TextWithLabelElement text_isbn;
62 private TextWithLabelElement text_issn;
63 private TextWithLabelElement text_organisation;
64 private TextWithLabelElement text_pages;
65 private TextWithLabelElement text_placePublished;
66 private TextWithLabelElement text_publisher;
67 private TextWithLabelElement text_referenceAbstract;
68 private TextWithLabelElement text_series;
69 // private TextWithLabelElement text_seriesPart;
70 private TextWithLabelElement text_volume;
71 private TextWithLabelElement text_abbrevTitle;
72 private TextWithLabelElement text_title;
73 private UriWithLabelElement text_uri;
74 private EntitySelectionElement<AgentBase> selection_authorTeam;
75 private TimePeriodElement element_timePeriod;
76 private EntitySelectionElement<Reference> selection_inReference;
77 private EntitySelectionElement<Institution> selection_institution;
78 private EnumComboElement<ReferenceType> combo_referenceType;
79
80 private EntitySelectionElement<Reference> selection_inSeries;
81 private boolean isWizard;
82
83 /**
84 * <p>
85 * Constructor for ReferenceBaseDetailElement.
86 * </p>
87 *
88 * @param cdmFormFactory
89 * a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory}
90 * object.
91 * @param formElement
92 * a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}
93 * object.
94 * @param style
95 * a int.
96 */
97 public ReferenceDetailElement(CdmFormFactory cdmFormFactory,
98 ICdmFormElement formElement, int style, boolean isWizard) {
99 super(cdmFormFactory, formElement);
100 this.isWizard = isWizard;
101 }
102
103 /*
104 * (non-Javadoc)
105 *
106 * @see
107 * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
108 * #createControl(org.eclipse.swt.widgets.Composite, int)
109 */
110 /** {@inheritDoc} */
111 @Override
112 protected void createControls(ICdmFormElement formElement,
113 Reference entity, int style) {
114 ICdmFormElement o = this.getParentElement();
115 Class clazz=o.getClass();
116 if (isWizard){
117 setWarnForReferencingObjects(formElement);
118 }
119
120
121 toggleable_cache = formFactory.createToggleableTextField(formElement,
122 "Reference Cache", entity.getTitleCache(),
123 entity.isProtectedTitleCache(), style);
124
125 toggleableAbbrevCache = formFactory.createToggleableTextField(formElement,
126 "Abbrev. Cache", entity.getAbbrevTitleCache(),
127 entity.isProtectedAbbrevTitleCache(), style);
128
129 combo_referenceType = formFactory.createEnumComboElement(ReferenceType.class,
130 formElement, style);
131
132 combo_referenceType.setSelection(entity.getType());
133
134 // title
135 text_title = formFactory.createTextWithLabelElement(formElement,
136 "Title", entity.getTitle(), style);
137 // abbreviated title
138 text_abbrevTitle = formFactory.createTextWithLabelElement(formElement,
139 "Nomenclatural Title", entity.getAbbrevTitle(), style);
140
141 // author team
142 selection_authorTeam = formFactory
143 .createSelectionElement(AgentBase.class,
144 getConversationHolder(), formElement, "Author",
145 entity.getAuthorship(),
146 EntitySelectionElement.ALL, style);
147
148 ReferenceType referenceType = entity.getType();
149
150 if (referenceType != null) {
151
152 createInReferenceByType(this, referenceType, entity, SWT.NULL);
153
154 if (referenceType.equals(ReferenceType.Generic)) {
155 createGenericControls(this, entity, SWT.NULL);
156 createPublicationControls(this, referenceType, entity, SWT.NULL);
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 // date published
176 element_timePeriod = formFactory.createTimePeriodElement(formElement,
177 "Date Published", entity.getDatePublished(), style);
178
179 createUriAndAbstract(this, entity, SWT.NULL);
180 handleToggleableAbbrevTitleField();
181 handleToggleableCacheField();
182 }
183
184 /*
185 * (non-Javadoc)
186 *
187 * @see
188 * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
189 * #updateContent()
190 */
191 /** {@inheritDoc} */
192 @Override
193 protected void updateContent() {
194 if (getEntity() == null) {
195 setEntity(ReferenceFactory.newGeneric());
196 }
197
198 super.updateContent();
199
200 // enable elements according to state of cache protection
201 // setEnabled(getEntity().isProtectedTitleCache(), Arrays.asList(new
202 // Object[]{text_cache}));
203 toggleable_cache.setEnabled(getEntity().isProtectedTitleCache());
204 toggleableAbbrevCache.setEnabled(getEntity().isProtectedAbbrevTitleCache());
205 setIrrelevantReferenceDetail(false);
206 setIrrelevantReferenceDetail(true);
207 }
208
209 /**
210 * Creates an in reference for reference types that do hav this.
211 *
212 * @param element
213 * @param referenceType
214 * @param reference
215 * @param style
216 */
217 private void createInReferenceByType(ICdmFormElement element,
218 ReferenceType referenceType, Reference reference, int style) {
219 boolean createInReferenceWidget = true;
220 String label = "In Reference";
221
222 switch (referenceType) {
223 case Generic:
224 break;
225 case Section:
226 break;
227 case BookSection:
228 label = "Book";
229 break;
230 case InProceedings:
231 label = "Print Series";
232 break;
233 case Article:
234 label = "Journal";
235 break;
236 case WebPage:
237 break;
238 default:
239 createInReferenceWidget = false;
240 }
241
242 if (createInReferenceWidget) {
243 selection_inReference = formFactory
244 .createSelectionElement(Reference.class,
245 getConversationHolder(), element, label,
246 reference.getInReference(),
247 EntitySelectionElement.ALL, style);
248 }
249 }
250
251 /**
252 * Creates additional controls to edit a generic reference
253 *
254 * @param element
255 * @param reference
256 * @param listener
257 * @param style
258 */
259 private void createGenericControls(ICdmFormElement element,
260 Reference reference, int style) {
261
262 // editor
263 text_editor = formFactory.createTextWithLabelElement(element, "Editor",
264 reference.getEditor(), style);
265
266 // series
267 text_series = formFactory.createTextWithLabelElement(element, "Series",
268 reference.getSeriesPart(), style);
269
270 // volume
271 text_volume = formFactory.createTextWithLabelElement(element, "Volume",
272 reference.getVolume(), style);
273
274 // pages
275 text_pages = formFactory.createTextWithLabelElement(element, "Pages",
276 reference.getPages(), style);
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,
308 getConversationHolder(), 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,
317 getConversationHolder(), 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,
372 getConversationHolder(), 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 // abstract
401 text_referenceAbstract = formFactory.createMultiLineTextWithLabel(
402 element, "Reference Abstract", 100, style);
403 text_referenceAbstract.setText(reference.getReferenceAbstract());
404 }
405
406 /** {@inheritDoc} */
407 @Override
408 public void handleEvent(Object eventSource) {
409 if (eventSource == combo_referenceType) {
410 getEntity().setType(combo_referenceType.getSelection());
411 updateContent();
412 } else if (eventSource == element_timePeriod) {
413 getEntity().setDatePublished(element_timePeriod.getTimePeriod());
414 clearException();
415 }
416 // selections
417 else if (eventSource == selection_authorTeam) {
418 getEntity().setAuthorship(
419 (TeamOrPersonBase) selection_authorTeam.getSelection());
420 } else if (eventSource == selection_inReference) {
421 getEntity().setInReference(selection_inReference.getSelection());
422 } else if (eventSource == selection_inSeries) {
423 getEntity().setInReference(selection_inSeries.getSelection());
424 } else if (eventSource == selection_institution) {
425 getEntity().setInstitution(selection_institution.getSelection());
426 }
427
428 // textfields
429 else if (eventSource == toggleable_cache) {
430 handleToggleableCacheField();
431 }
432 else if (eventSource == toggleableAbbrevCache) {
433 handleToggleableAbbrevTitleField();
434 } else if (eventSource == text_edition) {
435 getEntity().setEdition(text_edition.getText());
436 } else if (eventSource == text_editor) {
437 getEntity().setEditor(text_editor.getText());
438 } else if (eventSource == text_isbn) {
439 getEntity().setIsbn(text_isbn.getText());
440 } else if (eventSource == text_issn) {
441 getEntity().setIssn(text_issn.getText());
442 } else if (eventSource == text_organisation) {
443 getEntity().setOrganization(text_organisation.getText());
444 } else if (eventSource == text_pages) {
445 getEntity().setPages(text_pages.getText());
446 } else if (eventSource == text_placePublished) {
447 getEntity().setPlacePublished(text_placePublished.getText());
448 } else if (eventSource == text_publisher) {
449 getEntity().setPublisher(text_publisher.getText());
450 } else if (eventSource == text_referenceAbstract) {
451 getEntity().setReferenceAbstract(text_referenceAbstract.getText());
452 } else if (eventSource == text_series) {
453 getEntity().setSeriesPart(text_series.getText());
454 } else if (eventSource == text_title ) {
455 getEntity().setTitle(text_title.getText());
456 if (!toggleable_cache.isEnabled()){
457 toggleable_cache.setText(getEntity().generateTitle());
458 }
459 } else if (eventSource == text_abbrevTitle ) {
460 getEntity().setAbbrevTitle(text_abbrevTitle.getText());
461 if (!toggleableAbbrevCache.isEnabled()){
462 toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
463 }
464 } else if (eventSource == text_uri) {
465 getEntity().setUri(text_uri.parseText());
466 } else if (eventSource == text_volume) {
467 getEntity().setVolume(text_volume.getText());
468 }
469
470 if (eventSource != text_title && eventSource != text_abbrevTitle) {
471 // set abbrev title cache to null to force new generation
472 // for the standard title cache this is done by a PropertyChangeListener registered
473 // in IdentifiableEntity.initListeners()
474 if(!getEntity().isProtectedAbbrevTitleCache()){
475 getEntity().setAbbrevTitleCache(null, getEntity().isProtectedAbbrevTitleCache());
476 }
477 toggleable_cache.setText(getEntity().getTitleCache());
478 toggleableAbbrevCache.setText(getEntity().getAbbrevTitleCache());
479 }
480
481 firePropertyChangeEvent(new CdmPropertyChangeEvent(this, null));
482 }
483
484
485 @Override
486 public void updateToggleableCacheField() {
487 if (!getEntity().isProtectedTitleCache()) {
488 toggleable_cache.setText(getEntity().generateTitle());
489 }
490 if (!getEntity().isProtectedAbbrevTitleCache()) {
491 toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
492 }
493 }
494
495 protected void handleToggleableAbbrevTitleField() {
496 boolean pushedAbbrevState = toggleableAbbrevCache.getState();
497 getEntity().setAbbrevTitleCache(toggleableAbbrevCache.getText(), pushedAbbrevState);
498 setIrrelevantReferenceDetail(true);
499 updateToggleableCacheField();
500 }
501
502 /*
503 * (non-Javadoc)
504 *
505 * @see
506 * eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement#handleException
507 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
508 */
509 /** {@inheritDoc} */
510 @Override
511 public void handleException(CdmPropertyChangeEvent event) {
512 exceptionOccurred(event);
513 }
514
515 /*
516 * (non-Javadoc)
517 *
518 * @see eu.etaxonomy.taxeditor.forms.IExceptionHandler#clearException()
519 */
520 /** {@inheritDoc} */
521 @Override
522 public void clearException() {
523 exceptionOccurred(null);
524 }
525
526 private final List<IExceptionHandler> exceptionHandlers = new ArrayList<IExceptionHandler>();
527
528 /*
529 * (non-Javadoc)
530 *
531 * @see
532 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#addExceptionHandler
533 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
534 */
535 /** {@inheritDoc} */
536 @Override
537 public void addExceptionHandler(IExceptionHandler handler) {
538 exceptionHandlers.add(handler);
539 }
540
541 /*
542 * (non-Javadoc)
543 *
544 * @see
545 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#removeExceptionHandler
546 * (eu.etaxonomy.taxeditor.forms.IExceptionHandler)
547 */
548 /** {@inheritDoc} */
549 @Override
550 public void removeExceptionHandler(IExceptionHandler handler) {
551 exceptionHandlers.remove(handler);
552 }
553
554 /*
555 * (non-Javadoc)
556 *
557 * @see
558 * eu.etaxonomy.taxeditor.forms.IErrorIntolerableElement#exceptionOccurred
559 * (eu.etaxonomy.taxeditor.forms.CdmPropertyChangeEvent)
560 */
561 /** {@inheritDoc} */
562 @Override
563 public void exceptionOccurred(CdmPropertyChangeEvent event) {
564 for (IExceptionHandler handler : exceptionHandlers) {
565 if (event == null) {
566 handler.clearException();
567 } else {
568 handler.handleException(event);
569 }
570 }
571 }
572
573 @Override
574 protected void handleToggleableCacheField() {
575
576 boolean pushedState = toggleable_cache.getState();
577 getEntity().setTitleCache(toggleable_cache.getText(), pushedState);
578 setIrrelevantReferenceDetail(false);
579 updateToggleableCacheField();
580 }
581
582 protected void setIrrelevantReferenceDetail(boolean abbrev){
583
584 List<Object> except = new ArrayList();
585 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}));
586 boolean pushedState;
587 if (abbrev){
588 except.add(text_title);
589 pushedState = toggleableAbbrevCache.getState();
590 } else{
591 except.add(text_abbrevTitle);
592 pushedState = toggleable_cache.getState();
593 }
594 switch( getEntity().getType()){
595 case Journal:
596 except.add(element_timePeriod);
597 break;
598 case Book:
599 except.remove(text_series);
600 except.remove(text_edition);
601 break;
602 default:
603 break;
604 }
605 setIrrelevant(pushedState, except);
606 }
607
608 public void setWarnForReferencingObjects(ICdmFormElement formElement){
609 if (getEntity().getId() != 0){
610 Integer referencingObjectsCount = CdmStore.getCommonService().getReferencingObjectsCount(getEntity());
611
612 if (referencingObjectsCount > 1){
613 if (warnForReferencedObjects == null){
614 warnForReferencedObjects = formFactory.createLabel(formElement, CdmUtils.Nz("The reference is referenced by " + referencingObjectsCount+ " objects, if you change it, it is changed for all these objects"));
615 warnForReferencedObjects.setBackground(Display.getCurrent().getSystemColor(SWT.COLOR_RED));
616 warnForReferencedObjects.setLayout(LayoutConstants.FILL(2, 2));
617 warnForReferencedObjects.setForeground(Display.getCurrent().getSystemColor(
618 SWT.COLOR_RED));
619
620 }else{
621 warnForReferencedObjects.setText(CdmUtils.Nz("The reference is referenced by " + referencingObjectsCount+ " objects, if you change it, it is changed for all these objects"));
622 }
623 warnForReferencedObjects.setVisible(false);
624 }
625 }
626 }
627
628 public void setWarnForReferencingObjectsVisible(boolean isVisible){
629 if (warnForReferencedObjects != null){
630 warnForReferencedObjects.setVisible(isVisible);
631 }
632 }
633
634
635 }