SliceAdaptor.pm 44.4 KB
Newer Older
1 2

#
Simon Potter's avatar
pod  
Simon Potter committed
3
# Ensembl module for Bio::EnsEMBL::DBSQL::SliceAdaptor
4 5
#
#
Graham McVicker's avatar
Graham McVicker committed
6
# Copyright (c) 2004 Ensembl
7 8 9 10 11 12 13
#
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

14 15
Bio::EnsEMBL::DBSQL::SliceAdaptor - A database aware adaptor responsible for
the creation of Slice objects.
16 17 18

=head1 SYNOPSIS

Graham McVicker's avatar
Graham McVicker committed
19 20
  use Bio::EnsEMBL::DBSQL::DBAdaptor;
  use Bio::EnsEMBL::Utils::Slice qw(split_Slices);
21

Graham McVicker's avatar
Graham McVicker committed
22
  $db = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
23

Graham McVicker's avatar
Graham McVicker committed
24
  $slice_adaptor = $db->get_SliceAdaptor();
25

Graham McVicker's avatar
Graham McVicker committed
26 27 28 29 30
  # get a slice on the entire chromosome X
  $chr_slice = $slice_adaptor->fetch_by_region('chromosome','X');

  # get a slice for each clone in the database
  foreach $cln_slice (@{$slice_adaptor->fetch_all('clone')}) {
31 32 33
    #do something with clone
  }

Graham McVicker's avatar
Graham McVicker committed
34 35
  # get a slice which is part of NT_004321
  $spctg_slice = $slice_adaptor->fetch_by_region('supercontig','NT_004321',
36
                                                    200_000, 600_000);
37 38


Graham McVicker's avatar
Graham McVicker committed
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
  # get all non-redundant slices from the highest possible coordinate systems
  $slices = $slice_adaptor->fetch_all('toplevel');

  # include non-reference regions
  $slices = $slice_adaptor->fetch_all('toplevel',undef,1);

  # include non-duplicate regions
  $slices = $slice_adaptor->fetch_all('toplevel', undef, 0, 1);

  # split up a list of slices into smaller slices
  $overlap = 1000;
  $max_length = 1e6;
  $slices = split_Slices($slices, $max_length, $overlap);


  # store a list of slice names in a file
  open(FILE, ">$filename") or die("Could not open file $filename");
  foreach my $slice (@$slices) {
    print FILE $slice->name(), "\n";
  }
  close FILE;

  # retreive a list of slices from a file
  open(FILE, $filename) or die("Could not open file $filename");
  while($name = <FILE>) {
    chomp($name);
    $slice = $slice_adaptor->fetch_by_name($name);

    # do something with slice
  }

70 71
=head1 DESCRIPTION

72
This module is responsible for fetching Slices representing genomic regions
Graham McVicker's avatar
Graham McVicker committed
73
from a database.  A Details on how slices can be used are in the
74
Bio::EnsEMBL::Slice module.
75

76
=head1 CONTACT
77

Graham McVicker's avatar
Graham McVicker committed
78 79 80
This module is part of the Ensembl project http://www.ensembl.org

For more information email <ensembl-dev@ebi.ac.uk>
81

82
=head1 METHODS
83 84 85 86

=cut


87
package Bio::EnsEMBL::DBSQL::SliceAdaptor;
88 89 90
use vars qw(@ISA);
use strict;

91

92 93
use Bio::EnsEMBL::DBSQL::BaseAdaptor;
use Bio::EnsEMBL::Slice;
94
use Bio::EnsEMBL::Mapper;
95

96 97
use Bio::EnsEMBL::Utils::Exception qw(throw deprecate warning);
use Bio::EnsEMBL::Utils::Cache; #CPAN LRU cache
98

99
@ISA = ('Bio::EnsEMBL::DBSQL::BaseAdaptor');
100

101
my $SEQ_REGION_CACHE_SIZE = 1000;
102

103 104
sub new {
  my $caller = shift;
105

106
  my $class = ref($caller) || $caller;
107

108
  my $self = $class->SUPER::new(@_);
109

110 111
  my %name_cache;
  my %id_cache;
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
  tie(%name_cache, 'Bio::EnsEMBL::Utils::Cache', $SEQ_REGION_CACHE_SIZE);
  tie(%id_cache, 'Bio::EnsEMBL::Utils::Cache', $SEQ_REGION_CACHE_SIZE);

  $self->{'_name_cache'} = \%name_cache;
  $self->{'_id_cache'} = \%id_cache;

  return $self;
}


=head2 fetch_by_region

  Arg [1]    : string $coord_system_name
               The name of the coordinate system of the slice to be created
               This may be a name of an acutal coordinate system or an alias
               to a coordinate system.  Valid aliases are 'seqlevel' or
               'toplevel'.
  Arg [2]    : string $seq_region_name
               The name of the sequence region that the slice will be
Graham McVicker's avatar
Graham McVicker committed
132
               created on.
133 134 135 136 137 138 139 140
  Arg [3]    : int $start (optional, default = 1)
               The start of the slice on the sequence region
  Arg [4]    : int $end (optional, default = seq_region length)
               The end of the slice on the sequence region
  Arg [5]    : int $strand (optional, default = 1)
               The orientation of the slice on the sequence region
  Arg [6]    : string $version (optional, default = default version)
               The version of the coordinate system to use (e.g. NCBI33)
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
  Example    : $slice = $slice_adaptor->fetch_by_region('chromosome', 'X');
               $slice = $slice_adaptor->fetch_by_region('clone', 'AC008066.4');
  Description: Retrieves a slice on the requested region.  At a minimum the
               name of the coordinate system and the name of the seq_region to
               fetch must be provided.

               Some fuzzy matching is performed if no exact match for
               the provided name is found.  This allows clones to be
               fetched even when their version is not known.  For
               example fetch_by_region('clone', 'AC008066') will
               retrieve the sequence_region with name 'AC008066.4'.

               If the requested seq_region is not found in the database undef
               is returned.

  Returntype : Bio::EnsEMBL::Slice or undef
  Exceptions : throw if no seq_region_name is provided
               throw if invalid coord_system_name is provided
               throw if start > end is provided
