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