BaseFeatureAdaptor.pm 16.8 KB
Newer Older
1
#
2
# EnsEMBL module for Bio::EnsEMBL::DBSQL::BaseAlignFeatureAdaptor
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
#
# 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;
51
#use Bio::EnsEMBL::Utils::Eprof qw(eprof_start eprof_end eprof_dump);
52
use Bio::EnsEMBL::Utils::Cache;
53
54
55

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

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
my $SLICE_FEATURE_CACHE_SIZE = 12;


=head2 new

  Arg [1]    : list of args @args
               Superclass constructor arguments
  Example    : none
  Description: Constructor which just initializes internal cache structures
  Returntype : Bio::EnsEMBL::BaseFeatureAdaptor
  Exceptions : none
  Caller     : implementing subclass constructors

=cut

sub new {
  my ($class, @args) = @_;

  my $self = $class->SUPER::new(@args);

  #initialize caching data structures
  tie(%{$self->{'_slice_feature_cache'}}, 
      'Bio::EnsEMBL::Utils::Cache',
      $SLICE_FEATURE_CACHE_SIZE);

  return $self;
}
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

=head2 generic_fetch

  Arg [1]    : (optional) string $constraint
               An SQL query constraint (i.e. part of the WHERE clause)
  Arg [2]    : (optional) string $logic_name
               the logic_name of the analysis of the features to obtain
  Example    : @fts = $a->generic_fetch('contig_id in (1234, 1235)', 'swall');
  Description: Performs a database fetch and returns feature objects in
               contig coordinates.
  Returntype : list of Bio::EnsEMBL::*Feature in contig coordinates
  Exceptions : none
  Caller     : BaseFeatureAdaptor, ProxyDnaAlignFeatureAdaptor::generic_fetch

=cut
98
99
  
sub generic_fetch {
100
  my ($self, $constraint, $logic_name, $mapper, $slice) = @_;
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
  
  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);

133
  $sth->execute();
134
  
135
  return $self->_objs_from_sth($sth, $mapper, $slice);
136
137
138
139
}


=head2 fetch_by_dbID
140
141
142
143
144
145
146
147
148

  Arg [1]    : int $id
               the unique database identifier for the feature to be obtained 
  Example    : $feat = $adaptor->fetch_by_dbID(1234);
  Description: Returns the feature created from the database defined by the
               the id $id. 
  Returntype : Bio::EnsEMBL::*Feature
  Exceptions : thrown if $id is not defined
  Caller     : general
149
150
151
152
153
154
155
156
157
158
159
160
161

=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";

162
  #return first element of _generic_fetch list
163
  my ($feat) = @{$self->generic_fetch($constraint)}; 
164
  return $feat;
165
166
167
}


168
=head2 fetch_by_Contig_constraint
169

170
171
  Arg [1]    : Bio::EnsEMBL::RawContig $contig
               The contig object from which features are to be obtained
172
173
174
175
  Arg [2]    : (optional) string $constraint
               An SQL query constraint (i.e. part of the WHERE clause)
  Arg [3]    : (optional) string $logic_name
               the logic name of the type of features to obtain
176
  Example    : @fts = $a->fetch_by_Contig_constraint($contig, 'perc_ident>5.0');
177
178
179
180
181
182
183
  Description: Returns a list of features created from the database which are 
               are on the contig defined by $cid and fulfill the SQL constraint
               defined by $constraint. If logic name is defined, only features
               with an analysis of type $logic_name will be returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in contig coordinates
  Exceptions : thrown if $cid is not defined
  Caller     : general
184
185
186

=cut

187
188
sub fetch_by_Contig_constraint {
  my ($self, $contig, $constraint, $logic_name) = @_;
189
  
190
191
  unless( defined $contig ) {
    $self->throw("fetch_by_Contig_constraint must have an contig");
192
193
  }

194
195
196
197
198
199
  unless( ref $contig && $contig->isa('Bio::EnsEMBL::RawContig')) {
    $self->throw("contig argument is not a Bio::EnsEMBL::RawContig object\n");
  }

  my $cid = $contig->dbID();

200
201
202
203
204
205
  if($constraint) {
    $constraint .= " AND contig_id = $cid";
  } else {
    $constraint = "contig_id = $cid";
  }

206
  return @{$self->generic_fetch($constraint, $logic_name)};
207
208
}