160
  Caller     : general
161 162 163

=cut

164 165 166 167
sub fetch_by_region {
  my ($self, $coord_system_name, $seq_region_name,
      $start, $end, $strand, $version) = @_;

168 169 170 171
  $start  = 1 if(!defined($start));
  $strand = 1 if(!defined($strand));

  throw('seq_region_name argument is required') if(!defined($seq_region_name));
172 173 174 175

  my $csa = $self->db()->get_CoordSystemAdaptor();
  my $coord_system = $csa->fetch_by_name($coord_system_name,$version);

176 177 178 179 180 181 182 183 184
  if(!$coord_system) {
    throw("Unknown coordinate system:\n name='$coord_system_name' " .
          "version='$version'\n");
  }
  if($coord_system->is_top_level()) {
    throw("Cannot fetch_by_region using the 'toplevel' pseudo coordinate " .
          "system.\n");
  }

185 186 187 188 189 190 191 192 193 194 195 196 197 198
  #check the cache so we only go to the db if necessary
  my $name_cache = $self->{'_name_cache'};
  my $key = lc(join(':',$seq_region_name,
                    $coord_system->name(),
                    $coord_system->version));

  my $length;

  if(exists($name_cache->{$key})) {
    $length = $name_cache->{$key}->[1];
  } else {
    my $sth = $self->prepare("SELECT seq_region_id, length " .
                             "FROM seq_region " .
                             "WHERE name = ? AND coord_system_id = ?");
Graham McVicker's avatar
Graham McVicker committed
199

200 201 202
    #force seq_region_name cast to string so mysql cannot treat as int
    $sth->execute("$seq_region_name", $coord_system->dbID());

203 204
    if($sth->rows() == 0) {
      $sth->finish();
Graham McVicker's avatar
Graham McVicker committed
205

206 207
      #do fuzzy matching, assuming that we are just missing a version on 
      #the end of the seq_region name
Graham McVicker's avatar
Graham McVicker committed
208

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
      $sth = $self->prepare("SELECT name, seq_region_id, length " .
                            "FROM   seq_region " .
                            "WHERE  name LIKE ?" .
                            "AND    coord_system_id = ?");

      $sth->execute("$seq_region_name.%", $coord_system->dbID());

      my $prefix_len = length($seq_region_name) + 1;
      my $highest_version = undef;

      # find the fuzzy-matched seq_region with the highest postfix (which ought
      # to be a version)

      my ($tmp_name, $id, $tmp_length);

      while(($tmp_name, $id, $tmp_length) = $sth->fetchrow_array()) {
        $key = lc(join(':',$tmp_name,
                       $coord_system->name(),
                       $coord_system->version));
        $name_cache->{$key}         = [$id,$tmp_length];
        $self->{'_id_cache'}->{$id} = [$tmp_name,$tmp_length,$coord_system];
Graham McVicker's avatar
Graham McVicker committed
230

231 232 233 234 235 236 237 238 239
        my $version = substr($tmp_name, $prefix_len);

        #skip versions which are non-numeric and apparently not versions
        next if($version !~ /^\d+$/);

        if(!defined($highest_version) || ($version <=> $highest_version) > 0) {
          $seq_region_name = $tmp_name;
          $length          = $tmp_length;
          $highest_version = $version;
Graham McVicker's avatar
Graham McVicker committed
240 241
        }
      }
242 243 244 245 246 247 248 249 250 251 252 253 254
      $sth->finish();

      #return if we did not find any appropriate match:
      return undef if(!defined($highest_version));
    } else {

      my $id;
      ($id, $length) = $sth->fetchrow_array();
      $sth->finish();

      #cache results to speed up future queries
      $name_cache->{$key}         = [$id,$length];
      $self->{'_id_cache'}->{$id} = [$seq_region_name, $length, $coord_system];
255
    }
256
  }
257

258
  $end = $length if(!defined($end));
Graham McVicker's avatar
Graham McVicker committed
259

260 261 262 263
  if($end < $start) {
    throw('start [$start] must be less than or equal to end [$end]');
  }

264 265 266 267 268 269 270
  return Bio::EnsEMBL::Slice->new(-COORD_SYSTEM      => $coord_system,
                                  -SEQ_REGION_NAME   => $seq_region_name,
                                  -SEQ_REGION_LENGTH => $length,
                                  -START             => $start,
                                  -END               => $end,
                                  -STRAND            => $strand,
                                  -ADAPTOR           => $self);
271 272 273 274
}



275
=head2 fetch_by_name
276

Graham McVicker's avatar
Graham McVicker committed
277
  Arg [1]    : string $name
278 279 280 281 282 283 284 285 286
  Example    : $name  = 'chromosome:NCBI34:X:1000000:2000000:1';
               $slice = $slice_adaptor->fetch_by_name($name);
               $slice2 = $slice_adaptor->fetch_by_name($slice3->name());
  Description: Fetches a slice using a slice name (i.e. the value returned by
               the Slice::name method).  This is useful if you wish to 
               store a unique identifier for a slice in a file or database or
               pass a slice over a network.
               Slice::name allows you to serialise/marshall a slice and this
               method allows you to deserialise/unmarshal it.
Graham McVicker's avatar
Graham McVicker committed
287

288 289 290 291
               Returns undef if no seq_region with the provided name exists in
               the database.

  Returntype : Bio::EnsEMBL::Slice or undef
292 293
  Exceptions : throw if incorrent arg provided
  Caller     : Pipeline
