source: trunk/src/groovy/dbnp/query/SampleSearch.groovy @ 1482

Last change on this file since 1482 was 1482, checked in by robert@…, 9 years ago

Implemented saving of queries

  • Property svn:keywords set to Rev Author Date
File size: 7.7 KB
Line 
1/**
2 * SampleSearch Domain Class
3 *
4 * This class provides querying capabilities for searching for samples
5 *
6 * @author  Robert Horlings (robert@isdat.nl)
7 * @since       20110118
8 * @package     dbnp.query
9 *
10 * Revision information:
11 * $Rev: 1482 $
12 * $Author: robert@isdat.nl $
13 * $Date: 2011-02-02 15:40:22 +0000 (wo, 02 feb 2011) $
14 */
15package dbnp.query
16
17import java.util.Map;
18
19import dbnp.studycapturing.*
20import org.dbnp.gdt.*
21import org.apache.commons.logging.LogFactory;
22
23class SampleSearch extends Search {
24        private static final log = LogFactory.getLog(this);
25       
26        public SampleSearch() {
27                super();
28                               
29                this.entity = "Sample";
30        }
31
32        /**
33         * Searches for samples based on the given criteria. All criteria have to be satisfied and
34         * criteria for the different entities are satisfied as follows:
35         *
36         *              Sample.title = 'abc'           
37         *                              Only samples are returned from studies with title 'abc'
38         *             
39         *              Subject.species = 'human'
40         *                              Only samples are returned from subjects with species = 'human' 
41         *
42         *              Sample.name = 'sample 1'
43         *                              Only samples are returned with name = 'sample 1'
44         *
45         *              Event.startTime = '0s'
46         *                              Only samples are returned from subjects that have had an event with start time = '0s' 
47         *
48         *              SamplingEvent.startTime = '0s'
49         *                              Only samples are returned that have originated from a sampling event with start time = '0s' 
50         *
51         *              Assay.module = 'metagenomics'
52         *                              Only samples are returned that have been processed in an assay with module = metagenomics 
53         *
54         * When searching for more than one criterion per entity, these are taken combined. Searching for
55         *
56         *              Subject.species = 'human'
57         *              Subject.name = 'Jan'
58         *
59         *  will result in all samples from a human subject named 'Jan'. Samples from a mouse subject
60         *  named 'Jan' or a human subject named 'Kees' won't satisfy the criteria.
61         *     
62         */
63        @Override
64        void execute() {
65                super.execute();
66
67                // If no criteria are found, return all samples
68                if( !criteria || criteria.size() == 0 ) {
69                        results = Sample.list().findAll { it.parent?.canRead( this.user ) };
70                        return;
71                }
72
73                // We expect the sample criteria to be the most discriminative, and discard
74                // the most samples. (e.g. by searching on sample title of sample type). For
75                // that reason we first look through the list of studies. However, when the
76                // user didn't enter any sample criteria, this will be an extra step, but doesn't
77                // cost much time to process.
78                def samples = []
79                if( getEntityCriteria( 'Study' ).size() > 0 ) {
80                        def studies = Study.findAll().findAll { it.canRead( this.user ) };
81
82                        studies = filterOnStudyCriteria( studies );
83
84                        if( studies.size() == 0 ) {
85                                results = [];
86                                return;
87                        }
88
89                        def c = Sample.createCriteria()
90                        samples = c.list {
91                                'in'( 'parent', studies )
92                        }
93
94                        // Save data about the resulting studies in the
95                        // result fields array. The data that is now in the array
96                        // is saved based on the study id, not based on the sample id
97                        clearResultFields();
98                        saveResultFields( samples, getEntityCriteria( "Study" ), { sample, criterion ->
99                                return criterion.getFieldValue( sample.parent );
100                        });
101                } else {
102                        samples = Sample.findAll().findAll { it.parent?.canRead( this.user ) }
103                }
104
105                samples = filterOnSubjectCriteria( samples );
106                samples = filterOnSampleCriteria( samples );
107                samples = filterOnEventCriteria( samples );
108                samples = filterOnSamplingEventCriteria( samples );
109                samples = filterOnAssayCriteria( samples );
110
111                samples = filterOnModuleCriteria( samples );
112
113                // Save matches
114                results = samples;
115        }
116
117        /**
118         * Filters the given list of samples on the sample criteria
119         * @param samples       Original list of samples
120         * @return                      List with all samples that match the Sample-criteria
121         */
122        protected List filterOnStudyCriteria( List studies ) {
123                return filterOnTemplateEntityCriteria(studies, "Study", { study, criterion -> return criterion.getFieldValue( study ) })
124        }
125
126        /**
127         * Filters the given list of samples on the subject criteria
128         * @param samples       Original list of samples
129         * @return                      List with all samples that match the Subject-criteria
130         */
131        protected List filterOnSubjectCriteria( List samples ) {
132                return filterOnTemplateEntityCriteria(samples, "Subject", { sample, criterion ->
133                        return criterion.getFieldValue( sample.parentSubject );
134                })
135        }
136
137        /**
138         * Filters the given list of samples on the sample criteria
139         * @param samples       Original list of samples
140         * @return                      List with all samples that match the sample-criteria
141         */
142        protected List filterOnSampleCriteria( List samples ) {
143                return filterOnTemplateEntityCriteria(samples, "Sample", { sample, criterion ->
144                        return criterion.getFieldValue( sample );
145                })
146        }
147
148        /**
149         * Filters the given list of samples on the event criteria
150         * @param samples       Original list of samples
151         * @return                      List with all samples that match the event-criteria
152         */
153        protected List filterOnEventCriteria( List samples ) {
154                return filterOnTemplateEntityCriteria(samples, "Event", { sample, criterion ->
155                        if( !sample || !sample.parentEventGroup || !sample.parentEventGroup.events || sample.parentEventGroup.events.size() == 0 )
156                                return null
157
158                        return criterion.getFieldValue( sample.parentEventGroup.events.toList() );
159                })
160        }
161
162        /**
163         * Filters the given list of samples on the sampling event criteria
164         * @param samples       Original list of samples
165         * @return                      List with all samples that match the event-criteria
166         */
167        protected List filterOnSamplingEventCriteria( List samples ) {
168                return filterOnTemplateEntityCriteria(samples, "SamplingEvent", { sample, criterion ->
169                        return criterion.getFieldValue( sample.parentEvent );
170                })
171        }
172
173        /**
174         * Filters the given list of samples on the assay criteria
175         * @param samples       Original list of samples
176         * @return                      List with all samples that match the assay-criteria
177         */
178        protected List filterOnAssayCriteria( List samples ) {
179                if( !samples?.size() )
180                        return [];
181
182                if( getEntityCriteria( 'Assay' ).size() == 0 )
183                        return samples
184
185                // There is no sample.assays property, so we have to look for assays another way: just find
186                // all assays that match the criteria
187                def criteria = getEntityCriteria( 'Assay' );
188                def assays = filterEntityList( Assay.list(), criteria, { assay, criterion ->
189                        if( !assay )
190                                return false
191
192                        return criterion.matchOne( assay );
193                });
194
195                // If no assays match these criteria, then no samples will match either
196                if( assays.size() == 0 )
197                        return [];
198
199                // Save sample data for later use
200                saveResultFields( samples, criteria, { sample, criterion ->
201                        def sampleAssays = Assay.findByStudy( sample.parent ).findAll { it.samples?.contains( sample ) };
202                        if( sampleAssays && sampleAssays.size() > 0 )
203                                return sampleAssays.collect( criterion.getFieldValue( it ) )
204                        else
205                                return null
206                });
207
208                // Now filter the samples on whether they are attached to the filtered assays
209                return samples.findAll { sample ->
210                        if( !sample.parent )
211                                return false;
212
213                        def studyAssays = assays.findAll { it.parent.equals( sample.parent ); }
214
215                        // See if this sample is present in any of the matching assays. If so,
216                        // this sample matches the criteria
217                        for( def assay in studyAssays ) {
218                                if( assay.samples?.contains( sample ) )
219                                        return true;
220                        }
221
222                        return false;
223                }
224        }
225
226        /**
227         * Returns the saved field data that could be shown on screen. This means, the data
228         * is filtered to show only data of the query results. Also, the study title and sample
229         * name are filtered out, in order to be able to show all data on the screen without
230         * checking further
231         *
232         * @return      Map with the entity id as a key, and a field-value map as value
233         */
234        public Map getShowableResultFields() {
235                Map showableFields = super.getShowableResultFields()
236                showableFields.each { sampleElement ->
237                        sampleElement.value = sampleElement.value.findAll { fieldElement ->
238                                fieldElement.key != "Study title" && fieldElement.key != "Sample name"
239                        }
240                }
241        }
242}
Note: See TracBrowser for help on using the repository browser.