Project

General

Profile

Download (18.8 KB) Statistics
| Branch: | Tag: | Revision:
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.hibernate.HibernateProxyHelper;
24
import eu.etaxonomy.cdm.model.common.CdmBase;
25
import eu.etaxonomy.cdm.model.common.DefinedTerm;
26
import eu.etaxonomy.cdm.model.common.Identifier;
27
import eu.etaxonomy.cdm.model.molecular.DnaSample;
28
import eu.etaxonomy.cdm.model.molecular.Sequence;
29
import eu.etaxonomy.cdm.model.molecular.SingleRead;
30
import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;
31
import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
32
import eu.etaxonomy.cdm.model.occurrence.GatheringEvent;
33
import eu.etaxonomy.cdm.model.occurrence.MediaSpecimen;
34
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
35
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
36
import eu.etaxonomy.taxeditor.model.ImageResources;
37
import eu.etaxonomy.taxeditor.store.CdmStore;
38

    
39
/**
40
 * Label provider for the views to show {@link SpecimenOrObservationBase}s.<br>
41
 * <br>
42
 * <b>Note:</b> If you use this label provider you need to assure that you
43
 * created a {@link ConversationHolder} resp. have an open session because
44
 * the labels are generated from various fields of the derivate hierarchy which
45
 * are lazy loaded and could therefore throw a {@link LazyInitializationException}.<br>
46
 * Use <b>{@link #setConversation(ConversationHolder)}</b> to assign the session to this provider.
47
 */
