BaseFeatureAdaptor.pm 9.37 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#
# BioPerl module for Bio::EnsEMBL::DBSQL::BaseAlignFeatureAdaptor
#
# Cared for by Ewan Birney <birney@ebi.ac.uk>
#
# Copyright Ewan Birney
#
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor - Abstract Base class for 
                                          FeatureAdaptors

=head1 SYNOPSIS

Abstract class should not be instantiated.  Implementation of
abstract methods must be performed by subclasses.

=head1 DESCRIPTION

This is a base adaptor for feature adaptors. This base class is simply a way
of eliminating code duplication through the implementation of methods 
common to all feature adaptors.

=head1 AUTHOR - Ewan Birney

Email birney@ebi.ac.uk

Describe contact details here

=head1 APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

=cut


# Let the code begin...


package Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor;
use vars qw(@ISA);
use strict;

# Object preamble - inherits from Bio::EnsEMBL::Root

use Bio::EnsEMBL::DBSQL::BaseAdaptor;

@ISA = qw(Bio::EnsEMBL::DBSQL::BaseAdaptor);

  
sub generic_fetch {
  my ($self, $constraint, $logic_name) = @_;
  
  my $tablename = $self->_tablename();
  my $columns = join(', ', $self->_columns());
  
  if($logic_name) {
    #determine the analysis id via the logic_name
    my $aa = $self->db->get_AnalysisAdaptor();
    my $analysis = $aa->fetch_by_logic_name($logic_name);
    unless(defined $analysis && $analysis->dbID() ) {
      $self->warn("No analysis for logic name $logic_name exists\n");
      return ();
    }
    
    my $analysis_id = $analysis->dbID();
    
    if($constraint) {
      $constraint .= " AND analysis_id = $analysis_id";
    } else {
      $constraint = " analysis_id = $analysis_id";
    }
  } 
      
  my $sql = 
    "SELECT $columns 
     FROM $tablename";

  if($constraint) {
     $sql .= " WHERE $constraint";
  }
  
  my $sth = $self->prepare($sql);
  $sth->execute();
  
  my $hashref;
  my @out;

  while($hashref = $sth->fetchrow_hashref()) {
    push @out, $self->_obj_from_hashref($hashref);
  }
  
  return @out;
}


=head2 fetch_by_dbID
  Args      : none
  Function  : Retrieves AlignFeature from database
  Returntype: BaseAlignFeature
  Exceptions: thrown: if _columns() or _table() not implemented by subclass
                      if $id arg is not defined
  Caller    : Slice

=cut

sub fetch_by_dbID{
  my ($self,$id) = @_;
  
  unless(defined $id) {
    $self->throw("fetch_by_dbID must have an id");
  }

  my $tablename = $self->_tablename();
  my $constraint = "${tablename}_id = $id";

121
122
123
  #return first element of _generic_fetch list
  my ($feat) = $self->generic_fetch($constraint); 
  return $feat;
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
}



=head2 fetch_by_contig_id_constraint

 Title   : fetch_by_contig_id
 Usage   :
 Function:
 Example :
 Returns : 
 Args    :


=cut

sub fetch_by_contig_id_constraint {
  my ($self, $cid, $constraint, $logic_name) = @_;
  
  if( !defined $cid ) {
    $self->throw("fetch_by_contig_id_constraint must have an contig id");
  }

  if($constraint) {
    $constraint .= " AND contig_id = $cid";
  } else {
    $constraint = "contig_id = $cid";
  }

  return $self->generic_fetch($constraint, $logic_name);
}

   
sub fetch_by_contig_id{
  my ($self, $cid, $logic_name) = @_;

  #fetch by contig id constraint with empty constraint
  return $self->fetch_by_contig_id_constraint($cid, '',$logic_name);
}


sub fetch_by_contig_id_and_score{
  my($self, $cid, $score, $logic_name) = @_;

  my $constraint;

170
  if(!defined $score){
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    $self->throw("need a score even if its 0\n");
  } else{
    $constraint = "score > $score";
  }
    
  my @features = 
    $self->fetch_by_contig_id_constraint($cid, $constraint, $logic_name);
  
  return @features;
}


sub fetch_by_Slice_constraint {
  my($self, $slice, $constraint, $logic_name) = @_;

  if(!$slice){
    $self->throw("need a slice to work\n");
  }
  unless($slice->isa("Bio::EnsEMBL::Slice")) {
    $self->throw("$slice isn't a slice");
  }

  my @features = 
    $self->fetch_by_assembly_location_constraint($slice->chr_start,
						 $slice->chr_end,
						 $slice->chr_name,
						 $slice->assembly_type,
						 $constraint,
						 $logic_name);

  #convert from chromosomal coordinates to slice coordinates
  foreach my $f (@features){
    my $start = ($f->start - ($slice->chr_start - 1));
    my $end = ($f->end - ($slice->chr_start - 1));
   
    $f->start($start);
    $f->end($end);
    $f->attach_seq($slice);
  }

  return @features;
}


sub fetch_by_Slice {
  my ($self, $slice, $logic_name) = @_;
  
  #fetch by constraint with empty constraint
  return $self->fetch_by_Slice_constraint($slice, '', $logic_name);
}


