BaseFeatureAdaptor.pm 31.4 KB
Newer Older
1
#
Simon Potter's avatar
Simon Potter committed
2
# EnsEMBL module for Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor
3
#
Graham McVicker's avatar
Graham McVicker committed
4
# Copyright (c) 2003 Ensembl
5 6 7 8 9
#
# You may distribute this module under the same terms as perl itself

=head1 NAME

10
Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor - An Abstract Base class for all
Graham McVicker's avatar
Graham McVicker committed
11
FeatureAdaptors
12 13 14

=head1 SYNOPSIS

15
Abstract class - should not be instantiated.  Implementation of
16 17 18 19 20
abstract methods must be performed by subclasses.

=head1 DESCRIPTION

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

24 25
=head1 CONTACT

Graham McVicker's avatar
Graham McVicker committed
26
Contact Ensembl development list for info: <ensembl-dev@ebi.ac.uk>
27 28 29

=head1 METHODS

30 31 32
=cut

package Bio::EnsEMBL::DBSQL::BaseFeatureAdaptor;
33
use vars qw(@ISA);
34 35 36
use strict;

use Bio::EnsEMBL::DBSQL::BaseAdaptor;
37
use Bio::EnsEMBL::Utils::Cache;
38 39
use Bio::EnsEMBL::Utils::Exception qw(warning throw deprecate);
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
40 41 42

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

43 44
my $SLICE_FEATURE_CACHE_SIZE = 4;
my $MAX_SPLIT_QUERY_SEQ_REGIONS = 3;
45 46 47 48 49 50 51 52 53 54 55 56 57 58

=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 {
59
  my $caller = shift;
60

61
  my $class = ref($caller) || $caller;
62

63
  my $self = $class->SUPER::new(@_);
64

65 66 67 68
  #initialize an LRU cache
  my %cache;
  tie(%cache, 'Bio::EnsEMBL::Utils::Cache', $SLICE_FEATURE_CACHE_SIZE);
  $self->{'_slice_feature_cache'} = \%cache;
69 70 71

  return $self;
}
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

=head2 _straight_join

  Arg [1]    : (optional) boolean $new_val
  Example    : $self->_straight_join(1);
               $self->generic_fetch($constraint);
               $self->_straight_join(0);
  Description: Getter/Setter that turns on/off the use of a straight join
               in queries.
  Returntype : boolean
  Exceptions : none
  Caller     : general

=cut

sub _straight_join {
  my $self = shift;
  if(@_) {
    $self->{'_straight_join'} = shift;
  }

  return $self->{'_straight_join'};
}


99 100 101 102
=head2 generic_fetch

  Arg [1]    : (optional) string $constraint
               An SQL query constraint (i.e. part of the WHERE clause)
103 104 105 106 107
  Arg [2]    : (optional) Bio::EnsEMBL::AssemblyMapper $mapper
               A mapper object used to remap features
               as they are retrieved from the database
  Arg [3]    : (optional) Bio::EnsEMBL::Slice $slice
               A slice that features should be remapped to
108
  Example    : $fts = $a->generic_fetch('contig_id in (1234, 1235)', 'Swall');
109 110
  Description: Performs a database fetch and returns feature objects in
               contig coordinates.
111
  Returntype : listref of Bio::EnsEMBL::SeqFeature in contig coordinates
112 113 114 115
  Exceptions : none
  Caller     : BaseFeatureAdaptor, ProxyDnaAlignFeatureAdaptor::generic_fetch

=cut
116