48
public class DerivateLabelProvider extends ColumnLabelProvider {
49

    
50
    private static final String NO_SAMPLE_DESIGNATION = "[no sample designation]";
51

    
52
    private Set<SingleRead> multiLinkSingleReads;
53

    
54
    private ConversationHolder conversation;
55

    
56
    private static DefinedTerm photoTerm = null;
57
    private static DefinedTerm drawingTerm = null;
58
    private static DefinedTerm specimenScanTerm = null;
59
    private static DefinedTerm detailImageTerm = null;
60
    private static DefinedTerm sampleDesignationTerm = null;
61

    
62
    //FIXME: move static term getters to new singleton utility class
63
    private static void initializeTerms() {
64
        List<DefinedTerm> preferredTerms = CdmStore.getTermManager().getPreferredTerms(DefinedTerm.class);
65
        for (DefinedTerm definedTerm : preferredTerms) {
66
            if(definedTerm.getUuid().equals(UUID.fromString("c5c59c42-f254-471e-96c6-09f459f7c903"))){
67
                photoTerm = definedTerm;
68
            }
69
            else if(definedTerm.getUuid().equals(UUID.fromString("669b0409-4aa4-4695-aae4-a95ed27bad4c"))){
70
                drawingTerm = definedTerm;
71
            }
72
            else if(definedTerm.getUuid().equals(UUID.fromString("acda15be-c0e2-4ea8-8783-b9b0c4ad7f03"))){
73
                specimenScanTerm = definedTerm;
74
            }
75
            else if(definedTerm.getUuid().equals(UUID.fromString("31eb8d02-bf5d-437c-bcc6-87a626445f34"))){
76
                detailImageTerm = definedTerm;
77
            }
78
            else if(definedTerm.getUuid().equals(UUID.fromString("fadeba12-1be3-4bc7-9ff5-361b088d86fc"))){
79
                sampleDesignationTerm = definedTerm;
80
            }
81
        }
82
    }
83

    
84
    public static DefinedTerm getLivingPlantPhotoTerm(){
85
        if(photoTerm==null){
86
            initializeTerms();
87
        }
88
        return photoTerm;
89
    }
90

    
91
    public static DefinedTerm getArtworkTerm(){
92
        if(drawingTerm==null){
93
            initializeTerms();
94
        }
95
        return drawingTerm;
96
    }
97

    
98
    public static DefinedTerm getSpecimenScanTerm(){
99
        if(specimenScanTerm==null){
100
            initializeTerms();
101
        }
102
        return specimenScanTerm;
103
    }
104

    
105
    public static DefinedTerm getDetailImageTerm(){
106
        if(detailImageTerm==null){
107
            initializeTerms();
108
        }
109
        return detailImageTerm;
110
    }
111

    
112
    public static DefinedTerm getSampleDesignationTerm(){
113
        if(sampleDesignationTerm==null){
114
            initializeTerms();
115
        }
116
        return sampleDesignationTerm;
117
    }
118

    
119

    
120
    /** {@inheritDoc} */
121
    @Override
122
    public String getText(Object element) {
123
        return getDerivateText(element);
124
    }
125

    
126
    /** {@inheritDoc} */
127
    @Override
128
    public String getToolTipText(Object element) {
129
        return getDerivateText(element);
130
    }
131

    
132
    /**
133
     * @param conversation the conversation to set
134
     */
135
    public void setConversation(ConversationHolder conversation) {
136
        this.conversation = conversation;
137
    }
138

    
139
    public String getDerivateText(Object element){
140
        return getDerivateText(element, conversation);
141
    }
142

    
143
    public static String getDerivateText(Object element, ConversationHolder conversation){
144
        //TODO: use list of strings to assemble labels to avoid adding the separator every time and to allow null values
145
        TreeNode parentNode = null;
146
        TreeNode node = null;
147
        Object derivate = element;
148
        if(element instanceof TreeNode){
149
            node = (TreeNode) element;
150
            parentNode = node.getParent();
151
            //unwrap specimen from TreeNode
152
            derivate = node.getValue();
153
        }
154

    
155
        conversation.bind();
156

    
157
        final String emptyString = "";
158
        final String separator = ", ";
159

    
160
        String label = emptyString;
161

    
162
        //Field Unit
163
        if(derivate instanceof FieldUnit){
164
            FieldUnit fieldUnit = (FieldUnit)derivate;
165
            if(fieldUnit.getGatheringEvent()!=null){
166
                GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
167
                if(CdmStore.getService(IOccurrenceService.class).exists(fieldUnit.getUuid()) && !conversation.getSession().contains(gatheringEvent)){
168
                    fieldUnit = (FieldUnit) CdmStore.getService(IOccurrenceService.class).load(fieldUnit.getUuid());
169
                    gatheringEvent = fieldUnit.getGatheringEvent();
170
                }
171
                label += gatheringEvent.getCountry()!=null?gatheringEvent.getCountry().getLabel()+separator:emptyString;
172
                label += gatheringEvent.getLocality()!=null?gatheringEvent.getLocality().getText()+separator:emptyString;
173
                label += gatheringEvent.getGatheringDate()!=null?gatheringEvent.getGatheringDate()+separator:emptyString;
174
                label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+separator:emptyString;
175
            }
176
            label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber():emptyString;
177
        }
178
        //MediaSpecimen
179
        else if(derivate instanceof MediaSpecimen){
180
            MediaSpecimen mediaSpecimen = (MediaSpecimen)derivate;
181
            if(mediaSpecimen.getMediaSpecimen()!=null){
182
                label += mediaSpecimen.getMediaSpecimen().getTitle()!=null?mediaSpecimen.getMediaSpecimen().getTitle().getText()+separator:"[no motif]";
183
                label += mediaSpecimen.getMediaSpecimen().getArtist()!=null?mediaSpecimen.getMediaSpecimen().getArtist()+separator:emptyString;
184
            }
185
            eu.etaxonomy.cdm.model.occurrence.Collection collection = mediaSpecimen.getCollection();
186
            if(collection!=null){
187
                label += collection.getName()!=null?collection.getName()+" ":emptyString;
188
                label += collection.getCode()!=null?"("+collection.getCode()+")"+separator:emptyString;
189
            }
190
            label += mediaSpecimen.getAccessionNumber()!=null?mediaSpecimen.getAccessionNumber()+separator:emptyString;
191
            label += mediaSpecimen.getBarcode()!=null?mediaSpecimen.getBarcode()+separator:emptyString;
192
        }
193
        //TissueSample + DnaSample
194
        else if(derivate instanceof DnaSample){
195
            DnaSample dnaSample = (DnaSample)derivate;
196
            if(((DnaSample) derivate).getRecordBasis()==SpecimenOrObservationType.DnaSample){
197
                Identifier<DnaSample> currentSampleDesignation = getCurrentSampleDesignation(dnaSample);
198
                if(currentSampleDesignation!=null && currentSampleDesignation.getIdentifier()!=null){
199
                    label += currentSampleDesignation.getIdentifier()+separator;
200
                }
201
                else{
202
                    label += NO_SAMPLE_DESIGNATION+separator;
203
                }
204
            }
205
            else if(((DnaSample) derivate).getRecordBasis()==SpecimenOrObservationType.TissueSample){
206
                if(dnaSample.getKindOfUnit()!=null){
207
                    label += dnaSample.getKindOfUnit()+separator;
208
                }
209
                Identifier<DnaSample> currentSampleDesignation = getCurrentSampleDesignation(dnaSample);
210
                if(currentSampleDesignation!=null && currentSampleDesignation.getIdentifier()!=null){
211
                    label += currentSampleDesignation.getIdentifier()+separator;
212
                }
213
                else{
214
                    label += NO_SAMPLE_DESIGNATION+separator;
215
                }
216
            }
217

    
218
        }
219
        //DerivedUnit + TissueSample
220
        else if(derivate instanceof DerivedUnit){
221
            DerivedUnit derivedUnit = (DerivedUnit)derivate;
222
            if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
223
                java.util.Collection<FieldUnit> fieldUnits = CdmStore.getService(IOccurrenceService.class).getFieldUnits(derivedUnit.getUuid());
224
                if(fieldUnits!=null && !fieldUnits.isEmpty()){
225
                    FieldUnit fieldUnit = fieldUnits.iterator().next();
226
                    GatheringEvent gatheringEvent = fieldUnit.getGatheringEvent();
227
//                  gatheringEvent = HibernateProxyHelper.deproxy(gatheringEvent, GatheringEvent.class);
228
                    if(gatheringEvent!=null){
229
                        label += gatheringEvent.getCollector()!=null?gatheringEvent.getCollector()+separator:emptyString;
230
                    }
231
                    label += fieldUnit.getFieldNumber()!=null?fieldUnit.getFieldNumber()+separator:emptyString;
232
                }
233
                eu.etaxonomy.cdm.model.occurrence.Collection collection = derivedUnit.getCollection();
234
                if(collection!=null){
235
                    label += collection.getName()!=null?collection.getName()+" ":emptyString;
236
                    label += collection.getCode()!=null?"("+collection.getCode()+"), ":emptyString;
237
                }
238
                String mostSignificantIdentifier = CdmStore.getService(IOccurrenceService.class).getMostSignificantIdentifier(derivedUnit);
239
                label += mostSignificantIdentifier!=null?mostSignificantIdentifier+separator:emptyString;
240
            }
241
            else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
242
                //TissueSample should only be created by using it's own class
243
                //in future using only one class with different SpecimenOrObservationTypes is desired
244
//                label += derivedUnit.getKindOfUnit() + NO_SAMPLE_DESIGNATION;
245
            }
246
        }
