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}.
  43  */
  44 public class DerivateLabelProvider extends ColumnLabelProvider {
  45
  46     private Set<SingleRead> multiLinkSingleReads;
  47
  48     private static DefinedTerm photoTerm = null;
  49     private static DefinedTerm drawingTerm = null;
  50     private static DefinedTerm specimenScanTerm = null;
  51     private static DefinedTerm detailImageTerm = null;
  52
  53     private static void initializeTerms() {
  54         List<DefinedTerm> preferredTerms = CdmStore.getTermManager().getPreferredTerms(DefinedTerm.class);
  55         for (DefinedTerm definedTerm : preferredTerms) {
  56             if(definedTerm.getUuid().equals(UUID.fromString("c5c59c42-f254-471e-96c6-09f459f7c903"))){
  57                 photoTerm = definedTerm;
  58             }
  59             else if(definedTerm.getUuid().equals(UUID.fromString("669b0409-4aa4-4695-aae4-a95ed27bad4c"))){
  60                 drawingTerm = definedTerm;
  61             }
  62             else if(definedTerm.getUuid().equals(UUID.fromString("acda15be-c0e2-4ea8-8783-b9b0c4ad7f03"))){
  63                 specimenScanTerm = definedTerm;
  64             }
  65             else if(definedTerm.getUuid().equals(UUID.fromString("31eb8d02-bf5d-437c-bcc6-87a626445f34"))){
  66                 detailImageTerm = definedTerm;
  67             }
  68         }
  69     }
  70
  71     public static DefinedTerm getLivingPlantPhotoTerm(){
  72         if(photoTerm==null){
  73             initializeTerms();
  74         }
  75         return photoTerm;
  76     }
  77
  78     public static DefinedTerm getArtworkTerm(){
  79         if(drawingTerm==null){
  80             initializeTerms();
  81         }
  82         return drawingTerm;
  83     }
  84
  85     public static DefinedTerm getSpecimenScanTerm(){
  86         if(specimenScanTerm==null){
  87             initializeTerms();
  88         }
  89         return specimenScanTerm;
  90     }
  91
  92     public static DefinedTerm getDetailImageTerm(){
  93         if(detailImageTerm==null){
  94             initializeTerms();
  95         }
  96         return detailImageTerm;
  97     }
  98
  99
 100     /** {@inheritDoc} */
 101     @Override
 102     public String getText(Object element) {
 103         return getDerivateText(element);
 104     }
 105
 106     /** {@inheritDoc} */
 107     @Override
 108     public String getToolTipText(Object element) {
 109         return getDerivateText(element);
 110     }
 111
 112     /**
 113      *
 114      * @param element
 115      * @return
 116      */
 117     public static String getDerivateText(Object element){
 118         TreeNode parentNode = null;
 119         if(element instanceof TreeNode){
 120             parentNode = ((TreeNode) element).getParent();
 121             //unwrap specimen from TreeNode
 122             element = ((TreeNode) element).getValue();
 123         }
 124
 125         String label = "";
 126         if(element instanceof FieldUnit){
 127             FieldUnit fieldUnit = (FieldUnit)element;
 128             GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
 129             if(gatheringEvent!=null){
 130                 label += gatheringEvent.getCountry()!=null?gatheringEvent.getCountry().getLabel()+", ":"";
 131                 label += gatheringEvent.getLocality()!=null?gatheringEvent.getLocality().getText()+", ":"";
 132                 label += gatheringEvent.getGatheringDate()!=null?gatheringEvent.getGatheringDate()+", ":"";
 133                 label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+", ":"";
 134             }
 135             label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber():"";
 136         }
 137         else if(element instanceof MediaSpecimen){
 138             MediaSpecimen mediaSpecimen = (MediaSpecimen)element;
 139             label += mediaSpecimen.getMediaSpecimen().getTitle()!=null?mediaSpecimen.getMediaSpecimen().getTitle().getText()+", ":"[no motif]";
 140             label += mediaSpecimen.getMediaSpecimen().getArtist()!=null?mediaSpecimen.getMediaSpecimen().getArtist()+", ":"";
 141             label += mediaSpecimen.getAccessionNumber()!=null?mediaSpecimen.getAccessionNumber()+", ":"";
 142             eu.etaxonomy.cdm.model.occurrence.Collection collection = mediaSpecimen.getCollection();
 143             if(collection!=null){
 144                 label += collection.getName()!=null?collection.getName()+" ":"";
 145             }
 146         }
 147         else if(element instanceof DnaSample
 148                 || (element instanceof DerivedUnit
 149                         && ((SpecimenOrObservationBase<?>) element).getRecordBasis()==SpecimenOrObservationType.DnaSample)){
 150             label += "SampleDesignation?";
 151
 152         }
 153         else if(element instanceof DerivedUnit){
 154             DerivedUnit derivedUnit = (DerivedUnit)element;
 155             if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
 156                 java.util.Collection<FieldUnit> fieldUnits = CdmStore.getService(IOccurrenceService.class).getFieldUnits(derivedUnit.getUuid());
 157                 if(fieldUnits!=null && !fieldUnits.isEmpty()){
 158                     FieldUnit fieldUnit = fieldUnits.iterator().next();
 159                     GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
 160 //                    gatheringEvent = HibernateProxyHelper.deproxy(gatheringEvent, GatheringEvent.class);
 161                     if(gatheringEvent!=null){
 162                         label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+", ":"";
 163                     }
 164                     label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber()+", ":"";
 165                 }
 166                 eu.etaxonomy.cdm.model.occurrence.Collection collection = derivedUnit.getCollection();
 167                 if(collection!=null){
 168                     label += collection.getName()!=null?collection.getName()+" ":"";
 169                     label += collection.getCode()!=null?"("+collection.getCode()+"), ":"";
 170                 }
 171                 label += derivedUnit.getAccessionNumber()!=null?derivedUnit.getAccessionNumber()+", ":"";
 172                 label += derivedUnit.getBarcode()!=null?derivedUnit.getBarcode():"";
 173             }
 174             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
 175                 //TODO: implement
 176                 label += "kindofTissue? + SampleDesignation?";
 177             }
 178         }
 179         else if(element instanceof Sequence){
 180             Sequence sequence = (Sequence)element;
 181             label += "SampleDesignation?"+", ";
 182             label += sequence.getDnaMarker()!=null?sequence.getDnaMarker():"";
 183         }
 184         else if(element instanceof SingleRead){
 185             SingleRead singleRead = (SingleRead)element;
 186             label += "SampleDesignation?"+", ";
 187             label += singleRead.getPrimer()!=null?singleRead.getPrimer().getLabel()+", ":"";
 188             if(parentNode!=null && parentNode.getValue() instanceof Sequence){
 189                 Sequence sequence = (Sequence) parentNode.getValue();
 190                 label += sequence.getDnaMarker()!=null?sequence.getDnaMarker():"";
 191             }
 192         }
 193         else if(element instanceof SpecimenOrObservationBase){
 194             SpecimenOrObservationBase<?> derivate = (SpecimenOrObservationBase<?>) element;
 195             SpecimenOrObservationType type = derivate.getRecordBasis();
 196             return derivate.getTitleCache() + (type!=null?" ["+type.toString()+"]":"");
 197         }
 198         if(label.isEmpty()){
 199             label = element.toString();
 200         }
 201         //remove last comma
 202         else if(label.endsWith(", ")){
 203             label = label.substring(0, label.length()-2);
 204         }
 205         return label;
 206     }
 207
 208     /* (non-Javadoc)
 209      * @see org.eclipse.jface.viewers.ColumnLabelProvider#getImage(java.lang.Object)
 210      */
 211     @Override
 212     public Image getImage(Object element) {
 213         if(element instanceof TreeNode){
 214             element = ((TreeNode) element).getValue();
 215         }
 216         if(element instanceof FieldUnit){
 217             return ImageResources.getImage(ImageResources.FIELD_UNIT);
 218         }
 219         else if(element instanceof DerivedUnit){
 220             DerivedUnit derivedUnit = (DerivedUnit)element;
 221             if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.FieldUnit){
 222                 return ImageResources.getImage(ImageResources.FIELD_UNIT);
 223             }
 224             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.DnaSample){
 225                 return ImageResources.getImage(ImageResources.DNA_SAMPLE_DERIVATE);
 226             }
 227             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
 228                 return ImageResources.getImage(ImageResources.TISSUE_SAMPLE_DERIVATE);
 229             }
 230             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
 231                 return ImageResources.getImage(ImageResources.SPECIMEN_DERIVATE);
 232             }
 233             else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.Media){
 234                 if(derivedUnit.getKindOfUnit()!=null){
 235                     if(derivedUnit.getKindOfUnit().equals(getArtworkTerm())){
 236                         return ImageResources.getImage(ImageResources.ARTWORK_DERIVATE);
 237                     }
 238                     else if(derivedUnit.getKindOfUnit().equals(getLivingPlantPhotoTerm())){
 239                         return ImageResources.getImage(ImageResources.LIVING_PLANT_PHOTO_DERIVATE);
 240                     }
 241                     else if(derivedUnit.getKindOfUnit().equals(getSpecimenScanTerm())){
 242                         return ImageResources.getImage(ImageResources.SPECIMEN_SCAN_DERIVATE);
 243                     }
 244                     else if(derivedUnit.getKindOfUnit().equals(getDetailImageTerm())){
 245                         return ImageResources.getImage(ImageResources.DETAIL_IMAGE_DERIVATE);
 246                     }
 247                 }
 248             }
 249         }
 250         else if(element instanceof Sequence){
 251             return ImageResources.getImage(ImageResources.SEQUENCE_DERIVATE);
 252         }
 253
 254         else if(element instanceof SingleRead){
 255             if(multiLinkSingleReads.contains(element)){
 256                 return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE_MULTILINK);
 257             }
 258             else{
 259                 return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE);
 260             }
 261         }
 262         return super.getImage(element);
 263     }
 264
 265     /**
 266      * @param multiLinkSingleReads2
 267      */
 268     public void setMultiLinkSingleReads(Set<SingleRead> multiLinkSingleReads) {
 269         this.multiLinkSingleReads = multiLinkSingleReads;
 270     }
 271
 272 }