eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/view/derivateSearch/DerivateLabelProvider.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2013 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   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.
   9 */
  10 package eu.etaxonomy.taxeditor.view.derivateSearch;
  11
  12 import java.util.List;
  13 import java.util.Set;
  14 import java.util.UUID;
  15
  16 import org.eclipse.jface.viewers.ColumnLabelProvider;
  17 import org.eclipse.jface.viewers.TreeNode;
  18 import org.eclipse.swt.graphics.Image;
  19 import org.hibernate.LazyInitializationException;
  20
  21 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  22 import eu.etaxonomy.cdm.api.service.IOccurrenceService;
  23 import eu.etaxonomy.cdm.model.common.DefinedTerm;
  24 import eu.etaxonomy.cdm.model.molecular.DnaSample;
  25 import eu.etaxonomy.cdm.model.molecular.Sequence;
  26 import eu.etaxonomy.cdm.model.molecular.SingleRead;
  27 import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;
  28 import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
  29 import eu.etaxonomy.cdm.model.occurrence.GatheringEvent;
  30 import eu.etaxonomy.cdm.model.occurrence.MediaSpecimen;
  31 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  32 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
  33 import eu.etaxonomy.taxeditor.model.ImageResources;
  34 import eu.etaxonomy.taxeditor.store.CdmStore;
  35
  36 /**
  37  * Label provider for the views to show {@link SpecimenOrObservationBase}s.<br>
  38  * <br>
  39  * <b>Note:</b> If you use this label provider you need to assure that you
  40  * created a {@link ConversationHolder} resp. have an open session because
  41  * the labels are generated from various fields of the derivate hierarchy which
  42  * are lazy loaded and could therefore throw a {@link LazyInitializationException}.<br>
  43  * Use <b>{@link #setConversation(ConversationHolder)}</b> to assign the session to this provider.
  44  */
  45 public class DerivateLabelProvider extends ColumnLabelProvider {
  46
  47     private Set<SingleRead> multiLinkSingleReads;
  48
  49     private ConversationHolder conversation;
  50
  51     private static DefinedTerm photoTerm = null;
  52     private static DefinedTerm drawingTerm = null;
  53     private static DefinedTerm specimenScanTerm = null;
  54     private static DefinedTerm detailImageTerm = null;
  55
  56     private static void initializeTerms() {
  57         List<DefinedTerm> preferredTerms = CdmStore.getTermManager().getPreferredTerms(DefinedTerm.class);
  58         for (DefinedTerm definedTerm : preferredTerms) {
  59             if(definedTerm.getUuid().equals(UUID.fromString("c5c59c42-f254-471e-96c6-09f459f7c903"))){
  60                 photoTerm = definedTerm;
  61             }
  62             else if(definedTerm.getUuid().equals(UUID.fromString("669b0409-4aa4-4695-aae4-a95ed27bad4c"))){
  63                 drawingTerm = definedTerm;
  64             }
  65             else if(definedTerm.getUuid().equals(UUID.fromString("acda15be-c0e2-4ea8-8783-b9b0c4ad7f03"))){
  66                 specimenScanTerm = definedTerm;
  67             }
  68             else if(definedTerm.getUuid().equals(UUID.fromString("31eb8d02-bf5d-437c-bcc6-87a626445f34"))){
  69                 detailImageTerm = definedTerm;
  70             }
  71         }
  72     }
  73
  74     public static DefinedTerm getLivingPlantPhotoTerm(){
  75         if(photoTerm==null){
  76             initializeTerms();
  77         }
  78         return photoTerm;
  79     }
  80
  81     public static DefinedTerm getArtworkTerm(){
  82         if(drawingTerm==null){
  83             initializeTerms();
  84         }
  85         return drawingTerm;
  86     }
  87
  88     public static DefinedTerm getSpecimenScanTerm(){
  89         if(specimenScanTerm==null){
  90             initializeTerms();
  91         }
  92         return specimenScanTerm;
  93     }
  94
  95     public static DefinedTerm getDetailImageTerm(){
  96         if(detailImageTerm==null){
  97             initializeTerms();
  98         }
  99         return detailImageTerm;
 100     }
 101
 102
 103     /** {@inheritDoc} */
 104     @Override
 105     public String getText(Object element) {
 106         return getDerivateText(element);
 107     }
 108
 109     /** {@inheritDoc} */
 110     @Override
 111     public String getToolTipText(Object element) {
 112         return getDerivateText(element);
 113     }
 114
 115     /**
 116      * @param conversation the conversation to set
 117      */
 118     public void setConversation(ConversationHolder conversation) {
 119         this.conversation = conversation;
 120     }
 121
 122     /**
 123      *
 124      * @param element
 125      * @return
 126      */
 127     public String getDerivateText(Object element){
 128         TreeNode parentNode = null;
 129         if(element instanceof TreeNode){
 130             parentNode = ((TreeNode) element).getParent();
 131             //unwrap specimen from TreeNode
 132             element = ((TreeNode) element).getValue();
 133         }
 134
 135         conversation.bind();
 136
 137         String label = "";
 138         if(element instanceof FieldUnit){
 139             FieldUnit fieldUnit = (FieldUnit)element;
 140             if(fieldUnit.getGatheringEvent()!=null){
 141                 GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
 142                 if(!conversation.getSession().contains(gatheringEvent)){
 143                     fieldUnit = (FieldUnit) CdmStore.getService(IOccurrenceService.class).load(fieldUnit.getUuid());
 144                     gatheringEvent = fieldUnit.getGatheringEvent();
 145                 }
 146                 label += gatheringEvent.getCountry()!=null?gatheringEvent.getCountry().getLabel()+", ":"";
 147                 label += gatheringEvent.getLocality()!=null?gatheringEvent.getLocality().getText()+", ":"";
 148                 label += gatheringEvent.getGatheringDate()!=null?gatheringEvent.getGatheringDate()+", ":"";
 149                 label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+", ":"";
 150             }
 151             label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber():"";
 152         }
 153         else if(element instanceof MediaSpecimen){
 154             MediaSpecimen mediaSpecimen = (MediaSpecimen)element;
 155             if(mediaSpecimen.getMediaSpecimen()!=null){
 156                 label += mediaSpecimen.getMediaSpecimen().getTitle()!=null?mediaSpecimen.getMediaSpecimen().getTitle().getText()+", ":"[no motif]";
 157                 label += mediaSpecimen.getMediaSpecimen().getArtist()!=null?mediaSpecimen.getMediaSpecimen().getArtist()+", ":"";
 158             }
 159             eu.etaxonomy.cdm.model.occurrence.Collection collection = mediaSpecimen.getCollection();
 160             if(collection!=null){
 161                 label += collection.getName()!=null?collection.getName()+" ":"";
 162                 label += collection.getCode()!=null?"("+collection.getCode()+"), ":"";
 163             }
 164             label += mediaSpecimen.getAccessionNumber()!=null?mediaSpecimen.getAccessionNumber()+", ":"";
 165         }
 166         else if(element instanceof DnaSample
 167                 || (element instanceof DerivedUnit
 168                         && ((SpecimenOrObservationBase<?>) element).getRecordBasis()==SpecimenOrObservationType.DnaSample)){
 169             label += "[no sample designation]";
 170
 171         }
 172         else if(element instanceof DerivedUnit){
 173             DerivedUnit derivedUnit = (DerivedUnit)element;
 174             if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
 175                 java.util.Collection<FieldUnit> fieldUnits = CdmStore.getService(IOccurrenceService.class).getFieldUnits(derivedUnit.getUuid());
 176                 if(fieldUnits!=null && !fieldUnits.isEmpty()){
 177                     FieldUnit fieldUnit = fieldUnits.iterator().next();
 178                     GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
 179 //                    gatheringEvent = HibernateProxyHelper.deproxy(gatheringEvent, GatheringEvent.class);
 180                     if(gatheringEvent!=null){
 181                         label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+", ":"";
 182                     }
 183                     label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber()+", ":"";
 184                 }
 185                 eu.etaxonomy.cdm.model.occurrence.Collection collection = derivedUnit.getCollection();
 186                 if(collection!=null){
 187                     label += collection.getName()!=null?collection.getName()+" ":"";
 188                     label += collection.getCode()!=null?"("+collection.getCode()+"), ":"";
 189                 }
 190                 label += derivedUnit.getAccessionNumber()!=null?derivedUnit.getAccessionNumber()+", ":"";
 191                 label += derivedUnit.getBarcode()!=null?derivedUnit.getBarcode():"";
 192             }
 193             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
 194                 //TODO: implement
 195                 label += "kindofTissue? + [no sample designation]";
 196             }
 197         }
 198         else if(element instanceof Sequence){
 199             Sequence sequence = (Sequence)element;
 200             label += "[no sample designation]"+", ";
 201             label += sequence.getDnaMarker()!=null?sequence.getDnaMarker():"";
 202         }
 203         else if(element instanceof SingleRead){
 204             SingleRead singleRead = (SingleRead)element;
 205             label += "[no sample designation]"+", ";
 206             label += singleRead.getPrimer()!=null?singleRead.getPrimer().getLabel()+", ":"";
 207             if(parentNode!=null && parentNode.getValue() instanceof Sequence){
 208                 Sequence sequence = (Sequence) parentNode.getValue();
 209                 label += sequence.getDnaMarker()!=null?sequence.getDnaMarker():"";
 210             }
 211         }
 212         else if(element instanceof SpecimenOrObservationBase){
 213             SpecimenOrObservationBase<?> derivate = (SpecimenOrObservationBase<?>) element;
 214             SpecimenOrObservationType type = derivate.getRecordBasis();
 215             return derivate.getTitleCache() + (type!=null?" ["+type.toString()+"]":"");
 216         }
 217         if(label.isEmpty()){
 218             label = element.toString();
 219         }
 220         //remove last comma
 221         else if(label.endsWith(", ")){
 222             label = label.substring(0, label.length()-2);
 223         }
 224         return label;
 225     }
 226
 227     /* (non-Javadoc)
 228      * @see org.eclipse.jface.viewers.ColumnLabelProvider#getImage(java.lang.Object)
 229      */
 230     @Override
 231     public Image getImage(Object element) {
 232         if(element instanceof TreeNode){
 233             element = ((TreeNode) element).getValue();
 234         }
 235         if(element instanceof FieldUnit){
 236             return ImageResources.getImage(ImageResources.FIELD_UNIT);
 237         }
 238         else if(element instanceof DerivedUnit){
 239             DerivedUnit derivedUnit = (DerivedUnit)element;
 240             if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.FieldUnit){
 241                 return ImageResources.getImage(ImageResources.FIELD_UNIT);
 242             }
 243             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.DnaSample){
 244                 return ImageResources.getImage(ImageResources.DNA_SAMPLE_DERIVATE);
 245             }
 246             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
 247                 return ImageResources.getImage(ImageResources.TISSUE_SAMPLE_DERIVATE);
 248             }
 249             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
 250                 return ImageResources.getImage(ImageResources.SPECIMEN_DERIVATE);
 251             }
 252             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.Media){
 253                 if(derivedUnit.getKindOfUnit()!=null){
 254                     if(derivedUnit.getKindOfUnit().equals(getArtworkTerm())){
 255                         return ImageResources.getImage(ImageResources.ARTWORK_DERIVATE);
 256                     }
 257                     else if(derivedUnit.getKindOfUnit().equals(getLivingPlantPhotoTerm())){
 258                         return ImageResources.getImage(ImageResources.LIVING_PLANT_PHOTO_DERIVATE);
 259                     }
 260                     else if(derivedUnit.getKindOfUnit().equals(getSpecimenScanTerm())){
 261                         return ImageResources.getImage(ImageResources.SPECIMEN_SCAN_DERIVATE);
 262                     }
 263                     else if(derivedUnit.getKindOfUnit().equals(getDetailImageTerm())){
 264                         return ImageResources.getImage(ImageResources.DETAIL_IMAGE_DERIVATE);
 265                     }
 266                 }
 267             }
 268         }
 269         else if(element instanceof Sequence){
 270             return ImageResources.getImage(ImageResources.SEQUENCE_DERIVATE);
 271         }
 272
 273         else if(element instanceof SingleRead){
 274             if(multiLinkSingleReads.contains(element)){
 275                 return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE_MULTILINK);
 276             }
 277             else{
 278                 return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE);
 279             }
 280         }
 281         return super.getImage(element);
 282     }
 283
 284     /**
 285      * @param multiLinkSingleReads2
 286      */
 287     public void setMultiLinkSingleReads(Set<SingleRead> multiLinkSingleReads) {
 288         this.multiLinkSingleReads = multiLinkSingleReads;
 289     }
 290
 291 }