ref #7985: adapt Proceedings details view
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / reference / ReferenceDetailElement.java
index c468b2f43dab6dfa5728a22566b1765aa865e1be..d5d5b6616b2b13de1dc91ef6370b3e6a24131e22 100644 (file)
@@ -1,4 +1,3 @@
-// $Id$
 /**
  * Copyright (C) 2007 EDIT
  * European Distributed Institute of Taxonomy
 
 package eu.etaxonomy.taxeditor.ui.section.reference;
 
-import java.net.URISyntaxException;
+
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
 import org.eclipse.swt.SWT;
+import org.joda.time.DateTime;
 
 import eu.etaxonomy.cdm.model.agent.AgentBase;
 import eu.etaxonomy.cdm.model.agent.Institution;
@@ -23,18 +24,19 @@ import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;
 import eu.etaxonomy.cdm.model.reference.Reference;
 import eu.etaxonomy.cdm.model.reference.ReferenceFactory;
 import eu.etaxonomy.cdm.model.reference.ReferenceType;
-import eu.etaxonomy.taxeditor.model.AbstractUtility;
-import eu.etaxonomy.taxeditor.model.AuthorHelper;
-import eu.etaxonomy.taxeditor.ui.campanula.compatibility.ICdmFormElement;
+import eu.etaxonomy.taxeditor.store.StoreUtil;
 import eu.etaxonomy.taxeditor.ui.combo.EnumComboElement;
 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
 import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;
+import eu.etaxonomy.taxeditor.ui.element.DoiWithLabelElement;
+import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
 import eu.etaxonomy.taxeditor.ui.element.IErrorIntolerableElement;
 import eu.etaxonomy.taxeditor.ui.element.IExceptionHandler;
 import eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement;
-import eu.etaxonomy.taxeditor.ui.element.TimePeriodElement;
 import eu.etaxonomy.taxeditor.ui.element.ToggleableTextElement;
 import eu.etaxonomy.taxeditor.ui.element.UriWithLabelElement;
+import eu.etaxonomy.taxeditor.ui.element.VerbatimTimePeriodElement;
+import eu.etaxonomy.taxeditor.ui.mvc.element.DateElement;
 import eu.etaxonomy.taxeditor.ui.section.AbstractIdentifiableEntityDetailElement;
 import eu.etaxonomy.taxeditor.ui.selection.EntitySelectionElement;
 
@@ -45,11 +47,12 @@ import eu.etaxonomy.taxeditor.ui.selection.EntitySelectionElement;
  *
  * @author n.hoffmann
  * @created Mar 2, 2010
- * @version 1.0
  */
 public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElement<Reference>
                implements IErrorIntolerableElement, IExceptionHandler {
 
+
+
     private ToggleableTextElement toggleableAbbrevCache;
 
        private TextWithLabelElement text_edition;
@@ -62,18 +65,21 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
        private TextWithLabelElement text_publisher;
        private TextWithLabelElement text_referenceAbstract;
        private TextWithLabelElement text_series;
-       private TextWithLabelElement text_seriesPart;
+//     private TextWithLabelElement text_seriesPart;
        private TextWithLabelElement text_volume;
        private TextWithLabelElement text_abbrevTitle;
        private TextWithLabelElement text_title;
+       private DoiWithLabelElement text_doi;
        private UriWithLabelElement text_uri;
+       private DateElement text_accessed;
        private EntitySelectionElement<AgentBase> selection_authorTeam;
-       private TimePeriodElement element_timePeriod;
+       private VerbatimTimePeriodElement element_timePeriod;
        private EntitySelectionElement<Reference> selection_inReference;
        private EntitySelectionElement<Institution> selection_institution;
        private EnumComboElement<ReferenceType> combo_referenceType;
 
        private EntitySelectionElement<Reference> selection_inSeries;
+       private boolean isWizard;
 
        /**
         * <p>
@@ -90,27 +96,23 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
         *            a int.
         */
        public ReferenceDetailElement(CdmFormFactory cdmFormFactory,
-                       ICdmFormElement formElement, int style) {
+                       ICdmFormElement formElement, int style, boolean isWizard) {
                super(cdmFormFactory, formElement);
+               this.isWizard = isWizard;
        }
 
-       /*
-        * (non-Javadoc)
-        *
-        * @see
-        * eu.etaxonomy.taxeditor.forms.section.cdmdetail.AbstractCdmDetailComposite
-        * #createControl(org.eclipse.swt.widgets.Composite, int)
-        */
+
        /** {@inheritDoc} */
        @Override
        protected void createControls(ICdmFormElement formElement,
                        Reference entity, int style) {
+               setWarnForReferencingObjects(formElement);
                toggleable_cache = formFactory.createToggleableTextField(formElement,
                                "Reference Cache", entity.getTitleCache(),
                                entity.isProtectedTitleCache(), style);
 
                toggleableAbbrevCache = formFactory.createToggleableTextField(formElement,
-                       "Abbrev. Cache", entity.getAbbrevTitleCache(),
+                       "Nomencl. Cache", entity.getAbbrevTitleCache(),
                        entity.isProtectedAbbrevTitleCache(), style);
 
                combo_referenceType = formFactory.createEnumComboElement(ReferenceType.class,
@@ -123,16 +125,18 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                                "Title", entity.getTitle(), style);
                // abbreviated title
                text_abbrevTitle = formFactory.createTextWithLabelElement(formElement,
-                       "Abbrev. Title", entity.getAbbrevTitle(), style);
-
+                       "Nomencl. Title", entity.getAbbrevTitle(), style);
+               ReferenceType referenceType = entity.getType();
                // author team
-               selection_authorTeam = formFactory
-                               .createSelectionElement(AgentBase.class,
-                                               getConversationHolder(), formElement, "Author",
-                                               AuthorHelper.getAuthor(entity.getAuthorTeam()),
-                                               EntitySelectionElement.ALL, style);
+               if(referenceType != null && !referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries) ) {
+            selection_authorTeam = formFactory
+                       .createSelectionElement(AgentBase.class,//getConversationHolder(),
+                               formElement, "Author",
+                                       entity.getAuthorship(),
+                                       EntitySelectionElement.ALL, style);
+        }
+
 