294 295 296

=cut

297 298 299
sub fetch_by_name {
  my $self = shift;
  my $name = shift;
Graham McVicker's avatar
Graham McVicker committed
300

301 302
  if(!$name) {
    throw("name argument is required");
Graham McVicker's avatar
Graham McVicker committed
303
  }
304 305 306 307 308

  my @array = split(/:/,$name);

  if(@array != 6) {
    throw("Malformed slice name [$name].  Format is " .
Laura Clarke's avatar
 
Laura Clarke committed
309
        "coord_system:version:name:start:end:strand");
310 311 312 313 314
  }

  my ($cs_name, $cs_version, $seq_region, $start, $end, $strand) = @array;

  return $self->fetch_by_region($cs_name,$seq_region, $start,
315
                                $end, $strand, $cs_version);
Graham McVicker's avatar
Graham McVicker committed
316
}
Graham McVicker's avatar
Graham McVicker committed
317 318 319



320 321 322 323 324 325 326 327
=head2 fetch_by_seq_region_id

  Arg [1]    : string $seq_region_id
               The internal identifier of the seq_region to create this slice
               on
  Example    : $slice = $slice_adaptor->fetch_by_seq_region_id(34413);
  Description: Creates a slice object of an entire seq_region using the
               seq_region internal identifier to resolve the seq_region.
328 329
               Returns undef if no such slice exists.
  Returntype : Bio::EnsEMBL::Slice or undef
Graham McVicker's avatar
Graham McVicker committed
330 331
  Exceptions : none
  Caller     : general
Graham McVicker's avatar
Graham McVicker committed
332 333 334

=cut

335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
sub fetch_by_seq_region_id {
  my ($self, $seq_region_id) = @_;

  my $id_cache = $self->{'_id_cache'};

  my ($name, $length, $cs);

  if(exists $id_cache->{$seq_region_id}) {
    ($name, $length, $cs) = @{$id_cache->{$seq_region_id}};
  } else {
    my $sth = $self->prepare("SELECT name, length, coord_system_id " .
                             "FROM seq_region " .
                             "WHERE seq_region_id = ?");

    $sth->execute($seq_region_id);

351
    return undef if($sth->rows() == 0);
352 353 354 355 356 357 358 359 360 361 362 363 364

    my $cs_id;
    ($name, $length, $cs_id) = $sth->fetchrow_array();
    $sth->finish();

    $cs = $self->db->get_CoordSystemAdaptor->fetch_by_dbID($cs_id);

    #cache results to speed up repeated queries
    $id_cache->{$seq_region_id} = [$name, $length, $cs];
    my $key = lc(join(':', $name, $cs->name, $cs->version));
    $self->{'_name_cache'}->{$key} = [$seq_region_id, $length];
  }

365 366 367 368 369 370 371
  return Bio::EnsEMBL::Slice->new(-COORD_SYSTEM      => $cs,
                                  -SEQ_REGION_NAME   => $name,
                                  -SEQ_REGION_LENGTH => $length,
                                  -START             => 1,
                                  -END               => $length,
                                  -STRAND            => 1,
                                  -ADAPTOR           => $self);
Arne Stabenau's avatar
Arne Stabenau committed
372 373
}

Graham McVicker's avatar
Graham McVicker committed
374

375 376

=head2 get_seq_region_id
Graham McVicker's avatar
Graham McVicker committed
377

Arne Stabenau's avatar
Arne Stabenau committed
378
  Arg [1]    : Bio::EnsEMBL::Slice $slice
379 380 381 382 383 384 385 386 387 388
               The slice to fetch a seq_region_id for
  Example    : $srid = $slice_adaptor->get_seq_region_id($slice);
  Description: Retrieves the seq_region id (in this database) given a slice
               Seq region ids are not stored on the slices themselves
               because they are intended to be somewhat database independant
               and seq_region_ids vary accross databases.
  Returntype : int
  Exceptions : throw if the seq_region of the slice is not in the db
               throw if incorrect arg provided
  Caller     : BaseFeatureAdaptor
Arne Stabenau's avatar
Arne Stabenau committed
389 390

=cut
Graham McVicker's avatar
Graham McVicker committed
391

392 393 394
sub get_seq_region_id {
  my $self = shift;
  my $slice = shift;
Graham McVicker's avatar
Graham McVicker committed
395

396 397 398 399 400 401 402 403 404
  if(!$slice || !ref($slice) || !$slice->isa('Bio::EnsEMBL::Slice')) {
    throw('Slice argument is required');
  }

  my $cs_name = $slice->coord_system->name();
  my $cs_version = $slice->coord_system->version();
  my $seq_region_name = $slice->seq_region_name();

  my $key = lc(join(':', $seq_region_name,$cs_name,$cs_version));
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 433 434 435 436 437
  my $name_cache = $self->{'_name_cache'};

  if(exists($name_cache->{$key})) {
    return $name_cache->{$key}->[0];
  }

  my $csa = $self->db()->get_CoordSystemAdaptor();
  my $coord_system = $csa->fetch_by_name($cs_name,$cs_version);

  my $sth = $self->prepare("SELECT seq_region_id, length " .
                           "FROM seq_region " .
                           "WHERE name = ? AND coord_system_id = ?");

  #force seq_region_name cast to string so mysql cannot treat as int
  $sth->execute("$seq_region_name", $coord_system->dbID());

  if($sth->rows() != 1) {
    throw("Non existant or ambigous seq_region:\n" .
          "  coord_system=[$cs_name],\n" .
          "  name=[$seq_region_name],\n" .
          "  version=[$cs_version]");
  }

  my($seq_region_id, $length) = $sth->fetchrow_array();
  $sth->finish();

  #cache information for future requests
  $name_cache->{$key} = [$seq_region_id, $length];
  $self->{'_id_cache'}->{$seq_region_id} =
    [$seq_region_name, $length, $coord_system];

  return $seq_region_id;
Arne Stabenau's avatar
Arne Stabenau committed
438
}
439 440