247
        //Sequence
248
        else if(derivate instanceof Sequence){
249
            Sequence sequence = (Sequence)derivate;
250
            Identifier<DnaSample> currentSampleDesignation = getCurrentSampleDesignation(sequence);
251
            if(currentSampleDesignation!=null && currentSampleDesignation.getIdentifier()!=null){
252
                label += currentSampleDesignation.getIdentifier()+separator;
253
            }
254
            else{
255
                label += NO_SAMPLE_DESIGNATION+separator;
256
            }
257
            label += sequence.getDnaMarker()!=null?sequence.getDnaMarker():emptyString;
258
        }
259
        //SingleRead
260
        else if(derivate instanceof SingleRead){
261
            SingleRead singleRead = (SingleRead)derivate;
262
            if(parentNode!=null && parentNode.getValue() instanceof Sequence){
263
                Sequence sequence = (Sequence) parentNode.getValue();
264
                Identifier<DnaSample> currentSampleDesignation = getCurrentSampleDesignation(sequence);
265
                if(currentSampleDesignation!=null && currentSampleDesignation.getIdentifier()!=null){
266
                    label = currentSampleDesignation.getIdentifier()+separator;
267
                }
268
                else{
269
                    label += NO_SAMPLE_DESIGNATION+separator;
270
                }
271
                label += singleRead.getPrimer()!=null?singleRead.getPrimer().getLabel()+separator:emptyString;
272
                if(sequence!=null && sequence.getDnaMarker()!=null){
273
                    label += sequence.getDnaMarker()+separator;
274
                }
275
                if(singleRead.getAmplificationResult()!=null && singleRead.getAmplificationResult().getAmplification()!=null){
276
                    label += singleRead.getAmplificationResult().getAmplification().getLabelCache()+separator;
277
                }
278
            }
279
        }
280
        //SOOB
281
        else if(derivate instanceof SpecimenOrObservationBase){
282
            SpecimenOrObservationBase<?> specimen = (SpecimenOrObservationBase<?>) derivate;
283
            SpecimenOrObservationType type = specimen.getRecordBasis();
284
            return specimen.getTitleCache() + (type!=null?" ["+type.toString()+"]":emptyString);
285
        }
286
        if(label.isEmpty()){
287
            label = derivate.toString();
288
        }
289
        //remove last comma
290
        else if(label.endsWith(separator)){
291
            label = label.substring(0, label.length()-separator.length());
292
        }
293
        return label;
294
    }
295

    
296
    /* (non-Javadoc)
297
     * @see org.eclipse.jface.viewers.ColumnLabelProvider#getImage(java.lang.Object)
298
     */
299
    @Override
