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