117
sub generic_fetch {
118
  my ($self, $constraint, $mapper, $slice) = @_;
119

120
  my @tabs = $self->_tables;
121
  my $columns = join(', ', $self->_columns());
122

123
  my $db = $self->db();
124 125 126 127 128

  #
  # Construct a left join statement if one was defined, and remove the
  # left-joined table from the table list
  #
129
  my @left_join_list = $self->_left_join();
130 131
  my $left_join = '';
  my @tables;
132 133
  if(@left_join_list) {
    my %left_join_hash = map { $_->[0] => $_->[1] } @left_join_list;
134
    while(my $t = shift @tabs) {
135 136 137
      if( exists $left_join_hash{ $t->[0] } ) {
        my $condition = $left_join_hash{ $t->[0] };
        my $syn = $t->[1];
Web Admin's avatar
Web Admin committed
138
        $left_join .=  "LEFT JOIN\n       ".$t->[0]." $syn ON $condition ";
139
      } else {
140
        push @tables, $t;
141 142 143 144 145
      }
    }
  } else {
    @tables = @tabs;
  }
146

147 148 149 150 151 152 153

  my $straight_join = '';

  if($self->_straight_join()) {
    $straight_join = "STRAIGHT_JOIN";
  }

154 155 156
  #construct a nice table string like 'table1 t1, table2 t2'
  my $tablenames = join(', ', map({ join(' ', @$_) } @tables));

157
  my $sql = "SELECT $straight_join $columns\n  FROM $tablenames $left_join";
158 159 160 161 162

  my $default_where = $self->_default_where_clause;
  my $final_clause = $self->_final_clause;

  #append a where clause if it was defined
163
  if($constraint) {
Web Admin's avatar
Web Admin committed
164
    $sql .= "\n WHERE $constraint ";
165
    if($default_where) {
Web Admin's avatar
Web Admin committed
166
      $sql .= " AND\n       $default_where ";
167 168
    }
  } elsif($default_where) {
Web Admin's avatar
Web Admin committed
169
    $sql .= "\n WHERE $default_where ";
170 171 172
  }

  #append additional clauses which may have been defined
Web Admin's avatar
Web Admin committed
173
  $sql .= "\n$final_clause";
174

175
  my $sth = $db->prepare($sql);
Web Admin's avatar
Web Admin committed
176
     $sth->execute;
177 178 179

  my $res = $self->_objs_from_sth($sth, $mapper, $slice);

180

181
  return $res;
182 183 184 185
}


=head2 fetch_by_dbID
186 187

  Arg [1]    : int $id
188 189 190
               The unique database identifier for the feature to be obtained
  Example    : $feat = $adaptor->fetch_by_dbID(1234));
               $feat = $feat->transform('contig');
191
  Description: Returns the feature created from the database defined by the
192 193 194 195 196 197 198 199 200
               the id $id.  The feature will be returned in its native
               coordinate system.  That is, the coordinate system in which it
               is stored in the database.  In order to convert it to a
               particular coordinate system use the transfer() or transform()
               method.  If the feature is not found in the database then
               undef is returned instead
  Returntype : Bio::EnsEMBL::Feature or undef
  Exceptions : thrown if $id arg is not provided
               does not exist
201
  Caller     : general
202 203 204 205 206 207

=cut

sub fetch_by_dbID{
  my ($self,$id) = @_;

208
  throw("id argument is required") if(!defined $id);
209

210 211
  #construct a constraint like 't1.table1_id = 123'
  my @tabs = $self->_tables;
212 213
  my ($name, $syn) = @{$tabs[0]};
  my $constraint = "${syn}.${name}_id = $id";
214

215 216 217 218 219
  #Should only be one
  my ($feat) = @{$self->generic_fetch($constraint)};

  return undef if(!$feat);

220
  return $feat;
221 222 223
}


224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
=head2 fetch_all_by_dbID_list

  Arg [1]    : listref of ints $id_list
               The unique database identifiers for the features to be obtained
  Example    : @feats = @{$adaptor->fetch_by_dbID_list([1234, 2131, 982]))};
  Description: Returns the features created from the database defined by the
               the ids in contained in the id list $id_list.  The features 
               will be returned in their native coordinate system. That is, 
               the coordinate system in which they are stored in the database.
               In order to convert the features to a particular coordinate 
               system use the transfer() or transform() method.  If none of the
               features are found in the database a reference to an empty 
               list is returned.
  Returntype : listref of Bio::EnsEMBL::Features
  Exceptions : thrown if $id arg is not provided
               does not exist
240
  Caller     : general
241 242 243

=cut

