root/trunk/grails-app/controllers/dbnp/exporter/ExporterController.groovy @ 1729

Revision 1729, 9.2 KB (checked in by robert@…, 3 years ago)

Fixed bug in simpletox exporter with exporting multiple studies.

  • Property svn:keywords set to Rev Author Date
Line 
1/**
2 * ExporterController Controller
3 *
4 * Description of my controller
5 *
6 * @author  your email (+name?)
7 * @since       2010mmdd
8 * @package     ???
9 *
10 * Revision information:
11 * $Rev$
12 * $Author$
13 * $Date$
14 */
15package dbnp.exporter
16
17import dbnp.studycapturing.*
18import org.dbnp.gdt.*
19
20import org.apache.poi.hssf.util.HSSFColor
21import org.apache.poi.*
22import org.apache.poi.hssf.usermodel.*
23import org.apache.poi.poifs.filesystem.POIFSFileSystem
24import org.apache.poi.ss.usermodel.DataFormatter
25import java.util.zip.ZipEntry
26import java.util.zip.ZipOutputStream
27import java.util.zip.ZipInputStream
28import javax.servlet.ServletOutputStream
29
30import grails.plugins.springsecurity.Secured
31
32class ExporterController {
33
34    def authenticationService
35
36    /*
37     * List of all studies for selection the study to export
38     * Using the same code as 'list' into StudyController
39     */
40    def index = {
41
42        def user = authenticationService.getLoggedInUser()
43        def max = Math.min(params.max ? params.int('max') : 10, 100)
44
45        def c = dbnp.studycapturing.Study.createCriteria()
46
47        def studies = Study.giveReadableStudies(user, max);
48        [studyInstanceList: studies, studyInstanceTotal: studies.count()]
49    }
50
51    def export = {
52                def ids = params.list( 'ids' );
53        def studies = []
54               
55                ids.each {
56                        if( it.toString().isLong() ) {
57                                def study = Study.get( Long.valueOf( it ) );
58                                if( study )
59                                        studies << study
60                        }
61                }
62       
63        if(studies.size()>1){
64
65                        // Send the right headers for the zip file to be downloaded
66                        response.setContentType( "application/zip" ) ;
67                        response.addHeader( "Content-Disposition", "attachment; filename=\"GSCF_SimpleToxStudies.zip\"" ) ;
68
69                        // Create a ZIP file containing all the SimpleTox files
70                        ZipOutputStream zipFile = new ZipOutputStream( new BufferedOutputStream( response.getOutputStream() ) );
71                        BufferedWriter zipWriter = new BufferedWriter( new OutputStreamWriter( zipFile ) );
72                       
73                        // Loop through the given studies and export them
74                        for (studyInstance in studies){
75                                if( studyInstance.samples?.size() ) {
76                                        try {
77                                                zipFile.putNextEntry( new ZipEntry( studyInstance.title + "_SimpleTox.xls" ));
78                                                downloadFile(studyInstance, zipFile);
79                                                zipWriter.flush();
80                                                zipFile.closeEntry();
81                                        } catch( Exception e ) {
82                                                log.error "Error while writing excelfile for zip for study " + studyInstance?.title + ": " + e.getMessage();
83                                        } finally {
84                                                // Always close zip entry
85                                                try {
86                                                        zipWriter.flush();
87                                                        zipFile.closeEntry();
88                                                } catch( Exception e ) {
89                                                        log.error "Error while closing excelfile for zip for study: " + e.getMessage();
90                                                }
91                                        }
92                                } else {
93                                        log.trace "Study " + studyInstance?.title + " doesn't contain any samples, so is not exported to simpleTox"
94                                       
95                                        // Add a text file with explanation in the zip file
96                                        zipFile.putNextEntry(new ZipEntry( studyInstance.title + "_contains_no_samples.txt" ) );
97                                        zipFile.closeEntry();
98                                }
99                        }
100                       
101                        // Close zipfile and flush to the user
102                        zipFile.close();
103                        response.outputStream.flush();
104                       
105        } else {
106            def studyInstance = studies.getAt(0)
107            // make the file downloadable
108            if ((studyInstance!=null) && (studyInstance.samples.size()>0)){
109                    response.setHeader("Content-disposition", "attachment;filename=\"${studyInstance.title}_SimpleTox.xls\"")
110                    response.setContentType("application/octet-stream")
111                downloadFile(studyInstance, response.getOutputStream())
112                                response.getOutputStream().close()
113            } else if( studyInstance.samples.size() == 0 ) {
114                                flash.message = "Given study doesn't contain any samples, so no excel file is created. Please choose another study.";
115                                redirect( action: 'index' );
116                        }
117            else {
118                flash.message= "Error while exporting the file, please try again or choose another study."
119                redirect( action: 'index' )
120            }
121
122        }
123
124    }
125    /*
126     * the export method will create a SimpleTox format for the selected study
127     * and write the file to the given output stream
128     */
129    def downloadFile(studyInstance, OutputStream outStream) {
130        // the attributes list for the SimpleTox format
131        def attributes_list = ["SubjectID","DataFile","HybName","SampleName","ArrayType","Label","StudyTitle","Array_ID",
132        "Species"]
133        println studyInstance.samples.size()
134        println "StudyInstance :" + studyInstance
135               
136        // The first row contains the attributes names
137        HSSFWorkbook wb = new HSSFWorkbook()
138        HSSFSheet sheet = wb.createSheet()
139        HSSFRow row     = sheet.createRow((short)0)
140        for (i in 0..attributes_list.size()){
141            row.createCell((short)i).setCellValue(attributes_list[i])
142        }
143
144        // Adding the next lines
145        for (s in 1..studyInstance.samples.size()){
146            // creating new line for every sample
147            HSSFRow sub     = sheet.createRow((short)s)
148            def sample = studyInstance.samples.getAt(s-1)
149           
150            writeMandatoryFields(sub,sample,studyInstance)
151
152            try {
153                // adding the subject domain + template properties
154                writeSubjectProperties(sub,sample,row)
155
156                // adding the samplingEvent domain + template properties
157                writeSamplingEventProperties(sub,sample,row)
158           
159                // adding EventGroup domain + template properties
160                //                writeEventGroupProperties(sub,sample,rows)
161
162                // adding Sample domain + template properties
163                writeSampleProperties(sub,sample,row)
164            }
165            catch (Exception e){
166                println "Error adding properties"
167            }
168        }
169
170                wb.write( outStream );
171    }
172
173    def writeMandatoryFields(sub,sample,study) {
174        // adding subject name in row 1
175        sample.parentSubject ? sub.createCell((short)0).setCellValue(sample.parentSubject.name) : "not defined"
176        // adding sample in row 4
177        sample.name!=null ? sub.createCell((short)3).setCellValue(sample.name) : "not defined"
178        // adding label (EventGroup) in row 6
179        for (ev in EventGroup.list()){
180            if(sample.parentSubject){
181                if ( (sample.parentSubject.name) && (ev.subjects.name.contains(sample.parentSubject.name))) {
182                    sub.createCell((short)5).setCellValue(ev.name)
183                    break
184                }
185                else {
186                    sub.createCell((short)5).setCellValue(" ")
187                }}
188            else {
189                sub.createCell((short)5).setCellValue(" ")
190            }
191        }
192        // adding study title in row 7
193        sub.createCell((short)6).setCellValue(study.title)
194        // Species row 9
195//        sample.parentSubject.species.name!=null ? sub.createCell((short)8).setCellValue(sample.parentSubject.species.name) : "not defined"
196        sample.parentSubject ? sub.createCell((short)8).setCellValue(sample.parentSubject.species.name) : "not defined"
197    }
198
199    // writing subject properties
200    def writeSubjectProperties(sub,sample,row) {
201                if( sample.parentSubject ) {
202                        log.trace "----- SUBJECT -----"
203                for (u in 0..sample.parentSubject.giveFields().unique().size()-1){
204                    TemplateField tf = sample.parentSubject.giveFields().getAt(u)
205                    log.trace tf.name
206                    row.createCell((short)9+u).setCellValue(tf.name)
207                    sample.parentSubject.getFieldValue(tf.name) ? sub.createCell((short)9+u).setCellValue(sample.parentSubject.getFieldValue(tf.name).toString()) : "not define"
208                }
209                } else {
210                        log.trace "------ NO SUBJECT FOR SAMPLE " + sample.name + "-----";
211                }
212    }
213
214    // writing samplingEvent properties
215    def writeSamplingEventProperties(sub,sample,row){
216                if( sample.parentEvent ) {
217                log.trace "----- SAMPLING EVENT -----"
218                for (t in 0..sample.parentEvent.giveFields().unique().size()-1){
219                    TemplateField tf =sample.parentEvent.giveFields().getAt(t)
220                    log.trace tf.name
221                    row.createCell((short)9+sample.parentSubject.giveFields().unique().size()+t).setCellValue("samplingEvent-"+tf.name)
222                    sample.parentEvent.getFieldValue(tf.name) ? sub.createCell((short)9+sample.parentSubject.giveFields().unique().size()+t).setCellValue(sample.parentEvent.getFieldValue(tf.name).toString()) : "not define"
223                }
224                } else {
225                        log.trace "------ NO SAMPLING EVENT FOR SAMPLE " + sample.name + "-----";
226                }
227    }
228
229    // writing EventGroup properties
230    def writeEventGroupProperties(sub,sample,row){
231     
232    }
233
234    // writing sample properties
235    def writeSampleProperties(sub,sample,row){
236        log.trace "----- SAMPLE -----"
237        for (v in 0..sample.giveFields().unique().size()-1){
238            TemplateField tf =sample.giveFields().getAt(v)
239            log.trace tf.name
240            row.createCell((short)9+sample.parentSubject.giveFields().unique().size()+v+sample.parentEvent.giveFields().unique().size()).setCellValue("sample-"+tf.name)
241            sample.getFieldValue(tf.name) ? sub.createCell((short)9+sample.parentSubject.giveFields().unique().size()+v+sample.parentEvent.giveFields().unique().size()).setCellValue(sample.getFieldValue(tf.name).toString()) : "not define"
242        }
243    }
244}
Note: See TracBrowser for help on using the browser.