Arne Stabenau's avatar
Arne Stabenau committed
441

442 443 444 445 446 447 448 449 450
=head2 fetch_all

  Arg [1]    : string $coord_system_name
               The name of the coordinate system to retrieve slices of.
               This may be a name of an acutal coordinate system or an alias
               to a coordinate system.  Valid aliases are 'seqlevel' or
               'toplevel'.
  Arg [2]    : string $coord_system_version (optional)
               The version of the coordinate system to retrieve slices of
451
  Arg [3]    : bool $include_non_reference (optional)
452 453 454
               If this argument is not provided then only reference slices
               will be returned. If set, both reference and non refeference
               slices will be rerurned.
Graham McVicker's avatar
Graham McVicker committed
455 456
  Arg [4]    : int $include_duplicates (optional)
               If set duplicate regions will be returned.
457

458 459 460
  Example    : @chromos = @{$slice_adaptor->fetch_all('chromosome','NCBI33')};
               @contigs = @{$slice_adaptor->fetch_all('contig')};

Graham McVicker's avatar
Graham McVicker committed
461 462 463 464 465
               # get even non-reference regions
               @slices = @{$slice_adaptor->fetch_all('toplevel',undef,1)};

               # include duplicate regions (such as pseudo autosomal regions)
               @slices = @{$slice_adaptor->fetch_all('toplevel', undef,0,1)};
466 467 468 469 470 471

  Description: Retrieves slices of all seq_regions for a given coordinate
               system.  This is analagous to the methods fetch_all which were
               formerly on the ChromosomeAdaptor, RawContigAdaptor and
               CloneAdaptor classes.  Slices fetched span the entire
               seq_regions and are on the forward strand.
472 473
               If the coordinate system with the provided name and version
               does not exist an empty list is returned.
474
               If the coordinate system name provided is 'toplevel', all
475
               non-redundant toplevel slices are returned.
476 477 478 479

               Retrieved slices can be broken into smaller slices using the
               Bio::EnsEMBL::Utils::Slice module.

480
  Returntype : listref of Bio::EnsEMBL::Slices
481
  Exceptions : none
482
  Caller     : general
Web Admin's avatar
Web Admin committed
483 484 485

=cut

486 487 488 489 490
sub fetch_all {
  my $self = shift;
  my $cs_name = shift;
  my $cs_version = shift || '';

491
  my ($include_non_reference, $include_duplicates) = @_;
Web Admin's avatar
Web Admin committed
492

493 494 495
  #
  # verify existance of requested coord system and get its id
  #
496 497 498 499 500 501
  my $csa       = $self->db->get_CoordSystemAdaptor();
  my $orig_cs   = $csa->fetch_by_name($cs_name, $cs_version);

  return [] if(!$orig_cs);

  my $sth;
502

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
  my %bad_vals=();
  #
  # Get a hash of non reference seq regions
  #
  if(!$include_non_reference){
    my $sth2 = $self->prepare(
			      "SELECT sr.seq_region_id ".
			      "FROM seq_region sr, seq_region_attrib sra, attrib_type at ".
			      " WHERE at.code='non_ref'".
			      "  AND sra.seq_region_id=sr.seq_region_id ".
			      "  AND at.attrib_type_id=sra.attrib_type_id " );
    $sth2->execute();
    my ($seq_region_id);
    $sth2->bind_columns(\$seq_region_id);
    while($sth2->fetch()) {
      $bad_vals{$seq_region_id} = 1;
    }
    $sth2->finish();
  }
522
  #
523
  # Retrieve the seq_regions from the database
524
  #
525
  if($orig_cs->is_top_level()) {
526 527 528 529 530 531 532 533
   $sth =
       $self->prepare("SELECT sr.seq_region_id, sr.name, sr.length, " .
                      "       sr.coord_system_id " .
                      "FROM seq_region sr, " .
                      "     seq_region_attrib sra, attrib_type at " .
                      "WHERE at.code='toplevel' " .
                      "AND   at.attrib_type_id=sra.attrib_type_id " .
                      "AND   sra.seq_region_id=sr.seq_region_id");
534 535
    $sth->execute();
  } else {
536 537 538 539 540
     $sth =
       $self->prepare('SELECT seq_region_id, name, length, coord_system_id ' .
                      'FROM   seq_region ' .
                      'WHERE  coord_system_id =?');
     $sth->execute($orig_cs->dbID);
541
  }
542

543 544
  my ($seq_region_id, $name, $length, $cs_id);
  $sth->bind_columns(\$seq_region_id, \$name, \$length, \$cs_id);
545 546 547

  my $name_cache = $self->{'_name_cache'};
  my $id_cache   = $self->{'_id_cache'};
548
  my $cache_count = 0;
549 550 551

  my @out;
  while($sth->fetch()) {
552 553
    if(!defined($bad_vals{$seq_region_id})){
      my $cs = $csa->fetch_by_dbID($cs_id);
554

555
      if(!$cs) {
556
        throw("seq_region $name references non-existent coord_system $cs_id.");
557
      }
558

559
      my $cs_key = lc($cs->name().':'.$cs_version);
560

561 562 563
      #cache values for future reference, but stop adding to the cache once we
      #we know we have filled it up
      if($cache_count < $SEQ_REGION_CACHE_SIZE) {
564 565 566 567
        my $key = lc($name) . ':'. $cs_key;
        $name_cache->{$key} = [$seq_region_id, $length];
        $id_cache->{$seq_region_id} = [$name, $length, $cs];
        $cache_count++;
568
      }
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586

      my $slice = Bio::EnsEMBL::Slice->new
        (-START             => 1,
         -END               => $length,
         -STRAND            => 1,
         -SEQ_REGION_NAME   => $name,
         -SEQ_REGION_LENGTH => $length,
         -COORD_SYSTEM      => $cs,
         -ADAPTOR           => $self);

      if(!defined($include_duplicates) or !$include_duplicates){
        #do not include duplicates
        my @dup = @{$self->fetch_normalized_slice_projection($slice)};
        foreach my $dup_test( @dup){
          if($dup_test->[2]->get_seq_region_id == $slice->get_seq_region_id){
            push @out, $dup_test->[2];
          }
        }
587
      }
588 589
      else {
        push @out, $slice;
590
      }
591
    }
592
  }
593
  $sth->finish();
594

595
  return \@out;
Web Admin's avatar
Web Admin committed
596 597 598
}