244 245
sub fetch_all_by_dbID_list {
  my ($self,$id_list) = @_;
246

247 248
  if(!defined($id_list) || ref($id_list) ne 'ARRAY') {
    throw("id_list list reference argument is required") if(!defined $id_list);
249 250
  }

251
  return [] if(!@$id_list);
252

253 254
  my @out;
  #construct a constraint like 't1.table1_id = 123'
255
  my @tabs = $self->_tables;
256
  my ($name, $syn) = @{$tabs[0]};
257

258 259 260
  #mysql is faster and we ensure that we do not exceed the max query size by
  #splitting large queries into smaller queries of 200 ids
  my $max_size = 200;
261

262 263 264 265 266 267 268
  while(@$id_list) {
    my @ids;
    if(@$id_list > $max_size) {
      @ids = splice(@$id_list, 0, $max_size);
    } else {
      @ids = splice(@$id_list, 0);
    }
269

270 271 272 273 274 275 276
    
    my $id_str;
    if(@ids > 1)  {
      $id_str = " IN (" . join(',', @ids). ")";
    } else {
      $id_str = " = " . $ids[0];
    }
277

278
    my $constraint = "${syn}.${name}_id $id_str";
279

280 281
    push @out, @{$self->generic_fetch($constraint)};
  }
Arne Stabenau's avatar
Arne Stabenau committed
282

283
  return \@out;
284 285 286 287
}



288
=head2 fetch_all_by_Slice
289 290 291 292 293

  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
294 295 296 297 298 299
  Example    : $fts = $a->fetch_all_by_Slice($slice, 'Swall');
  Description: Returns a listref of features created from the database 
               which 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 : listref of Bio::EnsEMBL::SeqFeatures in Slice coordinates
300 301 302 303 304
  Exceptions : none
  Caller     : Bio::EnsEMBL::Slice

=cut

305
sub fetch_all_by_Slice {
306
  my ($self, $slice, $logic_name) = @_;
307

308
  #fetch by constraint with empty constraint
309
  return $self->fetch_all_by_Slice_constraint($slice, '', $logic_name);
310 311 312
}


313
=head2 fetch_all_by_Slice_and_score
314 315 316

  Arg [1]    : Bio::EnsEMBL::Slice $slice
               the slice from which to obtain features
317
  Arg [2]    : (optional) float $score
318 319 320
               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
321
  Example    : $fts = $a->fetch_all_by_Slice($slice, 'Swall');
322 323 324 325 326
  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. 
327
  Returntype : listref of Bio::EnsEMBL::SeqFeatures in Slice coordinates
328 329 330 331 332
  Exceptions : none
  Caller     : Bio::EnsEMBL::Slice

=cut

333
sub fetch_all_by_Slice_and_score {
334 335 336
  my ($self, $slice, $score, $logic_name) = @_;
  my $constraint;

337
  if(defined $score) {
338 339 340 341
    #get the synonym of the primary_table
    my @tabs = $self->_tables;
    my $syn = $tabs[0]->[1];
    $constraint = "${syn}.score > $score";
342
  }
343 344
  return $self->fetch_all_by_Slice_constraint($slice, $constraint, 
					      $logic_name);
345
}
346 347


348
=head2 fetch_all_by_Slice_constraint
349

350 351 352 353 354
  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
355
               the logic name of the type of features to obtain
356 357
  Example    : $fs = $a->fetch_all_by_Slice_constraint($slc, 'perc_ident > 5');
  Description: Returns a listref of features created from the database which 
358 359 360 361
               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. 
362
  Returntype : listref of Bio::EnsEMBL::SeqFeatures in Slice coordinates
363 364
  Exceptions : thrown if $slice is not defined
  Caller     : Bio::EnsEMBL::Slice
365 366 367

=cut