-               ReferenceType referenceType = entity.getType();
 
                if (referenceType != null) {
 
@@ -141,11 +145,16 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                        if (referenceType.equals(ReferenceType.Generic)) {
                                createGenericControls(this, entity, SWT.NULL);
                                createPublicationControls(this, referenceType, entity, SWT.NULL);
+
                        } else {
                                if (referenceType.isPrintedUnit()) {
                                        createPrintedUnitControls(this, referenceType, entity,
                                                        SWT.NULL);
                                }
+//                             if (referenceType.equals(ReferenceType.Proceedings)) {
+//                                 text_isbn = formFactory.createTextWithLabelElement(this, "ISBN",
+//                                 entity.getIsbn(), style);
+//                }
                                if (referenceType.isPublication()) {
                                        createPublicationControls(this, referenceType, entity,
                                                        SWT.NULL);
@@ -156,14 +165,31 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                                if (referenceType.isSection()) {
                                        createSectionControls(this, entity, SWT.NULL);
                                }
+
                        }
                }
 
                // date published
-               element_timePeriod = formFactory.createTimePeriodElement(formElement,
-                               "Date Published", entity.getDatePublished(), style);
+               if(referenceType != null && !referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries)){
+                   element_timePeriod = formFactory.createVerbatimTimePeriodElement(formElement,
+                           "Date Published", entity.getDatePublished(), style);
+               }
+
 
+               if(referenceType != null && (!referenceType.equals(ReferenceType.Journal) && !referenceType.equals(ReferenceType.PrintSeries) && !referenceType.equals(ReferenceType.PersonalCommunication))) {
+            text_doi = formFactory.createDoiWithLabelElement(formElement, "DOI", entity.getDoi(), style);
+        }
                createUriAndAbstract(this, entity, SWT.NULL);