209

210
=head2 fetch_by_Contig
211

212
213
  Arg [1]    : Bio::EnsEMBL::RawContig $contig 
               the contig from which features should be obtained
214
215
  Arg [2]    : (optional) string $logic_name
               the logic name of the type of features to obtain
216
  Example    : @fts = $a->fetch_by_Contig($contig, 'swall');
217
218
219
220
221
222
223
224
225
  Description: Returns a list of features created from the database which are 
               are on the contig defined by $cid If logic name is defined, 
               only features with an analysis of type $logic_name will be 
               returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in contig coordinates
  Exceptions : none
  Caller     : general

=cut
226
   
227
228
sub fetch_by_Contig{
  my ($self, $contig, $logic_name) = @_;
229
230

  #fetch by contig id constraint with empty constraint
231
  return $self->fetch_by_Contig_constraint($contig, '',$logic_name);
232
233
234
}


235
=head2 fetch_by_Contig_and_score
236

237
238
  Arg [1]    : Bio::EnsEMBL::RawContig $contig 
               the contig from which features should be obtained
239
240
241
242
  Arg [2]    : float $score
               the lower bound of the score of the features to obtain
  Arg [3]    : (optional) string $logic_name
               the logic name of the type of features to obtain
243
  Example    : @fts = $a->fetch_by_Contig_and_score(1, 50.0, 'swall');
244
245
246
247
248
249
250
251
252
253
  Description: Returns a list of features created from the database which are 
               are on the contig defined by $cid and which have score greater
               than score.  If logic name is defined, only features with an 
               analysis of type $logic_name will be returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in contig coordinates
  Exceptions : thrown if $score is not defined
  Caller     : general

=cut

254
255
sub fetch_by_Contig_and_score{
  my($self, $contig, $score, $logic_name) = @_;
256
257
258

  my $constraint;

259
  if(!defined $score){
260
261
262
263
264
    $self->throw("need a score even if its 0\n");
  } else{
    $constraint = "score > $score";
  }
    
265
  return $self->fetch_by_Contig_constraint($contig, $constraint, $logic_name);
266
267
268
}


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
=head2 fetch_by_Slice

  Arg [1]    : Bio::EnsEMBL::Slice $slice
               the slice from which to obtain features
  Arg [2]    : (optional) string $logic_name
               the logic name of the type of features to obtain
  Example    : @fts = $a->fetch_by_Slice($slice, 'swall');
  Description: Returns a list of features created from the database which are 
               are on the Slice defined by $slice.If $logic_name is defined, 
               only features with an analysis of type $logic_name will be 
               returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in Slice coordinates
  Exceptions : none
  Caller     : Bio::EnsEMBL::Slice

=cut

286
287
288
289
290
291
292
293
sub fetch_by_Slice {
  my ($self, $slice, $logic_name) = @_;
  
  #fetch by constraint with empty constraint
  return $self->fetch_by_Slice_constraint($slice, '', $logic_name);
}


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
=head2 fetch_by_Slice_and_score

  Arg [1]    : Bio::EnsEMBL::Slice $slice
               the slice from which to obtain features
  Arg [2]    : float $score
               lower bound of the the score of the features retrieved
  Arg [3]    : (optional) string $logic_name
               the logic name of the type of features to obtain
  Example    : @fts = $a->fetch_by_Slice($slice, 'swall');
  Description: Returns a list of features created from the database which are 
               are on the Slice defined by $slice and which have a score 
               greated than $score. If $logic_name is defined, 
               only features with an analysis of type $logic_name will be 
               returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in Slice coordinates
  Exceptions : none
  Caller     : Bio::EnsEMBL::Slice

=cut

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

318
  if(!defined $score) {
319
320
321
322
323
    $self->throw("need a score even if its 0\n");
  } else {
    $constraint = "score > $score";
  }