368
sub fetch_all_by_Slice_constraint {
369 370
  my($self, $orig_slice, $original_constraint, $logic_name) = @_;
  my @result_features;
371

372
  if(!ref($orig_slice) || !$orig_slice->isa("Bio::EnsEMBL::Slice")) {
Graham McVicker's avatar
Graham McVicker committed
373
    throw("Bio::EnsEMBL::Slice argument expected.");
374 375
  }

376 377 378 379 380 381
  $original_constraint ||= '';
  $original_constraint = $self->_logic_name_to_constraint($original_constraint,
                                                          $logic_name);

  #if the logic name was invalid, undef was returned
  return [] if(!defined($original_constraint));
382

383
  #check the cache and return if we have already done this query
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
  my $key = uc(join(':', $orig_slice->name, $original_constraint));

  if(exists($self->{'_slice_feature_cache'}->{$key})) {
    return $self->{'_slice_feature_cache'}->{$key};
  }

  my $slice_adaptor = $orig_slice->adaptor();

  #retrieve normalized 'non-symlinked' slices
  #this allows us to support haplotypes and PARs
  my @projection =
    @{$slice_adaptor->fetch_normalized_slice_projection($orig_slice)};

  if(@projection == 0) {
    throw('Could not retrieve normalized Slices. Database contains ' .
          'incorrect assembly_exception information.');
  }

  #we want to retrieve all features calculated on the FULL original slice 
  #as well as any symlinked slices.  

  #Filter out any partial slices from the normalized projection that are on 
  #the same seq region as the original slice
  my @new_projection = 
    grep { $_->[2]->seq_region_name() ne $orig_slice->seq_region_name() } 
    @projection;

  push( @new_projection, [ 1, $orig_slice->length(), $orig_slice ] );

  #fetch features for the primary slice AND all symlinked slices
  foreach my $segment (@new_projection) {
    my ($offset, $slice);
    ($offset, undef, $slice) = @$segment;

    my $slice_start  = $slice->start();
    my $slice_end    = $slice->end();
    my $slice_strand = $slice->strand();
    my $slice_cs     = $slice->coord_system();
    my $slice_seq_region = $slice->seq_region_name();

    #get the synonym and name of the primary_table
    my @tabs = $self->_tables;
    my ($tab_name, $tab_syn) = @{$tabs[0]};

    #find out what coordinate systems the features are in
429 430
    my $mcc = $self->db->get_MetaCoordContainer();
    my @feat_css = @{$mcc->fetch_all_CoordSystems_by_feature_type($tab_name)};
431 432 433 434 435 436 437 438 439

    my $asma = $self->db->get_AssemblyMapperAdaptor();
    my @features;

    # fetch the features from each coordinate system they are stored in
  COORD_SYSTEM: foreach my $feat_cs (@feat_css) {
      my $mapper;
      my @coords;
      my @ids;
440

441 442 443
      if($feat_cs->equals($slice_cs)) {
        #no mapping is required if this is the same coord system
        my $constraint = $original_constraint;
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
        # obtain seq_region_id of this slice from db
        my $seq_region_id = 
          $self->db->get_SliceAdaptor->get_seq_region_id($slice);
        $constraint .= " AND " if($constraint);
        $constraint .=
          "${tab_syn}.seq_region_id = $seq_region_id AND " .
          "${tab_syn}.seq_region_start <= $slice_end AND " .
          "${tab_syn}.seq_region_end >= $slice_start";
        my $fs = $self->generic_fetch($constraint,undef,$slice);

        #features may still have to have coordinates made relative to slice 
        #start
        $fs = $self->_remap($fs, $mapper, $slice);

        push @features, @$fs;
      } else {
        $mapper = $asma->fetch_by_CoordSystems($slice_cs, $feat_cs);
462

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        # Get a list of coordinates and corresponding internal ids for the
        # regions we are interested in
        @coords = $mapper->map($slice_seq_region, $slice_start, $slice_end,
                               $slice_strand, $slice_cs);

        @coords = grep {!$_->isa('Bio::EnsEMBL::Mapper::Gap')} @coords;

        next COORD_SYSTEM if(!@coords);

        @ids = map {$_->id()} @coords;
        @ids = @{$asma->seq_regions_to_ids($feat_cs, \@ids)};

        #if the regions are large and only partially spanned
        #it is faster to to limit the query with start and end constraints
        #however, it is difficult to tell if a region is large and only 
        #partially wanted. The easy approach is just to limit the queries if 
        #there are less than a certain number of regions. As well seperate 
        #queries are needed otherwise the indices will not be useful
        if(@coords > $MAX_SPLIT_QUERY_SEQ_REGIONS) {
          #do one query, and do not limit with start / end constraints
          my $constraint = $original_constraint;
          my $id_str = join(',', @ids);
          $constraint .= " AND " if($constraint);
          $constraint .= "${tab_syn}.seq_region_id IN ($id_str)";
487 488

          my $fs =
489
            $self->generic_fetch($constraint, $mapper, $slice);
490

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
          $fs = $self->_remap($fs, $mapper, $slice);

          push @features, @$fs;

        } else {
          #do multiple split queries using start / end constraints
          my $len = @coords;
          for(my $i = 0; $i < $len; $i++) {
            my $constraint = $original_constraint;
            $constraint .= " AND " if($constraint);
            $constraint .=
              "${tab_syn}.seq_region_id = "     . $ids[$i] . " AND " .
              "${tab_syn}.seq_region_start <= " . $coords[$i]->end() . " AND ".
              "${tab_syn}.seq_region_end >= "   . $coords[$i]->start();
            my $fs = $self->generic_fetch($constraint,$mapper,$slice);

            $fs = $self->_remap($fs, $mapper, $slice);
508

509 510 511 512 513
            push @features, @$fs;
          }
        }
      }
    } #COORD system loop
514

515 516 517 518 519 520 521 522 523 524 525 526 527 528
    #if this was a symlinked slice offset the feature coordinates as needed
    if($slice != $orig_slice) {
      foreach my $f (@features) {
        #function calls are slow!
        if($offset != 1) {
          $f->{'start'} += $offset-1;
          $f->{'end'}   += $offset-1;
        }
        $f->{'slice'} = $orig_slice;
        push @result_features, $f;
      }
    } else {
      push @result_features, @features;
    }
529

530
  } #slice & symmlinked slice loop
531

532
  $self->{'_slice_feature_cache'}->{$key} = \@result_features;
533

534 535
  return \@result_features;
}
536