sub fetch_by_Slice_and_score {
  my ($self, $slice, $score, $logic_name) = @_;
  my $constraint;

227
  if(!defined $score) {
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
    $self->throw("need a score even if its 0\n");
  } else {
    $constraint = "score > $score";
  }

  return $self->fetch_by_Slice_constraint($slice, $constraint, $logic_name);
}  


=head2 fetch_by_assembly_location

 Title   : fetch_by_assembly_location
 Usage   :
 Function:
 Example :
 Returns : 
 Args    :


=cut

sub fetch_by_assembly_location{
  my ($self,$start,$end,$chr,$type, $logic_name) = @_;

  #fetch by assembly location constraint w/ empty constraint
  return $self->fetch_by_assembly_location_constraint($start, $end, $chr,
						      $type, '', $logic_name);
}


sub fetch_by_assembly_location_and_score{
  my ($self, $start, $end, $chr, $type, $score, $logic_name) = @_;
  my $constraint;

262
  if(!defined $score) {
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
    $self->throw("need a score even if its 0\n");
  } else {
    $constraint = "score > $score";
  }

  return $self->fetch_by_assembly_location_constraint($start, $end, $chr,$type,
						     $constraint, $logic_name);
}


=head2 fetch_by_assembly_location_constraint

 Title   : fetch_by_assembly_location_constraint
 Usage   :
 Function:
 Example :
 Returns : 
 Args    :


=cut

sub fetch_by_assembly_location_constraint {
  my ($self, $chr_start, $chr_end, $chr, $type, $constraint, $logic_name) = @_;

  if( !defined $type ) {
    $self->throw("Assembly location must be start,end,chr,type");
  }

  if( $chr_start !~ /^\d/ || $chr_end !~ /^\d/ ) {
    $self->throw("start/end must be numbers not $chr_start,$chr_end " .
		 "(have you typed the location in the right way around" .
		 "- start,end,chromosome,type)?");
  }
  
  my $mapper = $self->db->get_AssemblyMapperAdaptor->fetch_by_type($type);  
  my @cids = $mapper->list_contig_ids($chr, $chr_start ,$chr_end);
  
  if( scalar(@cids) == 0 ) {
    return ();
  }

  my $cid_list = join(',',@cids);

  #construct the constraint for the contig ids 
  if($constraint) {
    $constraint .= " AND contig_id IN ($cid_list)";
  } else {
    $constraint = "contig_id IN ($cid_list)";
  }
  
  my @features = $self->generic_fetch($constraint, $logic_name); 

  my @out;

  #convert the features to assembly coordinates from raw contig coordinates
  foreach my $f (@features) {
    #since feats were obtained in contig coords, attached seq is a contig
    my $contig_id = $f->entire_seq->dbID();
    my @coord_list = 
      $mapper->map_coordinates_to_assembly($contig_id, $f->start(),
					   $f->end(),$f->strand(),"rawcontig");
       
    # coord list > 1 - means does not cleanly map At the moment, skip
    if( scalar(@coord_list) > 1 ) {
      next;
    }
     
    my ($coord) = @coord_list;

    #maps to a gap in assembly?
    if($coord->isa("Bio::EnsEMBL::Mapper::Gap")){
      next;
    }

    #maps to region outside desired area
    if(!($coord->start() >= $chr_start) ||
       !($coord->end() <= $chr_end)) {
      next;
    }
        
    $f->start($coord->start());
    $f->end($coord->end());
    $f->strand($coord->strand());
    $f->seqname($coord->id());

    push(@out,$f);
  }
  
  return @out;
}

=head2 store

 Title   : store
 Usage   :
 Function:
 Example :
 Returns : 
 Args    :


=cut

sub store{
  my $self = @_;

  $self->throw("Abstract method store not defined by implementing subclass\n");
}


=head2 _tablename

  Args      : none
  Function  : abstract protected method implemented by subclass to provide 
              name of table for sql queries
  Returntype: string
  Exceptions: thrown if not implemented by subclass
  Caller    : Implementing AlignFeatureAdaptor subclasses

=cut

sub _tablename {
  my $self = shift;

  $self->throw("abstract method _tablename not defined by implementing" .
               " subclass of AlignFeatureAdaptor");
  return undef;
}

=head2 _columns

  Args      : none
  Function  : abstract protected method implemented by subclass to provide 
              column names for sql queries
  Returntype: string list
  Exceptions: thrown if not implemented by subclass
  Caller    : Implementing AlignFeatureAdaptor subclasses

=cut

sub _columns {
  my $self = shift;

  $self->throw("abstract method _columns not defined by implementing" .
               " subclass of AlignFeatureAdaptor");
}


=head2 _obj_from_hashref

  Args      : a  DBI hashref
  Function  : abstract protected method implemented by subclass to provide 
              object creation from a sql DBI hashref
  Returntype: BaseAlignFeature
  Exceptions: thrown if not implemented by subclass
  Caller    : Implementing AlignFeatureAdaptor subclasses

=cut

sub _obj_from_hashref {
  my $self = shift;

  $self->throw("abstract method _obj_from_hashref not defined by implementing"
             . " subclass of AlignFeatureAdaptor");
} 

1;