599 600 601 602
sub deleteObj {
  my $self = shift;

  $self->SUPER::deleteObj;
603

604 605 606 607 608 609 610
  $self->{'_id_cache'} = {};
  $self->{'_name_cache'} = {};
  $self->{'_exc_cache'} = {};
}



Web Admin's avatar
Web Admin committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
=head2 fetch_by_band

 Title   : fetch_by_band
 Usage   :
 Function: create a Slice representing a series of bands
 Example :
 Returns :
 Args    : the band name

=cut

sub fetch_by_band {
  my ($self,$band) = @_;

  my $sth = $self->db->prepare
        ("select s.name,max(k.seq_region_id)-min(k.seq_region_id, min(k.seq_region_start), max(k.seq_region_id) " .
         "from karyotype as k " .
         "where k.band like ? and k.seq_region_id = s.seq_region_id");

  $sth->execute( "$band%" );
  my ( $seq_region_name, $discrepancy, $seq_region_start, $seq_region_end) = $sth->fetchrow_array;

  if($seq_region_name && $discrepancy>0) {
    throw("Band maps to multiple seq_regions");
  } else {
    return $self->fetch_by_region('toplevel',$seq_region_name,$seq_region_start,$seq_region_end);
  }
  throw("Band not recognised in database");
}

641 642 643 644 645 646 647 648 649 650 651 652 653 654
=head2 fetch_by_chr_band

 Title   : fetch_by_chr_band
 Usage   :
 Function: create a Slice representing a series of bands
 Example :
 Returns :
 Args    : the band name

=cut

sub fetch_by_chr_band {
  my ($self,$chr,$band) = @_;

Web Admin's avatar
Web Admin committed
655
  my $chr_slice = $self->fetch_by_region('toplevel', $chr);
656 657 658 659

  my $seq_region_id = $self->get_seq_region_id($chr_slice);

  my $sth = $self->db->prepare
Web Admin's avatar
Web Admin committed
660
        ("select min(k.seq_region_start), max(k.seq_region_end) " .
661 662 663 664 665 666 667
         "from karyotype as k " .
         "where k.seq_region_id = ? and k.band like ?");

  $sth->execute( $seq_region_id, "$band%" );
  my ( $slice_start, $slice_end) = $sth->fetchrow_array;

  if(defined $slice_start) {
Web Admin's avatar
Web Admin committed
668
    return $self->fetch_by_region('toplevel',$chr,$slice_start,$slice_end);
669 670 671
  }

  throw("Band not recognised in database");
672 673 674 675
}



Web Admin's avatar
Web Admin committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
=head2 fetch_by_exon_stable_id

  Arg [1]    : string $exonid
               The stable id of the exon around which the slice is 
               desired
  Arg [2]    : (optional) int $size
               The length of the flanking regions the slice should encompass 
               on either side of the exon (0 by default)
  Example    : $slc = $sa->fetch_by_exon_stable_id('ENSE00000302930',10);
  Description: Creates a slice around the region of the specified exon. 
               If a context size is given, the slice is extended by that 
               number of basepairs on either side of the
               transcript.
  Returntype : Bio::EnsEMBL::Slice
  Exceptions : Thrown if the exon is not in the database.
  Caller     : general

=cut

sub fetch_by_exon_stable_id{
  my ($self,$exonid,$size) = @_;

  throw('Exon argument is required.') if(!$exonid);

  my $ea = $self->db->get_ExonAdaptor;
  my $exon = $ea->fetch_by_stable_id($exonid);

  throw("Exon [$exonid] does not exist in DB.") if(!$exon);

  return $self->fetch_by_Feature($exon, $size);
}

Graham McVicker's avatar
Graham McVicker committed
708
=head2 fetch_by_transcript_stable_id
709

Graham McVicker's avatar
Graham McVicker committed
710 711 712 713 714 715 716 717 718
  Arg [1]    : string $transcriptid
               The stable id of the transcript around which the slice is 
               desired
  Arg [2]    : (optional) int $size
               The length of the flanking regions the slice should encompass 
               on either side of the transcript (0 by default)
  Example    : $slc = $sa->fetch_by_transcript_stable_id('ENST00000302930',10);
  Description: Creates a slice around the region of the specified transcript. 
               If a context size is given, the slice is extended by that 
719 720
               number of basepairs on either side of the
               transcript.
Graham McVicker's avatar
Graham McVicker committed
721
  Returntype : Bio::EnsEMBL::Slice
722
  Exceptions : Thrown if the transcript is not in the database.
Graham McVicker's avatar
Graham McVicker committed
723
  Caller     : general
724 725 726

=cut

Graham McVicker's avatar
Graham McVicker committed
727
sub fetch_by_transcript_stable_id{
728 729
  my ($self,$transcriptid,$size) = @_;

730 731
  throw('Transcript argument is required.') if(!$transcriptid);

732
  my $ta = $self->db->get_TranscriptAdaptor;
733
  my $transcript = $ta->fetch_by_stable_id($transcriptid);
734

735 736 737 738
  throw("Transcript [$transcriptid] does not exist in DB.") if(!$transcript);

  return $self->fetch_by_Feature($transcript, $size);
}
739

