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

Last change on this file since 1430 was 1430, checked in by work@…, 10 years ago
  • set keyword expansion
  • Property svn:keywords set to Rev Author Date
File size: 6.2 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: 1430 $
12 * $Author: work@osx.eu $
13 * $Date: 2011-01-21 20:05:36 +0000 (vr, 21 jan 2011) $
14 */
15package dbnp.query
16
17import java.util.List
18import dbnp.studycapturing.*
19import nl.grails.plugins.gdt.*
20
21class SampleSearch extends Search {
22        public SampleSearch() {
23                this.entity = "Sample";
24        }
25
26        /**
27         * Searches for samples based on the given criteria. All criteria have to be satisfied and
28         * criteria for the different entities are satisfied as follows:
29         *
30         *              Sample.title = 'abc'           
31         *                              Only samples are returned from studies with title 'abc'
32         *             
33         *              Subject.species = 'human'
34         *                              Only samples are returned from subjects with species = 'human' 
35         *
36         *              Sample.name = 'sample 1'
37         *                              Only samples are returned with name = 'sample 1'
38         *
39         *              Event.startTime = '0s'
40         *                              Only samples are returned from subjects that have had an event with start time = '0s' 
41         *
42         *              SamplingEvent.startTime = '0s'
43         *                              Only samples are returned that have originated from a sampling event with start time = '0s' 
44         *
45         *              Assay.module = 'metagenomics'
46         *                              Only samples are returned that have been processed in an assay with module = metagenomics 
47         *
48         * When searching for more than one criterion per entity, these are taken combined. Searching for
49         *
50         *              Subject.species = 'human'
51         *              Subject.name = 'Jan'
52         *
53         *  will result in all samples from a human subject named 'Jan'. Samples from a mouse subject
54         *  named 'Jan' or a human subject named 'Kees' won't satisfy the criteria.
55         *     
56         */
57        @Override
58        void execute() {
59                // TODO: check for authorization for these studies?
60
61                // If no criteria are found, return all samples
62                if( !criteria || criteria.size() == 0 ) {
63                        results = Sample.list();
64                        return;
65                }
66
67                // We expect the sample criteria to be the most discriminative, and discard
68                // the most samples. (e.g. by searching on sample title of sample type). For
69                // that reason we first look through the list of studies. However, when the
70                // user didn't enter any sample criteria, this will be an extra step, but doesn't
71                // cost much time to process.
72                def samples = []
73                if( getEntityCriteria( 'Study' ).size() > 0 ) {
74                        def studies = Study.findAll();
75                        if( studies.size() == 0 ) {
76                                results = [];
77                                return;
78                        }
79                        studies = filterOnStudyCriteria( studies );
80                       
81                        def c = Sample.createCriteria()
82                        samples = c.list {
83                                'in'( 'parent', studies )
84                        }
85                } else {
86                        Sample.findAll().each {
87                                samples << it;
88                        }
89                }
90
91                samples = filterOnSubjectCriteria( samples );
92                samples = filterOnSampleCriteria( samples );
93                samples = filterOnEventCriteria( samples );
94                samples = filterOnSamplingEventCriteria( samples );
95                samples = filterOnAssayCriteria( samples );
96
97                // Save matches
98                results = samples;
99        }
100
101        /**
102         * Filters the given list of samples on the sample criteria
103         * @param samples       Original list of samples
104         * @return                      List with all samples that match the Sample-criteria
105         */
106        protected List filterOnStudyCriteria( List studies ) {
107                return filterEntityList( studies, getEntityCriteria( 'Study' ), { study, criterion ->
108                        return criterion.matchOne( study );
109                });
110        }
111
112        /**
113         * Filters the given list of samples on the subject criteria
114         * @param samples       Original list of samples
115         * @return                      List with all samples that match the Subject-criteria
116         */
117        protected List filterOnSubjectCriteria( List samples ) {
118                return filterEntityList( samples, getEntityCriteria( 'Subject' ), { sample, criterion ->
119                        if( !sample.parentSubject )
120                                return false
121
122                        return criterion.matchOne( sample.parentSubject );
123                });
124        }
125
126        /**
127         * Filters the given list of samples on the sample criteria
128         * @param samples       Original list of samples
129         * @return                      List with all samples that match the sample-criteria
130         */
131        protected List filterOnSampleCriteria( List samples ) {
132                return filterEntityList( samples, getEntityCriteria( 'Sample' ), { sample, criterion ->
133                        if( !sample  )
134                                return false
135
136                        return criterion.matchOne( sample );
137                });
138        }
139
140        /**
141         * Filters the given list of samples on the event criteria
142         * @param samples       Original list of samples
143         * @return                      List with all samples that match the event-criteria
144         */
145        protected List filterOnEventCriteria( List samples ) {
146                return filterEntityList( samples, getEntityCriteria( 'Event' ), { sample, criterion ->
147                        if( !sample || !sample.parentEventGroup || !sample.parentEventGroup.events?.size() )
148                                return false
149
150                        return criterion.matchAny( sample.parentEventGroup.events );
151                });
152        }
153
154        /**
155         * Filters the given list of samples on the sampling event criteria
156         * @param samples       Original list of samples
157         * @return                      List with all samples that match the event-criteria
158         */
159        protected List filterOnSamplingEventCriteria( List samples ) {
160                return filterEntityList( samples, getEntityCriteria( 'SamplingEvent' ), { sample, criterion ->
161                        if( !sample.parentEvent )
162                                return false
163
164                        return criterion.matchOne( sample.parentEvent );
165                });
166        }
167
168
169        /**
170         * Filters the given list of samples on the assay criteria
171         * @param samples       Original list of samples
172         * @return                      List with all samples that match the assay-criteria
173         */
174        protected List filterOnAssayCriteria( List samples ) {
175                if( !samples?.size() )
176                        return [];
177
178                // There is no sample.assays property, so we have to look for assays another way: just find
179                // all assays that match the criteria
180                def assays = filterEntityList( Assay.list(), getEntityCriteria( 'Assay' ), { assay, criterion ->
181                        if( !assay )
182                                return false
183
184                        return criterion.matchOne( assay );
185                });
186               
187                // If no assays match these criteria, then no samples will match either
188                if( assays.size() == 0 )
189                        return [];
190                       
191                // Now filter the samples on whether they are attached to the filtered assays
192                return samples.findAll { sample ->
193                        if( !sample.parent )
194                                return false;
195                       
196                        def studyAssays = assays.findAll { it.parent.equals( sample.parent ); }
197                       
198                        // See if this sample is present in any of the matching assays. If so,
199                        // this sample matches the criteria
200                        for( def assay in studyAssays ) {
201                                if( assay.samples?.contains( sample ) ) 
202                                        return true;
203                        }
204                       
205                        return false;
206                }
207        }
208
209}
Note: See TracBrowser for help on using the repository browser.