+
+               handleToggleableAbbrevTitleField();
+               handleToggleableCacheField();
+       }
+
+       private void createWebPageControls(ReferenceDetailElement referenceDetailElement, Reference reference, int style) {
+               DateTime accessed = reference.getAccessed();
+
+                text_accessed = formFactory.createDateElement(referenceDetailElement, "Accessed", accessed, style, false);
+
        }
 
        /*
@@ -187,8 +213,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                // Object[]{text_cache}));
                toggleable_cache.setEnabled(getEntity().isProtectedTitleCache());
                toggleableAbbrevCache.setEnabled(getEntity().isProtectedAbbrevTitleCache());
-        setIrrelevant(toggleable_cache.getState(), Arrays.asList(new Object[] { toggleable_cache }));
-        setIrrelevant(toggleableAbbrevCache.getState(), Arrays.asList(new Object[] { toggleableAbbrevCache}));
+               setIrrelevantReferenceDetail(false);
+               setIrrelevantReferenceDetail(true);
        }
 
        /**
@@ -207,11 +233,13 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                switch (referenceType) {
                case Generic:
                        break;
+               case Section:
+                   break;
                case BookSection:
                        label = "Book";
                        break;
                case InProceedings:
-                       label = "Print Series";
+                       label = "Proceedings";
                        break;
                case Article:
                        label = "Journal";
@@ -224,8 +252,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
 
                if (createInReferenceWidget) {
                        selection_inReference = formFactory
-                                       .createSelectionElement(Reference.class,
-                                                       getConversationHolder(), element, label,
+                                       .createSelectionElement(Reference.class,//getConversationHolder(),
+                                               element, label,
                                                        reference.getInReference(),
                                                        EntitySelectionElement.ALL, style);
                }
@@ -248,7 +276,7 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
 
                // series
                text_series = formFactory.createTextWithLabelElement(element, "Series",
-                               reference.getSeries(), style);
+                               reference.getSeriesPart(), style);
 
                // volume
                text_volume = formFactory.createTextWithLabelElement(element, "Volume",
@@ -257,6 +285,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                // pages
                text_pages = formFactory.createTextWithLabelElement(element, "Pages",
                                reference.getPages(), style);
+
+
        }
 
        /**
@@ -287,8 +317,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                if (referenceType.equals(ReferenceType.Report)) {
                        // institution
                        selection_institution = formFactory
-                                       .createSelectionElement(Institution.class,
-                                                       getConversationHolder(), element, "Institution",
+                                       .createSelectionElement(Institution.class,//getConversationHolder(),
+                                               element, "Institution",
                                                        reference.getInstitution(),
                                                        EntitySelectionElement.ALL, style);
                }
@@ -296,8 +326,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                if (referenceType.equals(ReferenceType.Thesis)) {
                        // school
                        selection_institution = formFactory
-                                       .createSelectionElement(Institution.class,
-                                                       getConversationHolder(), element, "School",
+                                       .createSelectionElement(Institution.class,//getConversationHolder(),
+                                               element, "School",
                                                        reference.getSchool(),
                                                        EntitySelectionElement.ALL, style);
                }
@@ -337,7 +367,7 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                                reference.getVolume(), style);
 
                text_series = formFactory.createTextWithLabelElement(element, "Series",
-                               reference.getSeries(), style);
+                               reference.getSeriesPart(), style);
        }
 
        /**
@@ -351,8 +381,8 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                        ReferenceType referenceType, Reference reference, int style) {
                // in series
                selection_inSeries = formFactory
-                               .createSelectionElement(Reference.class,
-                                               getConversationHolder(), element, "In Series",
+                               .createSelectionElement(Reference.class,//getConversationHolder(),
+                                       element, "In Series",
                                                (Reference) reference.getInSeries(),
                                                EntitySelectionElement.ALL, style);
 
@@ -360,19 +390,19 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                text_editor = formFactory.createTextWithLabelElement(element, "Editor",
                                reference.getEditor(), style);
 
-               // series part
+               /* series part
                text_seriesPart = formFactory.createTextWithLabelElement(element,
-                               "Series Part", reference.getSeriesPart(), style);
-
+                               "Series", reference.getSeriesPart(), style);
+*/
                if (referenceType.equals(ReferenceType.Book)) {
                        // edition
                        text_edition = formFactory.createTextWithLabelElement(element,
                                        "Edition", reference.getEdition(), style);
 
-                       // isbn
-                       text_isbn = formFactory.createTextWithLabelElement(element, "ISBN",
-                                       reference.getIsbn(), style);
                }