Graham McVicker's avatar
Graham McVicker committed
740 741


Graham McVicker's avatar
Graham McVicker committed
742 743
=head2 fetch_by_transcript_id

Graham McVicker's avatar
Graham McVicker committed
744 745 746 747 748 749 750
  Arg [1]    : int $transcriptid
               The unique database identifier of the transcript around which 
               the slice is desired
  Arg [2]    : (optional) int $size
               The length of the flanking regions the slice should encompass 
               on either side of the transcript (0 by default)
  Example    : $slc = $sa->fetch_by_transcript_id(24, 1000);
751 752 753 754
  Description: Creates a slice around the region of the specified transcript.
               If a context size is given, the slice is extended by that
               number of basepairs on either side of the
               transcript.
Graham McVicker's avatar
Graham McVicker committed
755
  Returntype : Bio::EnsEMBL::Slice
756 757
  Exceptions : throw on incorrect args
               throw if transcript is not in database
Graham McVicker's avatar
Graham McVicker committed
758
  Caller     : general
759 760 761

=cut

Graham McVicker's avatar
Graham McVicker committed
762
sub fetch_by_transcript_id {
763
  my ($self,$transcriptid,$size) = @_;
Graham McVicker's avatar
Graham McVicker committed
764

765
  throw('Transcript id argument is required.') if(!$transcriptid);
Graham McVicker's avatar
Graham McVicker committed
766

767 768 769 770 771 772
  my $transcript_adaptor = $self->db()->get_TranscriptAdaptor();
  my $transcript = $transcript_adaptor->fetch_by_dbID($transcriptid);

  throw("Transcript [$transcriptid] does not exist in DB.") if(!$transcript);

  return $self->fetch_by_Feature($transcript, $size);
773 774
}

775 776


Graham McVicker's avatar
Graham McVicker committed
777
=head2 fetch_by_gene_stable_id
778

Graham McVicker's avatar
Graham McVicker committed
779
  Arg [1]    : string $geneid
780
               The stable id of the gene around which the slice is
Graham McVicker's avatar
Graham McVicker committed
781 782
               desired
  Arg [2]    : (optional) int $size
Graham McVicker's avatar
Graham McVicker committed
783
               The length of the flanking regions the slice should encompass
Graham McVicker's avatar
Graham McVicker committed
784 785
               on either side of the gene (0 by default)
  Example    : $slc = $sa->fetch_by_transcript_stable_id('ENSG00000012123',10);
Graham McVicker's avatar
Graham McVicker committed
786 787 788
  Description: Creates a slice around the region of the specified gene.
               If a context size is given, the slice is extended by that
               number of basepairs on either side of the gene.
789
               The slice will be created in the genes native coordinate system.
Graham McVicker's avatar
Graham McVicker committed
790
  Returntype : Bio::EnsEMBL::Slice
791 792
  Exceptions : throw on incorrect args
               throw if transcript does not exist
Graham McVicker's avatar
Graham McVicker committed
793
  Caller     : general
794 795 796

=cut

797 798
sub fetch_by_gene_stable_id {
  my ($self,$geneid,$size) = @_;
799

800
  throw('Gene argument is required.') if(!$geneid);
801

802 803
  my $gene_adaptor = $self->db->get_GeneAdaptor();
  my $gene = $gene_adaptor->fetch_by_stable_id($geneid);
804

805
  throw("Gene [$geneid] does not exist in DB.") if(!$gene);
806

807
  return $self->fetch_by_Feature($gene, $size);
808 809 810
}


811

812
=head2 fetch_by_Feature
Graham McVicker's avatar
Graham McVicker committed
813

814 815 816 817
  Arg [1]    : Bio::EnsEMBL::Feature $feat
               The feature to fetch the slice around
  Arg [2]    : int size (optional)
               The desired number of flanking basepairs around the feature.
818 819
               The size may also be provided as a percentage of the feature 
               size such as 200% or 80.5%.
820 821 822 823 824 825
  Example    : $slice = $slice_adaptor->fetch_by_Feature($feat, 100);
  Description: Retrieves a slice around a specific feature.  All this really
               does is return a resized version of the slice that the feature
               is already on. Note that slices returned from this method
               are always on the forward strand of the seq_region regardless of
               the strandedness of the feature passed in.
Graham McVicker's avatar
Graham McVicker committed
826
  Returntype : Bio::EnsEMBL::Slice
827 828 829 830
  Exceptions : throw if the feature does not have an attached slice
               throw if feature argument is not provided
  Caller     : fetch_by_gene_stable_id, fetch_by_transcript_stable_id,
               fetch_by_gene_id, fetch_by_transcript_id
Graham McVicker's avatar
Graham McVicker committed
831 832 833

=cut