324
325
326
  my @res = $self->fetch_by_Slice_constraint($slice, $constraint, $logic_name);
  #&eprof_end('transform');
  return @res;
327
328
329
}  


330
=head2 fetch_by_Slice_constraint
331

332
333
334
335
336
  Arg [1]    : Bio::EnsEMBL::Slice $slice
               the slice from which to obtain features
  Arg [2]    : (optional) string $constraint
               An SQL query constraint (i.e. part of the WHERE clause)
  Arg [3]    : (optional) string $logic_name
337
               the logic name of the type of features to obtain
338
  Example    : @fts = $a->fetch_by_Slice_constraint($slice, 'perc_ident > 5');
339
  Description: Returns a list of features created from the database which are 
340
341
342
343
344
345
346
               are on the Slice defined by $slice and fulfill the SQL 
               constraint defined by $constraint. If logic name is defined, 
               only features with an analysis of type $logic_name will be 
               returned. 
  Returntype : list of Bio::EnsEMBL::*Feature in Slice coordinates
  Exceptions : thrown if $slice is not defined
  Caller     : Bio::EnsEMBL::Slice
347
348
349

=cut

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

353
354
  unless(defined $slice && ref $slice && $slice->isa("Bio::EnsEMBL::Slice")) {
    $self->throw("Slice arg must be a Bio::EnsEMBL::Slice not a [$slice]\n");
355
356
  }

357
  #check the cache and return if we have already done this query
358
  if (!defined $logic_name) {$logic_name = "";}
359
360
361
  my $key = join($slice->name, $constraint, $logic_name);
  if($self->{'_slice_feature_cache'}{$key}) {
    return @{$self->{'_slice_feature_cache'}{$key}};
362
363
  }

364
365
366
367
368
369
370
371
  my $chr_start = $slice->chr_start();
  my $chr_end   = $slice->chr_end();
  				 
  my $mapper = 
    $self->db->get_AssemblyMapperAdaptor->fetch_by_type($slice->assembly_type);

  #get the list of contigs this slice is on
  my @cids = $mapper->list_contig_ids($slice->chr_name, $chr_start ,$chr_end);
372
373
374
375
376
377
378
  
  if( scalar(@cids) == 0 ) {
    return ();
  }

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

379
  #construct the SQL constraint for the contig ids 
380
381
382
383
384
  if($constraint) {
    $constraint .= " AND contig_id IN ($cid_list)";
  } else {
    $constraint = "contig_id IN ($cid_list)";
  }
385
386
387

  my $features = 
    $self->generic_fetch($constraint, $logic_name, $mapper, $slice); 
Graham McVicker's avatar
Graham McVicker committed
388
  
Graham McVicker's avatar
typo  
Graham McVicker committed
389
  if(@$features && $features->[0]->contig == $slice) {
Graham McVicker's avatar
Graham McVicker committed
390
391
392
    #features have been converted to slice coords already, cache and return
    $self->{'_slice_feature_cache'}{$key} = $features;
    return @$features;
393
  }
394
395

  my @out;
396
  
397
  #&eprof_start('transform');
398
399
  #convert the features to slice coordinates from raw contig coordinates
  foreach my $f (@$features) {
400
    #since feats were obtained in contig coords, attached seq is a contig
401
    my $contig_id = $f->contig->dbID();
402
403

    #&eprof_start('rawcontig2assembly CALL');
404
405
    my ($chr_name, $start, $end, $strand) = 
      $mapper->fast_to_assembly($contig_id, $f->start(), $f->end(),$f->strand(),"rawcontig");
406
    #&eprof_end('rawcontig2assembly CALL');
407

408
409
    #not defined start means gap
    unless(defined $start) { 
410
411
412
413
      next;
    }

    #maps to region outside desired area
414
    if(($start > $chr_end) || ($end < $chr_start)) {
415
416
      next;
    }
417
418
    
    #shift the feature start, end and strand in one call
419
420
    $f->move($start - $chr_start + 1, $end - $chr_start + 1, $strand);
    $f->contig($slice);
421
    
422
423
424
    push(@out,$f);
  }
  
425
  #&eprof_end('rawcontig2assembly transform');