537

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
#
# Helper function containing some common feature storing functionality
#
# Given a Feature this will return a copy (or the same feature if no changes 
# to the feature are needed) of the feature which is relative to the start
# of the seq_region it is on. The seq_region_id of the seq_region it is on
# is also returned.
#
# This method will also ensure that the database knows which coordinate
# systems that this feature is stored in.
#

sub _pre_store {
  my $self    = shift;
  my $feature = shift;

  if(!ref($feature) || !$feature->isa('Bio::EnsEMBL::Feature')) {
    throw('Expected Feature argument.');
556
  }
557

558 559 560
  $self->_check_start_end_strand($feature->start(),$feature->end(),
                                 $feature->strand());

561 562 563 564

  my $db = $self->db();

  my $slice_adaptor = $db->get_SliceAdaptor();
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
  my $slice = $feature->slice();

  if(!ref($slice) || !$slice->isa('Bio::EnsEMBL::Slice')) {
    throw('Feature must be attached to Slice to be stored.');
  }

  # make sure that the feature coordinates are relative to
  # the start of the entire seq_region
  if($slice->start != 1 || $slice->strand != 1) {
    #move the feature onto a slice of the entire seq_region
    $slice = $slice_adaptor->fetch_by_region($slice->coord_system->name(),
                                             $slice->seq_region_name(),
                                             undef, #start
                                             undef, #end
                                             undef, #strand
                                             $slice->coord_system->version());

    $feature = $feature->transfer($slice);

    if(!$feature) {
      throw('Could not transfer Feature to slice of ' .
            'entire seq_region prior to storing');
    }
  }

  #
  # Ensure that this type of feature is known to be stored in this coord
  # system.
  #
  my $cs = $slice->coord_system;

  my ($tab) = $self->_tables();
  my $tabname = $tab->[0];

599 600 601
  my $mcc = $db->get_MetaCoordContainer();

  $mcc->add_feature_type($cs, $tabname);
602

603 604 605
  # we have to update the meta coord table in both the dna db and the feature
  # db so that the feature db can be used independently later

606 607 608 609 610 611
  #  Actually, the meta coord info should probably only go in the database
  #  where the features are actually stored, not the dnadb (which is often
  #  going to be read-only anyway)
  #   if($db->dnadb() != $db) {
  #     my $dnadb = $db->dnadb();
  #     $db->dnadb(undef); # unset the dnadb temporarily
612

613 614 615
  #     #get a coord system adaptor from the feature database
  #     $csa = $db->get_CoordSystemAdaptor();
  #     $csa->add_feature_table($cs, $tabname);
616

617 618
  #     $db->dnadb($dnadb); # reinstate the dnadb
  #   }
619

620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
  my $seq_region_id = $slice_adaptor->get_seq_region_id($slice);

  if(!$seq_region_id) {
    throw('Feature is associated with seq_region which is not in this DB.');
  }

  return ($feature, $seq_region_id);
}