834 835
sub fetch_by_Feature{
  my ($self, $feature, $size) = @_;
Graham McVicker's avatar
Graham McVicker committed
836

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
  $size ||= 0;

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

  my $slice = $feature->slice();
  if(!$slice || !$slice->isa('Bio::EnsEMBL::Slice')) {
    throw('Feature must be attached to a valid slice.');
  }

  my $fstart = $feature->start();
  my $fend   = $feature->end();
  if(!defined($fstart) || !defined($fend)) {
    throw('Feature must have defined start and end.');
  }

  #convert the feature slice coordinates to seq_region coordinates
  my $slice_start  = $slice->start();
  my $slice_end    = $slice->end();
  my $slice_strand = $slice->strand();
  if($slice_start != 1 || $slice_strand != 1) {
    if($slice_strand == 1) {
      $fstart = $fstart + $slice_start - 1;
      $fend   = $fend   + $slice_start - 1;
    } else {
      my $tmp_start = $fstart;
      $fstart = $slice_end - $fend      + 1;
      $fend   = $slice_end - $tmp_start + 1;
    }
  }

869 870 871 872
  ## Size may be stored as a %age of the length of the feature
  ## Size = 100% gives no context
  ## Size = 200% gives context - 50% the size of the feature either side of 
  ## feature
Web Admin's avatar
Web Admin committed
873 874 875

  $size = int( ($1-100)/200 * ($fend-$fstart+1) ) if( $size =~/([\d+\.]+)%/ );

876
  #return a new slice covering the region of the feature
877 878 879 880 881 882 883 884
  return Bio::EnsEMBL::Slice->new
    (-seq_region_name   => $slice->seq_region_name,
     -seq_region_length => $slice->seq_region_length,
     -coord_system      => $slice->coord_system,
     -start             => $fstart - $size,
     -end               => $fend + $size,
     -strand            => 1,
     -adaptor           => $self);
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
}



=head2 fetch_by_misc_feature_attribute

  Arg [1]    : string $attribute_type
               The code of the attribute type
  Arg [2]    : (optional) string $attribute_value
               The value of the attribute to fetch by
  Arg [3]    : (optional) int $size
               The amount of flanking region around the misc feature desired.
  Example    : $slice = $sa->fetch_by_misc_feature_attribute('superctg',
                                                             'NT_030871');
               $slice = $sa->fetch_by_misc_feature_attribute('synonym',
                                                             'AL00012311',
                                                             $flanking);
  Description: Fetches a slice around a MiscFeature with a particular
               attribute type and value. If no value is specified then
               the feature with the particular attribute is used.
               If no size is specified then 0 is used.
  Returntype : Bio::EnsEMBL::Slice
  Exceptions : Throw if no feature with the specified attribute type and value
               exists in the database
               Warning if multiple features with the specified attribute type
               and value exist in the database.
  Caller     : webcode

=cut

sub fetch_by_misc_feature_attribute {
  my ($self, $attrib_type_code, $attrib_value, $size) = @_;
Graham McVicker's avatar
Graham McVicker committed
917

918
  my $mfa = $self->db()->get_MiscFeatureAdaptor();
Web Admin's avatar
Web Admin committed
919

920 921
  my $feats = $mfa->fetch_all_by_attribute_type_value($attrib_type_code,
                                                   $attrib_value);
Web Admin's avatar
Web Admin committed
922

923 924 925 926
  if(@$feats == 0) {
    throw("MiscFeature with $attrib_type_code=$attrib_value does " .
          "not exist in DB.");
  }
Graham McVicker's avatar
Graham McVicker committed
927

928 929 930 931
  if(@$feats > 1) {
    warning("MiscFeature with $attrib_type_code=$attrib_value is " .
            "ambiguous - using first one found.");
  }
932

933
  my ($feat) = @$feats;
934

935
  return $self->fetch_by_Feature($feat, $size);
Graham McVicker's avatar
Graham McVicker committed
936 937
}

938
=head2 fetch_normalized_slice_projection
Graham McVicker's avatar
Graham McVicker committed
939

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
  Arg [1]    : Bio::EnsEMBL::Slice $slice
  Example    :  ( optional )
  Description: gives back a project style result. The returned slices 
               represent the areas to which there are symlinks for the 
               given slice. start, end show which area on given slice is 
               symlinked
  Returntype : [[start,end,$slice][]]
  Exceptions : none
  Caller     : BaseFeatureAdaptor

=cut