426
427
428

  #update the cache
  $self->{'_slice_feature_cache'}{$key} = \@out;
429
  
430
  return @out;
431
432
433
}


434
=head2 store
435

436
437
438
439
440
441
442
443
  Arg [1]    : list of Bio::EnsEMBL::*Feature
  Example    : $adaptor->store(@feats);
  Description: ABSTRACT  Subclasses are responsible for implementing this 
               method.  It should take a list of features and store them in 
               the database.
  Returntype : none
  Exceptions : thrown method is not implemented by subclass
  Caller     : general
444
445
446
447
448
449
450
451
452
453

=cut

sub store{
  my $self = @_;

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


454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
=head2 remove

  Arg [1]    : A feature $feature 
  Example    : $feature_adaptor->remove($feature);
  Description: This removes a feature from the database.  The table the
               feature is removed from is defined by the abstract method
               _tablename, and the primary key of the table is assumed
               to be _tablename() . '_id'.  The feature argument must 
               be an object implementing the dbID method, and for the
               feature to be removed from the datasbase a dbID value must
               be returned.
  Returntype : none
  Exceptions : thrown if $feature arg does not implement dbID(), or if 
               $feature->dbID is not a true value               
  Caller     : general

=cut

472

473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
sub remove {
  my ($self, $feature) = @_;

  unless($feature->can('dbID')) {
    $self->throw("Feature [$feature] does not implement method dbID");
  }

  unless($feature->dbID) {
    $self->warn("BaseFeatureAdaptor::remove - dbID not defined - " .
                "feature could not be removed");
  }

  my $table = $self->_tablename();

  my $sth = $self->prepare("DELETE FROM $table WHERE ${table}_id = ?");
  $sth->execute($feature->dbID());

  #unset the feature dbID
  $feature->dbID('');
  
  return;
}


497
498
=head2 _tablename

499
500
501
502
503
504
505
506
  Args       : none
  Example    : $tablename = $self->_table_name()
  Description: ABSTRACT PROTECTED Subclasses are responsible for implementing
               this method.  It should return the name of the table to be
               used to obtain features.  
  Returntype : string
  Exceptions : thrown if not implemented by subclass
  Caller     : BaseFeatureAdaptor::generic_fetch
507
508
509
510
511
512
513
514
515
516
517

=cut

sub _tablename {
  my $self = shift;

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

518

519
520
=head2 _columns

521
522
523
524
525
526
527
528
  Args       : none
  Example    : $tablename = $self->_columns()
  Description: ABSTRACT PROTECTED Subclasses are responsible for implementing
               this method.  It should return a list of columns to be used
               for feature creation
  Returntype : list of strings
  Exceptions : thrown if not implemented by subclass
  Caller     : BaseFeatureAdaptor::generic_fetch
529
530
531
532
533
534
535
536
537
538
539

=cut

sub _columns {
  my $self = shift;

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


540
=head2 _objs_from_sth
541
542
543
544
545
546
547
548
549
550
551
552
553

  Arg [1]    : DBI::row_hashref $hashref containing key-value pairs 
               for each of the columns specified by the _columns method
  Example    : my @feats = $self->_obj_from_hashref
  Description: ABSTRACT PROTECTED The subclass is responsible for implementing
               this method.  It should take in a DBI row hash reference and
               return a list of created features in contig coordinates.
  Returntype : list of Bio::EnsEMBL::*Features in contig coordinates
  Exceptions : thrown if not implemented by subclass
  Caller     : BaseFeatureAdaptor::generic_fetch

=cut

554
sub _objs_from_sth {
555
556
557
558
559
560
  my $self = shift;

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

561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580

=head2 deleteObj

  Arg [1]    : none
  Example    : none
  Description: Cleans up internal caches and references to other objects so
               that correct garbage collection may occur.
  Returntype : none
  Exceptions : none
  Caller     : Bio::EnsEMBL::DBConnection::deleteObj

=cut

sub deleteObj {
  my $self = shift;

  #flush feature cache
  %{$self->{'_slice_feature_cache'}} = ();
}

581
582
583
1;