eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/name/TypeDesignationSection.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.name;
  11
  12 import java.util.Collection;
  13
  14 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  15 import eu.etaxonomy.cdm.api.service.INameService;
  16 import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;
  17 import eu.etaxonomy.cdm.model.name.NameTypeDesignation;
  18 import eu.etaxonomy.cdm.model.name.NonViralName;
  19 import eu.etaxonomy.cdm.model.name.Rank;
  20 import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignation;
  21 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
  22 import eu.etaxonomy.cdm.model.name.TypeDesignationBase;
  23 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  24 import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;
  25 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
  26 import eu.etaxonomy.taxeditor.store.CdmStore;
  27 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
  28 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
  29 import eu.etaxonomy.taxeditor.ui.section.AbstractEntityCollectionSection;
  30 import eu.etaxonomy.taxeditor.ui.section.ITaxonBaseDetailSection;
  31
  32 /**
  33  * <p>TypeDesignationSection class.</p>
  34  *
  35  * @author n.hoffmann
  36  * @created May 17, 2010
  37  * @version 1.0
  38  */
  39 public class TypeDesignationSection extends AbstractEntityCollectionSection<TaxonNameBase, TypeDesignationBase> implements ITaxonBaseDetailSection {
  40
  41         private TaxonBase taxonBase;
  42
  43         /**
  44          * <p>Constructor for TypeDesignationSection.</p>
  45          *
  46          * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
  47          * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
  48          * @param parentElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
  49          * @param style a int.
  50          */
  51         public TypeDesignationSection(CdmFormFactory formFactory, ConversationHolder conversation,
  52                         ICdmFormElement parentElement, int style) {
  53                 super(formFactory, conversation, parentElement, "Type Designations", style);
  54         }
  55
  56         /** {@inheritDoc} */
  57         @Override
  58         public void addElement(TypeDesignationBase element) {
  59                 getEntity().addTypeDesignation(element, PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.ADD_TYPES_TO_ALL_NAMES));
  60         }
  61
  62         /** {@inheritDoc} */
  63         @Override
  64         public TypeDesignationBase createNewElement() {
  65                 if(isSpecimenType()){
  66                         return SpecimenTypeDesignation.NewInstance();
  67                 }else{
  68                         return NameTypeDesignation.NewInstance();
  69                 }
  70         }
  71
  72         /** {@inheritDoc} */
  73         @Override
  74         public Collection<TypeDesignationBase> getCollection(TaxonNameBase entity) {
  75                 if (entity == null){
  76                         return null;
  77                 }
  78                 return entity.getTypeDesignations();
  79         }
  80
  81         /** {@inheritDoc} */
  82         @Override
  83         public String getEmptyString() {
  84                 return "No type designations yet.";
  85         }
  86
  87         /** {@inheritDoc} */
  88         @Override
  89         protected String getTooltipString() {
  90                 return "Add a type designation";
  91         }
  92
  93         /** {@inheritDoc} */
  94         @Override
  95         public void removeElement(TypeDesignationBase element) {
  96                 boolean removeTypeDesignationFromAllTypifiedNames = PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.ADD_TYPES_TO_ALL_NAMES);
  97                 TaxonNameBase entity = removeTypeDesignationFromAllTypifiedNames ? null : getEntity();
  98                 CdmStore.getService(INameService.class).deleteTypeDesignation(entity, element);
  99         }
 100
 101         /*
 102          * (non-Javadoc)
 103          * @see eu.etaxonomy.taxeditor.section.ITaxonDetailSection#setTaxon(eu.etaxonomy.cdm.model.taxon.TaxonBase)
 104          */
 105         /** {@inheritDoc} */
 106         @Override
 107     public void setTaxonBase(TaxonBase entity) {
 108                 this.taxonBase = entity;
 109                 NonViralName name = (NonViralName) HibernateProxyHelper.deproxy(entity.getName());
 110                 setEntity(name);
 111         }
 112
 113         private boolean isSpecimenType(){
 114                 Rank rank = getEntity().getRank();
 115                 if(rank==null){
 116                         return false;
 117                 }
 118                 return rank.isSpecies() || rank.isInfraSpecific();
 119         }
 120
 121         /* (non-Javadoc)
 122          * @see eu.etaxonomy.taxeditor.section.ITaxonDetailSection#getTaxon(eu.etaxonomy.cdm.model.taxon.TaxonBase)
 123          */
 124         @Override
 125         public TaxonBase getTaxonBase() {
 126                 return taxonBase;
 127         }
 128 }