sub fetch_normalized_slice_projection {
  my $self = shift;
  my $slice = shift;

  my $slice_seq_region_id = $self->get_seq_region_id( $slice );

  my $result = $self->{'asm_exc_cache'}->{$slice_seq_region_id};

  if(!defined($result)) {
    my $sql = "
      SELECT seq_region_id, seq_region_start, seq_region_end,
             exc_type, exc_seq_region_id, exc_seq_region_start,
             exc_seq_region_end
        FROM assembly_exception
       WHERE seq_region_id = ?";

    my $sth = $self->prepare( $sql );
    $sth->execute( $slice_seq_region_id );
    $result = $sth->fetchall_arrayref();
    $self->{'asm_exc_cache'}->{$slice_seq_region_id} = $result;
  }

  my (@haps, @pars);

  foreach my $row (@$result) {
    my ( $seq_region_id, $seq_region_start, $seq_region_end,
         $exc_type, $exc_seq_region_id, $exc_seq_region_start,
         $exc_seq_region_end ) = @$row;

    # need overlapping PAR and all HAPs if any
    if( $exc_type eq "PAR" ) {
      if( $seq_region_start <= $slice->end() && 
          $seq_region_end >= $slice->start() ) {
        push( @pars, [ $seq_region_start, $seq_region_end, $exc_seq_region_id,
                       $exc_seq_region_start, $exc_seq_region_end ] );
      }
    } else {
      push( @haps, [ $seq_region_start, $seq_region_end, $exc_seq_region_id,
                     $exc_seq_region_start, $exc_seq_region_end ] );
    }
  }

  if(!@pars && !@haps) {
    #just return this slice, there were no haps or pars
997
    return  [bless ( [1,$slice->length, $slice], "Bio::EnsEMBL::ProjectionSegment")];
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
  }

  my @syms;
  if( @haps > 1 ) {
    my @sort_haps = sort { $a->[1] <=> $b->[1] } @haps;
    throw( "More than one HAP region not supported yet" );
  } elsif( @haps == 1 ) {
    my $hap = $haps[0];

    my $seq_reg_slice = $self->fetch_by_seq_region_id($slice_seq_region_id);
    my $exc_slice = $self->fetch_by_seq_region_id( $hap->[2] );

    #
    # lengths of haplotype and reference in db may be different
    # we want to use the maximum possible length for the mapping
    # between the two systems
    #
    my $len1 = $seq_reg_slice->length();
    my $len2 = $exc_slice->length();
    my $max_len = ($len1 > $len2) ? $len1 : $len2;

    #the inserted region can differ in length, but mapped sections
    #need to be same lengths
    my $diff = $hap->[4] - $hap->[1];

    # we want the region of the haplotype INVERTED
    push( @syms, [ 1, $hap->[0]-1, $hap->[2], 1, $hap->[3] - 1 ] );
    push( @syms, [ $hap->[1]+1, $max_len - $diff, 
                   $hap->[2], $hap->[4] + 1, $max_len ] );   
  }

  # for now haps and pars should not be both there, but in theory we 
  # could handle it here by cleverly merging the pars into the existing syms,
  # for now just:
  push( @syms, @pars );

  my $mapper = Bio::EnsEMBL::Mapper->new( "sym", "org" );
  for my $sym ( @syms ) {
    $mapper->add_map_coordinates( $slice_seq_region_id, $sym->[0], $sym->[1],
                                  1, $sym->[2], $sym->[3], $sym->[4] );
  }
1039

1040 1041 1042
  my @linked = $mapper->map_coordinates( $slice_seq_region_id,
                                         $slice->start(), $slice->end(),
                                         $slice->strand(), "sym" );
1043

1044 1045 1046 1047 1048 1049
  # gaps are regions where there is no mapping to another region
  my $rel_start = 1;

  #if there was only one coord and it is a gap, we know it is just the
  #same slice with no overlapping symlinks
  if(@linked == 1 && $linked[0]->isa('Bio::EnsEMBL::Mapper::Gap')) {
1050
    return [bless( [1,$slice->length, $slice], "Bio::EnsEMBL::ProjectionSegment" )];
1051 1052 1053 1054 1055 1056
  }

  my @out;
  for my $coord ( @linked ) {
    if( $coord->isa( "Bio::EnsEMBL::Mapper::Gap" )) {
      my $exc_slice = Bio::EnsEMBL::Slice->new
1057 1058 1059 1060 1061 1062 1063
        (-START             => $coord->start(),
         -END               => $coord->end(),
         -STRAND            => $slice->strand(),
         -COORD_SYSTEM      => $slice->coord_system(),
         -ADAPTOR           => $self,
         -SEQ_REGION_NAME   => $slice->seq_region_name(),
         -SEQ_REGION_LENGTH => $slice->seq_region_length());
1064 1065
      push( @out, bless ( [ $rel_start, $coord->length()+$rel_start-1,
                        $exc_slice ], "Bio::EnsEMBL::ProjectionSegment") );
1066 1067 1068 1069
    } else {
      my $exc_slice = $self->fetch_by_seq_region_id( $coord->id() );
      my $exc2_slice = Bio::EnsEMBL::Slice->new
        (
1070 1071 1072 1073 1074 1075 1076
         -START             => $coord->start(),
         -END               => $coord->end(),
         -STRAND            => $coord->strand(),
         -SEQ_REGION_NAME   => $exc_slice->seq_region_name(),
         -SEQ_REGION_LENGTH => $exc_slice->seq_region_length(),
         -COORD_SYSTEM      => $exc_slice->coord_system(),
         -ADAPTOR           => $self
1077 1078
        );
	
1079 1080
      push( @out, bless( [ $rel_start, $coord->length() + $rel_start - 1,
                    $exc2_slice ], "Bio::EnsEMBL::ProjectionSegment") );
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
    }
    $rel_start += $coord->length();
  }

  return \@out;
}




=head2 store

  Arg [1]    : Bio::EnsEMBL::Slice $slice
  Arg [2]    : (optional) $seqref reference to a string
               The sequence associated with the slice to be stored.
  Example    : $slice = Bio::EnsEMBL::Slice->new(...);
               $seq_region_id = $slice_adaptor->store($slice, \$sequence);
  Description: This stores a slice as a sequence region in the database
               and returns the seq region id. The passed in slice must
               start at 1, and must have a valid seq_region name and coordinate
               system. The attached coordinate system must already be stored in
               the database.  The sequence region is assumed to start at 1 and
1103 1104
               to have a length equalling the length of the slice.  The end of
               the slice must equal the seq_region_length.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
               If the slice coordinate system is the sequence level coordinate
               system then the seqref argument must also be passed.  If the
               slice coordinate system is NOT a sequence level coordinate
               system then the sequence argument cannot be passed.
  Returntype : int 
  Exceptions : throw if slice has no coord system.
               throw if slice coord system is not already stored.
               throw if slice coord system is seqlevel and no sequence is 
                     provided.
               throw if slice coord system is not seqlevel and sequence is
                     provided.
               throw if slice does not start at 1
               throw if sequence is provided and the sequence length does not
                     match the slice length.
               throw if the SQL insert fails (e.g. on duplicate seq region)
               throw if slice argument is not passed
1121
               throw if the slice end is not equal to seq_region_length
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
  Caller     : database loading scripts

=cut



sub store {
  my $self = shift;
  my $slice = shift;
  my $seqref = shift;

  #
  # Get all of the sanity checks out of the way before storing anything
  #

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

  my $cs = $slice->coord_system();
  throw("Slice must have attached CoordSystem.") if(!$cs);

  my $db = $self->db();
  if(!$cs->is_stored($db)) {
    throw("Slice CoordSystem must already be stored in DB.") 
  }

  if($slice->start != 1 || $slice->strand != 1) {
    throw("Slice must have start==1 and strand==1.");
  }

1153 1154 1155 1156
  if($slice->end() != $slice->seq_region_length()) {
    throw("Slice must have end==seq_region_length");
  }

Arne Stabenau's avatar