#
# helper function used to validate start/end/strand and 
# hstart/hend/hstrand etc.
#
sub _check_start_end_strand {
  my $self = shift;
  my $start = shift;
  my $end   = shift;
  my $strand = shift;

  #
  # Make sure that the start, end, strand are valid
  #
  if(int($start) != $start) {
    throw("Invalid Feature start [$start].  Must be integer.");
  }
  if(int($end) != $end) {
    throw("Invalid Feature end [$end]. Must be integer.");
  }
  if(int($strand) != $strand || $strand < -1 || $strand > 1) {
    throw("Invalid Feature strand [$strand]. Must be -1, 0 or 1.");
  }
  if($end < $start) {
    throw("Invalid Feature start/end [$start/$end]. Start must be less " .
          "than or equal to end.");
  }

  return 1;
}


#
# Given a list of features checks if they are in the correct coord system
# by looking at the first features slice.  If they are not then they are
# converted and placed on the slice.
#
sub _remap {
  my ($self, $features, $mapper, $slice) = @_;

  #check if any remapping is actually needed
  if(@$features && (!$features->[0]->isa('Bio::EnsEMBL::Feature') ||
                    $features->[0]->slice == $slice)) {
    return $features;
673
  }
674

675
  #remapping has not been done, we have to do our own conversion from
676 677 678 679 680 681 682 683 684 685
  #to slice coords

  my @out;

  my $slice_start = $slice->start();
  my $slice_end   = $slice->end();
  my $slice_strand = $slice->strand();
  my $slice_cs    = $slice->coord_system();

  my ($seq_region, $start, $end, $strand);
686

687
  my $slice_seq_region = $slice->seq_region_name();
688

689
  foreach my $f (@$features) {
690
    #since feats were obtained in contig coords, attached seq is a contig
691 692 693 694 695 696
    my $fslice = $f->slice();
    if(!$fslice) {
      throw("Feature does not have attached slice.\n");
    }
    my $fseq_region = $fslice->seq_region_name();
    my $fcs = $fslice->coord_system();
697

698 699
    if(!$slice_cs->equals($fcs)) {
      #slice of feature in different coord system, mapping required
700

701 702 703 704 705 706 707 708 709 710 711 712 713
      ($seq_region, $start, $end, $strand) =
        $mapper->fastmap($fseq_region,$f->start(),$f->end(),$f->strand(),$fcs);

      # undefined start means gap
      next if(!defined $start);
    } else {
      $start      = $f->start();
      $end        = $f->end();
      $strand     = $f->strand();
      $seq_region = $f->slice->seq_region_name();
    }

    # maps to region outside desired area
714 715
    next if ($start > $slice_end) || ($end < $slice_start) || 
      ($slice_seq_region ne $seq_region);
716

717
    #shift the feature start, end and strand in one call
718
    if($slice_strand == -1) {
719
      $f->move( $slice_end - $end + 1, $slice_end - $start + 1, $strand * -1 );
720 721 722
    } else {
      $f->move( $start - $slice_start + 1, $end - $slice_start + 1, $strand );
    }
723 724 725

    $f->slice($slice);

Web Admin's avatar
Web Admin committed
726
    push @out,$f;
727
  }
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

  return \@out;
}