300
    public Image getImage(Object element) {
301
        if(element instanceof TreeNode){
302
            element = ((TreeNode) element).getValue();
303
        }
304
        if(element instanceof CdmBase){
305
            CdmBase cdmBase = (CdmBase)element;
306
            boolean hasCharacterData = false;
307
            if(cdmBase.isInstanceOf(SpecimenOrObservationBase.class)){
308
                SpecimenOrObservationBase<?> specimen = HibernateProxyHelper.deproxy(cdmBase, SpecimenOrObservationBase.class);
309
                if(!CdmStore.getService(IOccurrenceService.class).getCharacterDataForSpecimen(specimen).isEmpty()){
310
                    hasCharacterData = true;
311
                }
312
            }
313
            if(cdmBase.isInstanceOf(FieldUnit.class)){
314
                return hasCharacterData?ImageResources.getImage(ImageResources.FIELD_UNIT_CHARACTER_DATA):ImageResources.getImage(ImageResources.FIELD_UNIT);
315
            }
316
            else if(cdmBase.isInstanceOf(DerivedUnit.class)){
317
                DerivedUnit derivedUnit = HibernateProxyHelper.deproxy(element, DerivedUnit.class);
318
                if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.FieldUnit){
319
                    return hasCharacterData?ImageResources.getImage(ImageResources.FIELD_UNIT_CHARACTER_DATA):ImageResources.getImage(ImageResources.FIELD_UNIT);
320
                }
321
                else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.DnaSample){
322
                    return hasCharacterData?ImageResources.getImage(ImageResources.DNA_SAMPLE_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.DNA_SAMPLE_DERIVATE);
323
                }
324
                else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.TissueSample){
325
                    return hasCharacterData?ImageResources.getImage(ImageResources.TISSUE_SAMPLE_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.TISSUE_SAMPLE_DERIVATE);
326
                }
327
                else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.PreservedSpecimen){
328
                    return hasCharacterData?ImageResources.getImage(ImageResources.SPECIMEN_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.SPECIMEN_DERIVATE);
329
                }
330
                else if(derivedUnit.getRecordBasis()==SpecimenOrObservationType.Media){
331
                    if(derivedUnit.getKindOfUnit()!=null){
332
                        if(derivedUnit.getKindOfUnit().equals(getArtworkTerm())){
333
                            return hasCharacterData?ImageResources.getImage(ImageResources.ARTWORK_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.ARTWORK_DERIVATE);
334
                        }
335
                        else if(derivedUnit.getKindOfUnit().equals(getLivingPlantPhotoTerm())){
336
                            return hasCharacterData?ImageResources.getImage(ImageResources.LIVING_PLANT_PHOTO_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.LIVING_PLANT_PHOTO_DERIVATE);
337
                        }
338
                        else if(derivedUnit.getKindOfUnit().equals(getSpecimenScanTerm())){
339
                            return hasCharacterData?ImageResources.getImage(ImageResources.SPECIMEN_SCAN_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.SPECIMEN_SCAN_DERIVATE);
340
                        }
341
                        else if(derivedUnit.getKindOfUnit().equals(getDetailImageTerm())){
342
                            return hasCharacterData?ImageResources.getImage(ImageResources.DETAIL_IMAGE_DERIVATE_CHARACTER_DATA):ImageResources.getImage(ImageResources.DETAIL_IMAGE_DERIVATE);
343
                        }
344
                    }
345
                }
346
            }
347
            else if(cdmBase.isInstanceOf(Sequence.class)){
348
                return ImageResources.getImage(ImageResources.SEQUENCE_DERIVATE);
349
            }
350

    
351
            else if(cdmBase.isInstanceOf(SingleRead.class)){
352
                if(multiLinkSingleReads.contains(element)){
353
                    return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE_MULTILINK);
354
                }
355
                else{
356
                    return ImageResources.getImage(ImageResources.SINGLE_READ_DERIVATE);
357
                }
358
            }
359
        }
360
        return super.getImage(element);
361
    }
362

    
363
    public static Identifier<DnaSample> getCurrentSampleDesignation(CdmBase entity) {
364
        if(entity.isInstanceOf(DnaSample.class)){
365
            DnaSample dnaSample = HibernateProxyHelper.deproxy(entity, DnaSample.class);
366
            for (Identifier<DnaSample> identifier : dnaSample.getIdentifiers()) {
367
                if(identifier.getType()!=null && identifier.getType().equals(DerivateLabelProvider.getSampleDesignationTerm())){
368
                    //first sample designation is the current
369
                    return identifier;
370
                }
371
            }
372
        }
373
        else if(entity.isInstanceOf(Sequence.class)){
374
            Sequence sequence = HibernateProxyHelper.deproxy(entity, Sequence.class);
375
            if(sequence.getDnaSample()!=null){
376
                return getCurrentSampleDesignation(sequence.getDnaSample());
377
            }
378
        }
379
        return null;
380
    }
381

    
382
    /**
383
     * @param multiLinkSingleReads2
384
     */
385
    public void setMultiLinkSingleReads(Set<SingleRead> multiLinkSingleReads) {
386
        this.multiLinkSingleReads = multiLinkSingleReads;
387
    }
388

    
389
}
(2-2/5)