source: trunk/grails-app/services/dbnp/studycapturing/AssayService.groovy @ 2120

Last change on this file since 2120 was 2120, checked in by s.h.sikkema@…, 11 years ago

# GDT

  • fixed issue where dynamically populated template select boxes would open pop-up on wrong option
  • gdt version 0.1.9

# GDT Importer

  • fixed bug in gdtImporter where importer would hang when first choosing sample as data type and then changing to some other data type to import
  • when there are errors in the import, table editor is now always enabled (can be really slow still!)
  • changed text message under data preview
  • fixed bug where going from page 2 to 1 would show all rows instead of just 5
  • replaced "Please make any adjustments if required" with "The following data will be imported" when user can't change anything
  • removed space between import preview and next button
  • gdtImporter version 0.4.6.7

# GSCF

  • now includes sampletokens when retrieving assay data from modules to ensure match between data and samples (was mixed up!)
  • Property svn:keywords set to Rev Author Date
File size: 25.7 KB
Line 
1/**
2 * AssayService Service
3 *
4 * @author  s.h.sikkema@gmail.com
5 * @since       20101216
6 * @package     dbnp.studycapturing
7 *
8 * Revision information:
9 * $Rev: 2120 $
10 * $Author: s.h.sikkema@gmail.com $
11 * $Date: 2011-11-25 14:36:45 +0000 (vr, 25 nov 2011) $
12 */
13package dbnp.studycapturing
14
15import org.apache.poi.ss.usermodel.*
16import org.apache.poi.xssf.usermodel.XSSFWorkbook
17import org.apache.poi.hssf.usermodel.HSSFWorkbook
18import org.codehaus.groovy.grails.web.json.JSONObject
19import org.dbnp.gdt.RelTime
20import org.dbnp.gdt.TemplateFieldType
21import java.text.NumberFormat
22import dbnp.authentication.SecUser
23
24class AssayService {
25
26        boolean transactional = false
27        def authenticationService
28        def moduleCommunicationService
29
30        /**
31         * Collects the assay field names per category in a map as well as the
32         * module's measurements.
33         *
34         * @param assay         the assay for which to collect the fields
35         * @param samples       list of samples to retrieve the field names for. If not given, all samples from the assay are used.
36         * @return a map of categories as keys and field names or measurements as
37         *  values
38         */
39        def collectAssayTemplateFields(assay, samples, SecUser remoteUser = null) throws Exception {
40
41                def getUsedTemplateFields = { templateEntities ->
42
43                        // gather all unique and non null template fields that haves values
44                        templateEntities*.giveFields().flatten().unique().findAll{ field ->
45
46                                field && templateEntities.any { it?.fieldExists(field.name) && it.getFieldValue(field.name) != null }
47
48                        }.collect{[name: it.name, comment: it.comment, displayName: it.name + (it.unit ? " ($it.unit)" : '')]}
49                }
50
51                def moduleError = '', moduleMeasurements = []
52
53                try {
54                        moduleMeasurements = requestModuleMeasurementNames(assay, remoteUser)
55                } catch (e) {
56                        moduleError = e.message
57                }
58
59                if( !samples )
60                        samples = assay.samples
61
62                [               'Subject Data' :            getUsedTemplateFields( samples*."parentSubject".unique() ),
63                                        'Sampling Event Data' :     getUsedTemplateFields( samples*."parentEvent".unique() ),
64                                        'Sample Data' :             getUsedTemplateFields( samples ),
65                                        'Event Group' :             [[name: 'name', comment: 'Name of Event Group', displayName: 'name']],
66                                        'Module Measurement Data':  moduleMeasurements,
67                                        'Module Error':             moduleError
68                                ]
69
70        }
71
72        /**
73         * Gathers all assay related data, including measurements from the module,
74         * into 1 hash map containing: Subject Data, Sampling Event Data, Sample
75         * Data, and module specific measurement data.
76         * Data from each of the 4 hash map entries are themselves hash maps
77         * representing a descriptive header (field name) as key and the data as
78         * value.
79         *
80         * @param assay                                 the assay to collect data for
81         * @param fieldMap                              map with categories as keys and fields as values
82         * @param measurementTokens     selection of measurementTokens
83         * @param samples                               list of samples for which the data should be retrieved.
84         *                                                              Defaults to all samples from this assay. Supply [] or
85         *                                                              null to include all samples.
86         * @return                              The assay data structure as described above.
87         */
88        def collectAssayData(assay, fieldMap, measurementTokens, samples, SecUser remoteUser = null) throws Exception {
89
90                def collectFieldValuesForTemplateEntities = { headerFields, templateEntities ->
91
92                        // return a hash map with for each field name all values from the
93                        // template entity list
94                        headerFields.inject([:]) { map, headerField ->
95
96                                map + [(headerField.displayName): templateEntities.collect { entity ->
97
98                                                // default to an empty string
99                                                def val = ''
100
101                                                if (entity) {
102                                                        def field
103                                                        try {
104
105                                                                val = entity.getFieldValue(headerField.name)
106
107                                                                // Convert RelTime fields to human readable strings
108                                                                field = entity.getField(headerField.name)
109                                                                if (field.type == TemplateFieldType.RELTIME)
110                                                                        val = new RelTime( val as long )
111
112                                                        } catch (NoSuchFieldException e) { /* pass */ }
113                                                }
114
115                                                (val instanceof Number) ? val : val.toString()}]
116                        }
117                }
118
119                def getFieldValues = { templateEntities, headerFields, propertyName = '' ->
120
121                        def returnValue
122
123                        // if no property name is given, simply collect the fields and
124                        // values of the template entities themselves
125                        if (propertyName == '') {
126
127                                returnValue = collectFieldValuesForTemplateEntities(headerFields, templateEntities)
128
129                        } else {
130
131                                // if a property name is given, we'll have to do a bit more work
132                                // to ensure efficiency. The reason for this is that for a list
133                                // of template entities, the properties referred to by
134                                // propertyName can include duplicates. For example, for 10
135                                // samples, there may be less than 10 parent subjects. Maybe
136                                // there's only 1 parent subject. We don't want to collect field
137                                // values for this single subject 10 times ...
138                                def fieldValues
139
140                                // we'll get the unique list of properties to make sure we're
141                                // not getting the field values for identical template entity
142                                // properties more then once.
143                                def uniqueProperties = templateEntities*."$propertyName".unique()
144
145                                fieldValues = collectFieldValuesForTemplateEntities(headerFields, uniqueProperties)
146
147                                // prepare a lookup hashMap to be able to map an entities'
148                                // property (e.g. a sample's parent subject) to an index value
149                                // from the field values list
150                                int i = 0
151                                def propertyToFieldValueIndexMap = uniqueProperties.inject([:]) { map, item -> map + [(item):i++]}
152
153                                // prepare the return value so that it has an entry for field
154                                // name. This will be the column name (second header line).
155                                returnValue = headerFields*.displayName.inject([:]) { map, item -> map + [(item):[]] }
156
157                                // finally, fill map the unique field values to the (possibly
158                                // not unique) template entity properties. In our example with
159                                // 1 unique parent subject, this means copying that subject's
160                                // field values to all 10 samples.
161                                templateEntities.each{ te ->
162
163                                        headerFields*.displayName.each{
164
165                                                returnValue[it] << fieldValues[it][propertyToFieldValueIndexMap[te[propertyName]]]
166                                        }
167                                }
168                        }
169                        returnValue
170                }
171
172                // Find samples and sort by name
173                if ( !samples ) samples = assay.samples.toList()
174                samples = samples.sort { it.name }
175
176                def eventFieldMap = [:]
177
178                // check whether event group data was requested
179                if (fieldMap['Event Group']) {
180
181                        def names = samples*.parentEventGroup*.name.flatten()
182
183                        // only set name field when there's actual data
184                        if (!names.every {!it}) eventFieldMap['name'] = names
185
186                }
187
188                def moduleError = '', moduleMeasurementData = [:]
189
190                if (measurementTokens) {
191
192                        try {
193                                moduleMeasurementData = requestModuleMeasurements(assay, measurementTokens, samples, remoteUser)
194                        } catch (e) {
195                                moduleMeasurementData = ['error' : ['Module error, module not available or unknown assay'] * samples.size() ]
196                                e.printStackTrace()
197                                moduleError =  e.message
198                        }
199
200                }
201
202                [   'Subject Data' :            getFieldValues(samples, fieldMap['Subject Data'], 'parentSubject'),
203                        'Sampling Event Data' :     getFieldValues(samples, fieldMap['Sampling Event Data'], 'parentEvent'),
204                        'Sample Data' :             getFieldValues(samples, fieldMap['Sample Data']),
205                        'Event Group' :             eventFieldMap,
206                        'Module Measurement Data' : moduleMeasurementData,
207                        'Module Error' :            moduleError
208                ]
209        }
210
211        /**
212         * Prepend data from study to the data structure
213         * @param assayData             Column wise data structure of samples
214         * @param assay                 Assay object the data should be selected from
215         * @param numValues             Number of values for this assay
216         * @return                              Extended column wise data structure
217         */
218        def prependStudyData( inputData, Assay assay, numValues ) {
219                if( !assay )
220                        return inputData;
221
222                // Retrieve study data
223                def studyData =[:]
224                assay.parent?.giveFields().each {
225                        def value = assay.parent.getFieldValue( it.name )
226                        if( value )
227                                studyData[ it.name ] = [value] * numValues
228                }
229
230                return [
231                        'Study Data': studyData
232                ] + inputData
233        }
234
235        /**
236         * Prepend data from assay to the data structure
237         * @param assayData             Column wise data structure of samples
238         * @param assay                 Assay object the data should be selected from
239         * @param numValues             Number of values for this assay
240         * @return                              Extended column wise data structure
241         */
242        def prependAssayData( inputData, Assay assay, numValues ) {
243                if( !assay )
244                        return inputData;
245
246                // Retrieve assay data
247                def assayData = [:]
248                assay.giveFields().each {
249                        def value = assay.getFieldValue( it.name )
250                        if( value )
251                                assayData[ it.name ] = [value] * numValues
252                }
253
254                return [
255                        'Assay Data': assayData
256                ] + inputData
257        }
258
259        /**
260         * Retrieves measurement names from the module through a rest call
261         *
262         * @param consumer the url of the module
263         * @param path path of the rest call to the module
264         * @return
265         */
266        def requestModuleMeasurementNames(assay, SecUser remoteUser = null) {
267
268                def moduleUrl = assay.module.url
269
270                def path = moduleUrl + "/rest/getMeasurements/query"
271                def query = "assayToken=${assay.giveUUID()}"
272                def jsonArray
273
274                try {
275                        jsonArray = moduleCommunicationService.callModuleMethod(moduleUrl, path, query, "POST", remoteUser)
276                } catch (e) {
277                        throw new Exception("An error occured while trying to get the measurement tokens from the $assay.module.name. \
278             This means the module containing the measurement data is not available right now. Please try again \
279             later or notify the system administrator if the problem persists. URL: $path?$query.")
280                }
281
282                def result = jsonArray.collect {
283                        if( it == JSONObject.NULL )
284                                return ""
285                        else
286                                return it.toString()
287                }
288
289                return result
290        }
291
292        /**
293         * Retrieves module measurement data through a rest call to the module
294         *
295         * @param assay                         Assay for which the module measurements should be retrieved
296         * @param measurementTokens     List with the names of the fields to be retrieved. Format: [ 'measurementName1', 'measurementName2' ]
297         * @param samples                       Samples to collect measurements for
298         * @return
299         */
300        def requestModuleMeasurements(assay, inputMeasurementTokens, samples, SecUser remoteUser = null) {
301
302                def moduleUrl = assay.module.url
303
304                def tokenString = ''
305
306                inputMeasurementTokens.each{
307                        tokenString+="&measurementToken=${it.encodeAsURL()}"
308                }
309
310                def path = moduleUrl + "/rest/getMeasurementData/query"
311
312                def query = "assayToken=$assay.assayUUID$tokenString"
313
314                if (samples) {
315                         query += '&' + samples*.sampleUUID.collect { "sampleToken=$it" }.join('&')
316                }
317
318                def sampleTokens = [], measurementTokens = [], moduleData = []
319
320                try {
321                        (sampleTokens, measurementTokens, moduleData) = moduleCommunicationService.callModuleMethod(moduleUrl, path, query, "POST", remoteUser)
322                } catch (e) {
323                        e.printStackTrace()
324                        throw new Exception("An error occured while trying to get the measurement data from the $assay.module.name. \
325             This means the module containing the measurement data is not available right now. Please try again \
326             later or notify the system administrator if the problem persists. URL: $path?$query.")
327                }
328
329                if (!sampleTokens?.size()) return []
330
331                // Convert the three different maps into a map like:
332                //
333                // [ "measurement 1": [ value1, value2, value3 ],
334                //   "measurement 2": [ value4, value5, value6 ] ]
335                //
336                // The returned values should be in the same order as the given samples-list
337                def map = [:]
338                def numSampleTokens = sampleTokens.size();
339
340                measurementTokens.eachWithIndex { measurementToken, measurementIndex ->
341                        def measurements = [];
342                        samples.each { sample ->
343
344                                // Do measurements for this sample exist? If not, a null value is returned
345                                // for this sample. Otherwise, the measurement is looked up in the list with
346                                // measurements, based on the sample token
347                                if( sampleTokens.collect{ it.toString() }.contains( sample.giveUUID() ) ) {
348                                        def tokenIndex = sampleTokens.indexOf( sample.giveUUID() );
349                                        def valueIndex = measurementIndex * numSampleTokens + tokenIndex;
350
351                                        // If the module data is in the wrong format, show an error in the log file
352                                        // and return a null value for this measurement.
353                                        if( valueIndex >= moduleData.size() ) {
354                                                log.error "Module measurements given by module " + assay.module.name + " are not in the right format: " + measurementTokens?.size() + " measurements, " + sampleTokens?.size() + " samples, " + moduleData?.size() + " values"
355                                                measurements << null
356                                        }  else {
357
358                                                def val
359                                                def measurement = moduleData[ valueIndex ]
360
361                                                if          (measurement == JSONObject.NULL)    val = ""
362                                                else if     (measurement instanceof Number)     val = measurement
363                                                else if     (measurement.isDouble())            val = measurement.toDouble()
364                                                else val =   measurement.toString()
365                                                measurements << val
366                                        }
367                                } else {
368                                        measurements << null
369                                }
370                        }
371                        map[ measurementToken.toString() ] = measurements
372                }
373
374                return map;
375        }
376
377        /**
378         * Merges the data from multiple studies into a structure that can be exported to an excel file. The format for each assay is
379         *
380         *      [Category1:
381         *      [Column1: [1,2,3], Column2: [4,5,6]],
382         *   Category2:
383         *      [Column3: [7,8,9], Column4: [10,11,12], Column5: [13,14,15]]]
384         *
385         * Where the category describes the category of data that is presented (e.g. subject, sample etc.) and the column names describe
386         * the fields that are present. Each entry in the lists shows the value for that column for an entity. In this case, 3 entities are described.
387         * Each field should give values for all entities, so the length of all value-lists should be the same.
388         *
389         * Example: If the following input is given (2 assays)
390         *
391         *      [
392         *    [Category1:
393         *      [Column1: [1,2,3], Column2: [4,5,6]],
394         *     Category2:
395         *      [Column3: [7,8,9], Column4: [10,11,12], Column5: [13,14,15]]],
396         *    [Category1:
397         *      [Column1: [16,17], Column6: [18,19]],
398         *     Category3:
399         *      [Column3: [20,21], Column8: [22,23]]]
400         * ]
401         *
402         * the output will be (5 entries for each column, empty values for fields that don't exist in some assays)
403         *
404         *      [
405         *    [Category1:
406         *      [Column1: [1,2,3,16,17], Column2: [4,5,6,,], Column6: [,,,18,19]],
407         *     Category2:
408         *      [Column3: [7,8,9,,], Column4: [10,11,12,,], Column5: [13,14,15,,]],
409         *     Category3:
410         *      [Column3: [,,,20,21], Column8: [,,,22,23]]
411         * ]
412         *
413         *
414         * @param columnWiseAssayData   List with each entry being the column wise data of an assay. The format for each
415         *                                                              entry is described above
416         * @return      Hashmap                         Combined assay data, in the same structure as each input entry. Empty values are given as an empty string.
417         *                                                              So for input entries
418         */
419        def mergeColumnWiseDataOfMultipleStudies(def columnWiseAssayData) {
420                // Compute the number of values that is expected for each assay. This number is
421                // used later on to determine the number of empty fields to add if a field is not present in this
422                // assay
423                def numValues = columnWiseAssayData.collect { assay ->
424                        for( cat in assay ) {
425                                if( cat ) {
426                                        for( field in cat.value ) {
427                                                if( field?.value?.size() > 0 ) {
428                                                        return field.value.size();
429                                                }
430                                        }
431                                }
432                        }
433
434                        return 0;
435                }
436
437                // Merge categories from all assays. Create a list for all categories
438                def categories = columnWiseAssayData*.keySet().toList().flatten().unique();
439                def mergedColumnWiseData = [:]
440                categories.each { category ->
441                        // Only work with this category for all assays
442                        def categoryData = columnWiseAssayData*.getAt( category );
443
444                        // Find the different fields in all assays
445                        def categoryFields = categoryData.findAll{ it }*.keySet().toList().flatten().unique();
446
447                        // Find data for all assays for these fields. If the fields do not exist, return an empty string
448                        def categoryValues = [:]
449                        categoryFields.each { field ->
450                                categoryValues[ field ] = [];
451
452                                // Loop through all assays
453                                categoryData.eachWithIndex { assayValues, idx ->
454                                        if( assayValues && assayValues.containsKey( field ) ) {
455                                                // Append the values if they exist
456                                                categoryValues[ field ] += assayValues[ field ];
457                                        } else {
458                                                // Append empty string for each entity if the field doesn't exist
459                                                categoryValues[ field ] += [""] * numValues[ idx ]
460                                        }
461                                }
462                        }
463
464                        mergedColumnWiseData[ category ] = categoryValues
465                }
466
467                return mergedColumnWiseData;
468        }
469
470        /**
471         * Merges the data from multiple studies into a structure that can be exported to an excel file. The format for each assay is
472         *
473         *      [Category1:
474         *      [Column1: [1,2,3], Column2: [4,5,6]],
475         *   Category2:
476         *      [Column3: [7,8,9], Column4: [10,11,12], Column5: [13,14,15]]]
477         *
478         * Where the category describes the category of data that is presented (e.g. subject, sample etc.) and the column names describe
479         * the fields that are present. Each entry in the lists shows the value for that column for an entity. In this case, 3 entities are described.
480         * Each field should give values for all entities, so the length of all value-lists should be the same.
481         *
482         * Example: If the following input is given (2 assays)
483         *
484         *      [
485         *    [Category1:
486         *      [Column1: [1,2,3], Column2: [4,5,6]],
487         *     Category2:
488         *      [Column3: [7,8,9], Column4: [10,11,12], Column5: [13,14,15]]],
489         *    [Category1:
490         *      [Column1: [16,17], Column6: [18,19]],
491         *     Category3:
492         *      [Column3: [20,21], Column8: [22,23]]]
493         * ]
494         *
495         * the output will be (5 entries for each column, empty values for fields that don't exist in some assays)
496         *
497         *      [
498         *    [Category1:
499         *      [Column1: [1,2,3,16,17], Column2: [4,5,6,,], Column6: [,,,18,19]],
500         *     Category2:
501         *      [Column3: [7,8,9,,], Column4: [10,11,12,,], Column5: [13,14,15,,]],
502         *     Category3:
503         *      [Column3: [,,,20,21], Column8: [,,,22,23]]
504         * ]
505         *
506         *
507         * @param columnWiseAssayData   List with each entry being the column wise data of an assay. The format for each
508         *                                                              entry is described above. The data MUST have a category named 'Sample Data' and in that map a field
509         *                                                              named 'id'. This field is used for matching rows. However, the column is removed, unless
510         *                                                              removeIdColumn is set to false
511         * @param removeIdColumn                If set to true (default), the values for the sample id are removed from the output.
512         * @return      Hashmap                         Combined assay data, in the same structure as each input entry. Empty values are given as an empty string.
513         *                                                              So for input entries
514         */
515        def mergeColumnWiseDataOfMultipleStudiesForASetOfSamples(def columnWiseAssayData, boolean removeIdColumn = true ) {
516                // Merge all assays and studies into one list
517                def mergedData = mergeColumnWiseDataOfMultipleStudies( columnWiseAssayData )
518
519                // A map with keys being the sampleIds, and the values are the indices of that sample in the values list
520                def idMap = [:]
521               
522                // A map with the key being an index in the value list, and the value is the index the values should be copied to
523                def convertMap = [:]
524
525                for( int i = 0; i < mergedData[ "Sample Data" ][ "id" ].size(); i++ ) {
526                        def id = mergedData[ "Sample Data" ][ "id" ][ i ];
527
528                        if( idMap[ id ] == null ) {
529                                // This id occurs for the first time
530                                idMap[ id ] = i;
531                                convertMap[ i ] = i;
532                        } else {
533                                convertMap[ i ] = idMap[ id ];
534                        }
535                }
536               
537                /*
538                 * Example output:
539                 * idMap:      [ 12: 0, 24: 1, 26: 3 ]
540                 * convertMap: [ 0: 0, 1: 1, 2: 0, 3: 3, 4: 3 ]
541                 *   (meaning: rows 0, 1 and 3 should remain, row 2 should be merged with row 0 and row 4 should be merged with row 3)
542                 *   
543                 * The value in the convertMap is always lower than its key. So we sort the convertMap on the keys. That way, we can
544                 * loop through the values and remove the row that has been merged.
545                 */
546               
547                convertMap.sort { a, b -> b.key <=> a.key }.each { 
548                        def row = it.key;
549                        def mergeWith = it.value;
550                       
551                        if( row != mergeWith ) {
552                                // Combine the data on row [row] with the data on row [mergeWith]
553                               
554                                mergedData.each { 
555                                        def cat = it.key; def fields = it.value;
556                                        fields.each { fieldData ->
557                                                def fieldName = fieldData.key; 
558                                                def fieldValues = fieldData.value;
559                                               
560                                                // If one of the fields to merge is empty, use the other one
561                                                // Otherwise the values should be the same (e.g. study, subject, sample data)
562                                                fieldValues[ mergeWith ] = ( fieldValues[ mergeWith ] == null || fieldValues[ mergeWith ] == "" ) ? fieldValues[ row ] : fieldValues[ mergeWith ]
563                                               
564                                                // Remove the row from this list
565                                                fieldValues.remove( row );
566                                        }
567                                }
568                        }
569                }
570               
571                // Remove sample id if required
572                if( removeIdColumn )
573                        mergedData[ "Sample Data" ].remove( "id" );
574               
575                return mergedData
576        }
577
578        /**
579         * Converts column
580         * @param columnData multidimensional map containing column data.
581         * On the top level, the data must be grouped by category. Each key is the
582         * category title and the values are maps representing the columns. Each
583         * column also has a title (its key) and a list of values. Columns must be
584         * equally sized.
585         *
586         * For example, consider the following map:
587         * [Category1:
588         *      [Column1: [1,2,3], Column2: [4,5,6]],
589         *  Category2:
590         *      [Column3: [7,8,9], Column4: [10,11,12], Column5: [13,14,15]]]
591         *
592         * which will be written as:
593         *
594         * | Category1  |           | Category2 |           |           |
595         * | Column1    | Column2   | Column3   | Column4   | Column5   |
596         * | 1          | 4         | 7         | 10        | 13        |
597         * | 2          | 5         | 8         | 11        | 14        |
598         * | 3          | 6         | 9         | 12        | 15        |
599         *
600         * @return row wise data
601         */
602        def convertColumnToRowStructure(columnData) {
603
604                // check if all columns have the dimensionality 2
605                if (columnData.every { it.value.every { it.value instanceof ArrayList } }) {
606
607                        def headers = [[],[]]
608
609                        columnData.each { category ->
610
611                                if (category.value.size()) {
612
613                                        // put category keys into first row separated by null values
614                                        // wherever there are > 1 columns per category
615                                        headers[0] += [category.key] + [null] * (category.value.size() - 1)
616
617                                        // put non-category column headers into 2nd row
618                                        headers[1] += category.value.collect{it.key}
619
620                                }
621
622                        }
623
624                        def d = []
625
626                        // add all column wise data into 'd'
627                        columnData.each { it.value.each { d << it.value } }
628
629                        // transpose d into row wise data and combine with header rows
630                        headers + d.transpose()
631                } else []
632
633        }
634
635        /**
636         * Export column wise data in Excel format to a stream.
637         *
638         * @param columnData Multidimensional map containing column data
639         * @param outputStream Stream to write to
640         * @param useOfficeOpenXML Flag to specify xlsx (standard) or xls output
641         * @return
642         */
643        def exportColumnWiseDataToExcelFile(columnData, outputStream, useOfficeOpenXML = true) {
644
645                // transform data into row based structure for easy writing
646                def rows = convertColumnToRowStructure(columnData)
647
648                if (rows) {
649
650                        exportRowWiseDataToExcelFile(rows, outputStream, useOfficeOpenXML)
651
652                } else {
653
654                        throw new Exception('Wrong column data format.')
655
656                }
657
658        }
659
660        /**
661         * Export row wise data in Excel format to a stream
662         *
663         * @param rowData List of lists containing for each row all cell values
664         * @param outputStream Stream to write to
665         * @param useOfficeOpenXML Flag to specify xlsx (standard) or xls output
666         * @return
667         */
668        def exportRowWiseDataToExcelFile(rowData, outputStream, useOfficeOpenXML = true) {
669                Workbook wb = useOfficeOpenXML ? new XSSFWorkbook() : new HSSFWorkbook()
670                Sheet sheet = wb.createSheet()
671
672                exportRowWiseDataToExcelSheet( rowData, sheet );
673
674                wb.write(outputStream)
675                outputStream.close()
676        }
677
678        /**
679         * Export row wise data in CSV to a stream. All values are surrounded with
680         * double quotes (" ").
681         *
682         * @param rowData List of lists containing for each row all cell values
683         * @param outputStream Stream to write to
684         * @return
685         */
686        def exportRowWiseDataToCSVFile(rowData, outputStream, outputDelimiter = '\t', locale = java.util.Locale.US) {
687
688                def formatter = NumberFormat.getNumberInstance(locale)
689                formatter.setGroupingUsed false // we don't want grouping (thousands) separators
690                formatter.setMaximumFractionDigits(15)
691
692                outputStream << rowData.collect { row ->
693                        row.collect{
694
695                                // omit quotes in case of numeric values and format using chosen locale
696                                if (it instanceof Number) return formatter.format(it)
697
698                                def s = it?.toString() ?: ''
699
700                                def addQuotes = false
701
702                                // escape double quotes with double quotes if they exist and
703                                // enable surround with quotes
704                                if (s.contains('"')) {
705                                        addQuotes = true
706                                        s = s.replaceAll('"','""')
707                                } else {
708                                        // enable surround with quotes in case of comma's
709                                        if (s.contains(',') || s.contains('\n')) addQuotes = true
710                                }
711
712                                addQuotes ? "\"$s\"" : s
713
714                        }.join(outputDelimiter)
715                }.join('\n')
716
717                outputStream.close()
718        }
719
720        /**
721         * Export row wise data for multiple assays in Excel format (separate sheets) to a stream
722         *
723         * @param rowData       List of structures with rowwise data for each assay
724         * @param outputStream Stream to write to
725         * @param useOfficeOpenXML Flag to specify xlsx (standard) or xls output
726         * @return
727         */
728        def exportRowWiseDataForMultipleAssaysToExcelFile(assayData, outputStream, useOfficeOpenXML = true) {
729                Workbook wb = useOfficeOpenXML ? new XSSFWorkbook() : new HSSFWorkbook()
730
731                assayData.each { rowData ->
732                        Sheet sheet = wb.createSheet()
733
734                        exportRowWiseDataToExcelSheet( rowData, sheet );
735                }
736
737                wb.write(outputStream)
738                outputStream.close()
739        }
740
741        /**
742         * Export row wise data in Excel format to a given sheet in an excel workbook
743         *
744         * @param rowData       List of lists containing for each row all cell values
745         * @param sheet         Excel sheet to append the
746         * @return
747         */
748        def exportRowWiseDataToExcelSheet(rowData, Sheet sheet) {
749                // create all rows
750                rowData.size().times { sheet.createRow it }
751
752                sheet.eachWithIndex { Row row, ri ->
753                        if( rowData[ ri ] ) {
754                                // create appropriate number of cells for this row
755                                rowData[ri].size().times { row.createCell it }
756
757                                row.eachWithIndex { Cell cell, ci ->
758
759                                        // Numbers and values of type boolean, String, and Date can be
760                                        // written as is, other types need converting to String
761                                        def value = rowData[ri][ci]
762
763                                        value = (value instanceof Number | value?.class in [boolean.class, String.class, Date.class]) ? value : value?.toString()
764
765                                        // write the value (or an empty String if null) to the cell
766                                        cell.setCellValue(value ?: '')
767
768                                }
769                        }
770                }
771        }
772}
Note: See TracBrowser for help on using the repository browser.