#
# Given a logic name and an existing constraint this will
# add an analysis table constraint to the feature.  Note that if no
# analysis_id exists in the columns of the primary table then no
# constraint is added at all
#
sub _logic_name_to_constraint {
  my $self = shift;
  my $constraint = shift;
  my $logic_name = shift;

  return $constraint if(!$logic_name);

  #make sure that an analysis_id exists in the primary table
  my ($prim_tab) = $self->_tables();
  my $prim_synonym = $prim_tab->[1];

  my $found_analysis=0;
  foreach my $col ($self->_columns) {
    my ($syn,$col_name) = split(/\./,$col);
    next if($syn ne $prim_synonym);
    if($col_name eq 'analysis_id') {
      $found_analysis = 1;
      last;
    }
  }

  if(!$found_analysis) {
    warning("This feature is not associated with an analysis.\n" .
            "Ignoring logic_name argument = [$logic_name].\n");
    return $constraint;
  }

  my $aa = $self->db->get_AnalysisAdaptor();
  my $an = $aa->fetch_by_logic_name($logic_name);

  if(!$an) {
    warning("No analysis exists with logic_name = [$logic_name].\n" .
            "Returning empty list.\n");
    return undef;
  }

  my $an_id = $an->dbID();

  $constraint .= ' AND' if($constraint);
  $constraint .= " ${prim_synonym}.analysis_id = $an_id";
  return $constraint;
780 781 782
}


783
=head2 store
784

785
  Arg [1]    : list of Bio::EnsEMBL::SeqFeature
786 787 788 789 790 791 792
  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
793 794 795 796 797 798

=cut

sub store{
  my $self = @_;

799
  throw("Abstract method store not defined by implementing subclass\n");
800 801 802
}


803 804 805 806 807 808 809 810 811
=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
812
               feature to be removed from the database a dbID value must
813 814
               be returned.
  Returntype : none
815 816
  Exceptions : thrown if $feature arg does not implement dbID(), or if
               $feature->dbID is not a true value
817 818 819 820
  Caller     : general

=cut

821

822 823 824
sub remove {
  my ($self, $feature) = @_;

825 826
  if(!$feature || !ref($feature) || !$feature->isa('Bio::EnsEMBL::Feature')) {
    throw('Feature argument is required');
827 828
  }

829 830
  if(!$feature->is_stored($self->db)) {
    throw("This feature is not stored in this database");
831 832
  }

833 834
  my @tabs = $self->_tables;
  my ($table) = @{$tabs[0]};
835 836 837 838

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

839 840 841 842
  #unset the feature dbID ad adaptor
  $feature->dbID(undef);
  $feature->adaptor(undef);

843 844 845 846
  return;
}


847
=head2 remove_by_Slice
848

849 850 851 852 853 854 855 856
  Arg [1]    : Bio::Ensembl::Slice $slice
  Example    : $feature_adaptor->remove_by_RawContig($slice);
  Description: This removes features from the database which lie on a region
               represented by the passed in slice.  Only features which are
               fully contained by the slice are deleted; features which overlap
               the edge of the slice are not removed.
               The table the features are removed from is defined by
               the abstract method_tablename.
857
  Returntype : none
858
  Exceptions : thrown if no slice is supplied
859 860 861 862
  Caller     : general

=cut

863 864
sub remove_by_Slice {
  my ($self, $slice) = @_;
865

866 867
  if(!$slice || !ref($slice) || !$slice->isa('Bio::EnsEMBL::Slice')) {
    throw("Slice argument is required");
868 869
  }

870 871
  my @tabs = $self->_tables;
  my ($table_name) = @{$tabs[0]};
872

873 874 875
  my $seq_region_id = $self->db->get_SliceAdaptor->get_seq_region_id($slice);
  my $start = $slice->start();
  my $end   = $slice->end();
876

877 878 879 880 881 882 883
  #
  # Delete only features fully on the slice, not overlapping ones
  #
  my $sth = $self->prepare("DELETE FROM $table_name " .
                           "WHERE seq_region_id = ? " .
                           "AND   seq_region_start >= ? " .
                           "AND   seq_region_end <= ?");
884

885 886
  $sth->execute($seq_region_id, $start, $end);
  $sth->finish();
887 888 889 890
}



891 892