+               // isbn
+        text_isbn = formFactory.createTextWithLabelElement(element, "ISBN",
+                reference.getIsbn(), style);
        }
 
        private void createUriAndAbstract(ICdmFormElement element,
@@ -380,8 +410,11 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                // uri
                text_uri = formFactory.createUriWithLabelElement(element, "URI",
                                reference.getUri(), style);
+               if (reference.getType().equals(ReferenceType.WebPage)){
+                       createWebPageControls(this, reference, style);
+               }
                // abstract
-               text_referenceAbstract = formFactory.createMultilineTextWithLabel(
+               text_referenceAbstract = formFactory.createMultiLineTextWithLabel(
                                element, "Reference Abstract", 100, style);
                text_referenceAbstract.setText(reference.getReferenceAbstract());
        }
@@ -392,14 +425,16 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                if (eventSource == combo_referenceType) {
                        getEntity().setType(combo_referenceType.getSelection());
                        updateContent();
+               //this is needed for the "new" wizards in order to redraw correctly
+                       StoreUtil.reflowParentScrolledForm(getLayoutComposite(), true);
                } else if (eventSource == element_timePeriod) {
                        getEntity().setDatePublished(element_timePeriod.getTimePeriod());
                        clearException();
                }
                // selections
                else if (eventSource == selection_authorTeam) {
-                       getEntity().setAuthorTeam(
-                                       (TeamOrPersonBase) selection_authorTeam.getSelection());
+                       getEntity().setAuthorship(
+                                       (TeamOrPersonBase) selection_authorTeam.getEntity());
                } else if (eventSource == selection_inReference) {
                        getEntity().setInReference(selection_inReference.getSelection());
                } else if (eventSource == selection_inSeries) {
@@ -433,25 +468,26 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                } else if (eventSource == text_referenceAbstract) {
                        getEntity().setReferenceAbstract(text_referenceAbstract.getText());
                } else if (eventSource == text_series) {
-                       getEntity().setSeries(text_series.getText());
-               } else if (eventSource == text_seriesPart) {
-                       getEntity().setSeriesPart(text_seriesPart.getText());
-               } else if (eventSource == text_title) {
+                       getEntity().setSeriesPart(text_series.getText());
+               } else if (eventSource == text_title ) {
                        getEntity().setTitle(text_title.getText());
-                       toggleable_cache.setText(text_title.getText());
-               } else if (eventSource == text_abbrevTitle) {
+                       if (!toggleable_cache.isEnabled()){
+                           toggleable_cache.setText(getEntity().generateTitle());
+                       }
+               } else if (eventSource == text_abbrevTitle ) {
                    getEntity().setAbbrevTitle(text_abbrevTitle.getText());
-                   toggleableAbbrevCache.setText(text_abbrevTitle.getText());
+                   if (!toggleableAbbrevCache.isEnabled()){
+                       toggleableAbbrevCache.setText(getEntity().generateAbbrevTitle());
+                   }
                } else if (eventSource == text_uri) {
-                       try {
-                               getEntity().setUri(text_uri.getUri());
-                       } catch (URISyntaxException e) {
-                               AbstractUtility.warningDialog("Invalid URI", getClass(),
-                                               e.getLocalizedMessage());
-                       }
+                       getEntity().setUri(text_uri.parseText());
                } else if (eventSource == text_volume) {
                        getEntity().setVolume(text_volume.getText());
-               }
+               }else if (eventSource == text_doi) {
+            getEntity().setDoi(text_doi.parseText());
+        }else if (eventSource == text_accessed.getController()) {
+            getEntity().setAccessed(text_accessed.getController().getDateTime());
+        }
 
                if (eventSource != text_title && eventSource != text_abbrevTitle) {
                    // set abbrev title cache to null to force new generation
@@ -460,6 +496,10 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                    if(!getEntity().isProtectedAbbrevTitleCache()){
                        getEntity().setAbbrevTitleCache(null, getEntity().isProtectedAbbrevTitleCache());
                    }
+                   if(!getEntity().isProtectedTitleCache()){
+                getEntity().setTitleCache(null, getEntity().isProtectedTitleCache());
+            }
+
                        toggleable_cache.setText(getEntity().getTitleCache());
                        toggleableAbbrevCache.setText(getEntity().getAbbrevTitleCache());
                }
@@ -481,7 +521,7 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
     protected void handleToggleableAbbrevTitleField() {
         boolean pushedAbbrevState = toggleableAbbrevCache.getState();
         getEntity().setAbbrevTitleCache(toggleableAbbrevCache.getText(), pushedAbbrevState);
-        setIrrelevant(pushedAbbrevState, Arrays.asList(new Object[] { toggleableAbbrevCache, toggleable_cache, text_title }));
+        setIrrelevantReferenceDetail(true);
         updateToggleableCacheField();
     }
 
@@ -555,4 +595,47 @@ public class ReferenceDetailElement extends AbstractIdentifiableEntityDetailElem
                        }
                }
        }
+
+       @Override
+       protected void handleToggleableCacheField() {
+
+               boolean pushedState = toggleable_cache.getState();
+        getEntity().setTitleCache(toggleable_cache.getText(), pushedState);
+        setIrrelevantReferenceDetail(false);
+        updateToggleableCacheField();
+    }
+
+       protected void setIrrelevantReferenceDetail(boolean abbrev){
+
+               List<Object> except = new ArrayList();
+
+           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}));
+           boolean pushedState;
+           if (abbrev){
+             except.add(text_title);
+           } else{
+             except.add(text_abbrevTitle);
+           }
+           pushedState = toggleableAbbrevCache.getState() || toggleable_cache.getState();
+
+           switch( getEntity().getType()){
+           case Journal:
+               except.add(element_timePeriod);
+               break;
+           case Book:
+               except.remove(text_series);
+               except.remove(text_edition);
+               break;
+           default:
+               break;
+           }
+
+           setIrrelevant(pushedState, except);
+           text_title.setIrrelevant(toggleable_cache.getState());
+           text_abbrevTitle.setIrrelevant(toggleableAbbrevCache.getState());
+       }
+
+
+
+
 }