893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
#_tables
#
#  Args       : none
#  Example    : $tablename = $self->_table_name()
#  Description: ABSTRACT PROTECTED Subclasses are responsible for implementing
#               this method.  It should list of [tablename, alias] pairs.  
#               Additionally the primary table (with the dbID, analysis_id, and
#               score) should be the first table in the list.
#               e.g:
#               ( ['repeat_feature',   'rf'],
#                 ['repeat_consensus', 'rc']);
#               used to obtain features.  
#  Returntype : list of [tablename, alias] pairs
#  Exceptions : thrown if not implemented by subclass
#  Caller     : BaseFeatureAdaptor::generic_fetch
#
909

910
sub _tables {
911 912
  my $self = shift;

913
  throw("abstract method _tables not defined by implementing" .
Simon Potter's avatar
Simon Potter committed
914
               " subclass of BaseFeatureAdaptor");
915 916 917
  return undef;
}

918

919 920 921 922 923 924 925 926 927 928 929
#_columns
#
#  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
#
930 931 932 933

sub _columns {
  my $self = shift;

934
  throw("abstract method _columns not defined by implementing" .
Simon Potter's avatar
Simon Potter committed
935
               " subclass of BaseFeatureAdaptor");
936 937 938
}


939

940 941 942 943 944 945 946 947 948 949 950 951
# _default_where_clause
#
#  Arg [1]    : none
#  Example    : none
#  Description: May be overridden to provide an additional where constraint to 
#               the SQL query which is generated to fetch feature records.
#               This constraint is always appended to the end of the generated
#               where clause
#  Returntype : string
#  Exceptions : none
#  Caller     : generic_fetch
#
952

953 954
sub _default_where_clause {
  my $self = shift;
955

956 957
  return '';
}
958 959 960



961
# _left_join
962

963 964 965 966 967 968 969 970 971
#  Arg [1]    : none
#  Example    : none
#  Description: Can be overridden by a subclass to specify any left joins
#               which should occur. The table name specigfied in the join
#               must still be present in the return values of
#  Returntype : a {'tablename' => 'join condition'} pair
#  Exceptions : none
#  Caller     : general
#
972

973 974
sub _left_join {
  my $self = shift;
975

976 977
  return ();
}
978 979


980 981 982 983 984 985 986 987 988 989 990 991 992 993

#_final_clause

#  Arg [1]    : none
#  Example    : none
#  Description: May be overriden to provide an additional clause to the end
#               of the SQL query used to fetch feature records.  
#               This is useful to add a required ORDER BY clause to the 
#               query for example.
#  Returntype : string
#  Exceptions : none
#  Caller     : generic_fetch

sub _final_clause {
994 995 996 997 998 999
  my $self = shift;

  return '';
}


1000
#_objs_from_sth
1001

1002 1003 1004 1005 1006 1007 1008 1009 1010
#  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
1011

1012 1013
sub _objs_from_sth {
  my $self = shift;
1014

1015 1016 1017
  throw("abstract method _obj_from_sth not defined by implementing"
             . " subclass of BaseFeatureAdaptor");
}
1018

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
# 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


sub deleteObj {
1031 1032
  my $self = shift;

1033 1034
  #flush feature cache
  %{$self->{'_slice_feature_cache'}} = ();
1035 1036 1037
}


Graham McVicker's avatar
Graham McVicker committed
1038
=head1 DEPRECATED METHODS
1039

Graham McVicker's avatar
Graham McVicker committed
1040
=cut
1041

1042 1043 1044 1045

=head2 fetch_all_by_RawContig_constraint

  Description: DEPRECATED use fetch_all_by_RawContig_constraint instead
1046 1047 1048

=cut

1049
sub fetch_all_by_RawContig_constraint {
1050
  my $self = shift;
1051 1052
  deprecate('Use fetch_all_by_Slice_constraint() instead.');
  return $self->fetch_all_by_slice_constraint(@_);
1053 1054
}

1055
=head2 fetch_all_by_RawContig
1056

1057
  Description: DEPRECATED use fetch_all_by_Slice instead
1058 1059 1060

=cut

1061
sub fetch_all_by_RawContig {
1062
  my $self = shift;
1063 1064 1065
  deprecate('Use fetch_all_by_Slice() instead.');
  return $self->fetch_all_by_Slice(@_);
}
1066