Translation.pm 33.3 KB
Newer Older
1 2
=head1 LICENSE

3
Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
4

5 6 7 8 9 10 11 12 13 14 15 16 17
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

=cut
18 19 20 21 22


=head1 CONTACT

  Please email comments or questions to the public Ensembl
Magali Ruffier's avatar
Magali Ruffier committed
23
  developers list at <http://lists.ensembl.org/mailman/listinfo/dev>.
24 25

  Questions may also be sent to the Ensembl help desk at
Magali Ruffier's avatar
Magali Ruffier committed
26
  <http://www.ensembl.org/Help/Contact>.
27 28

=cut
Ewan Birney's avatar
Ewan Birney committed
29 30 31

=head1 NAME

32 33
Bio::EnsEMBL::Translation - A class representing the translation of a
transcript
Ewan Birney's avatar
Ewan Birney committed
34 35 36

=head1 SYNOPSIS

Patrick Meidl's avatar
Patrick Meidl committed
37 38 39 40 41 42 43 44 45 46 47 48
  my $translation = Bio::EnsEMBL::Translation->new(
    -START_EXON => $exon1,
    -END_EXON   => $exon2,
    -SEQ_START  => 98,
    -SEQ_END    => 39
  );

  # stable ID setter
  $translation->stable_id('ENSP00053458');

  # get start and end position in start/end exons
  my $start = $translation->start;
49
  my $end   = $translation->end;
50

Ewan Birney's avatar
Ewan Birney committed
51 52
=head1 DESCRIPTION

53
A Translation object defines the CDS and UTR regions of a Transcript
54
through the use of start_Exon/end_Exon, and start/end attributes.
Ewan Birney's avatar
Ewan Birney committed
55 56 57 58

=cut


59 60
package Bio::EnsEMBL::Translation;

Ewan Birney's avatar
Ewan Birney committed
61 62 63
use vars qw($AUTOLOAD @ISA);
use strict;

64 65
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw( rearrange );
66
use Bio::EnsEMBL::Utils::Scalar qw( assert_ref wrap_array );
67
use Scalar::Util qw(weaken);
Ewan Birney's avatar
Ewan Birney committed
68

69
use Bio::EnsEMBL::Storable;
Ewan Birney's avatar
Ewan Birney committed
70

71
@ISA = qw(Bio::EnsEMBL::Storable);
Ewan Birney's avatar
Ewan Birney committed
72 73


74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
=head2 new

  Arg [-START_EXON] : The Exon object in which the translation (CDS) starts
  Arg [-END_EXON]   : The Exon object in which the translation (CDS) ends
  Arg [-SEQ_START]  : The offset in the start_Exon indicating the start
                      position of the CDS.
  Arg [-SEQ_END]    : The offset in the end_Exon indicating the end
                      position of the CDS.
  Arg [-STABLE_ID]  : The stable identifier for this Translation
  Arg [-VERSION]    : The version of the stable identifier
  Arg [-DBID]       : The internal identifier of this Translation
  Arg [-ADAPTOR]    : The TranslationAdaptor for this Translation
  Arg [-SEQ]        : Manually sets the peptide sequence of this translation.
                      May be useful if this translation is not stored in
                      a database.
89 90
  Arg [-CREATED_DATE]: the date the translation was created
  Arg [-MODIFIED_DATE]: the date the translation was modified
91 92 93 94 95 96 97 98 99
  Example    : my $tl = Bio::EnsEMBL::Translation->new
                   (-START_EXON => $ex1,
                    -END_EXON   => $ex2,
                    -SEQ_START  => 98,
                    -SEQ_END    => 39);
  Description: Constructor.  Creates a new Translation object
  Returntype : Bio::EnsEMBL::Translation
  Exceptions : none
  Caller     : general
100
  Status     : Stable
101 102 103

=cut

104
sub new {
Graham McVicker's avatar
Graham McVicker committed
105
  my $caller = shift;
106

Graham McVicker's avatar
Graham McVicker committed
107
  my $class = ref($caller) || $caller;
Ewan Birney's avatar
Ewan Birney committed
108

109
  my ( $start_exon, $end_exon, $seq_start, $seq_end,
110
       $stable_id, $version, $dbID, $adaptor, $seq,
111 112 113 114
       $created_date, $modified_date ) =
	   rearrange( [ "START_EXON", "END_EXON", "SEQ_START", "SEQ_END",
			"STABLE_ID", "VERSION", "DBID", "ADAPTOR",
			"SEQ", "CREATED_DATE", "MODIFIED_DATE" ], @_ );
115 116 117

  my $self = bless {
		    'start_exon' => $start_exon,
118 119 120 121 122 123
		    'end_exon'   => $end_exon,
		    'dbID'       => $dbID,
		    'start'      => $seq_start,
		    'end'        => $seq_end,
		    'stable_id'  => $stable_id,
		    'version'    => $version,
124 125
		    'created_date' => $created_date,
		    'modified_date' => $modified_date,
Monika Komorowska's avatar
Monika Komorowska committed
126
                    'seq'        => $seq
127 128
		   }, $class;

Monika Komorowska's avatar
Monika Komorowska committed
129 130
  $self->adaptor($adaptor);

131
  return $self;
Ewan Birney's avatar
Ewan Birney committed
132 133
}

134 135


136 137 138 139 140 141 142
=head2 transcript

  Arg [1]       : Transcript object (optional)
  Description   : Sets or retrieves the transcript object associated
                  with this translation object.
  Exceptions    : Throws if there is no adaptor or no dbID defined for
                  the translation object.
143
  Returntype    : Bio::EnsEMBL::Transcript
144 145
=cut

146 147 148 149
sub transcript {
  my ( $self, $transcript ) = @_;

  if ( defined($transcript) ) {
150
    assert_ref( $transcript, 'Bio::EnsEMBL::Transcript' );
151 152 153

    $self->{'transcript'} = $transcript;

154
    weaken( $self->{'transcript'} );    # Avoid circular references.
155

156 157 158
  } elsif ( @_ > 1 ) {
    # Break connection to transcript.
    delete( $self->{'transcript'} );
159
  } elsif ( !defined( $self->{'transcript'} ) ) {
Monika Komorowska's avatar
Monika Komorowska committed
160
    my $adaptor = $self->adaptor;
161
    if ( !defined($adaptor) ) {
162
      throw(   "Adaptor is not set for translation, "
163
             . "can not fetch its transcript." );
164 165 166 167
    }

    my $dbID = $self->{'dbID'};
    if ( !defined($dbID) ) {
168 169
      throw(   "dbID is not set for translation, "
             . " can not fetch its transcript." );
170 171 172 173 174
    }

    $self->{'transcript'} =
      $adaptor->db()->get_TranscriptAdaptor()
      ->fetch_by_translation_id($dbID);
175

176 177 178 179
  # Do not weaken the reference if we had to get the transcript from the
  # database.  The user is probably working on translations directly,
  # not going through transcripts.
  #weaken( $self->{'transcript'} );    # Avoid circular references.
180 181 182
  }

  return $self->{'transcript'};
183
} ## end sub transcript
184

Ewan Birney's avatar
Ewan Birney committed
185 186 187

=head2 start

Patrick Meidl's avatar
Patrick Meidl committed
188 189 190 191 192
  Arg [1]    : (optional) int $start - start position to set
  Example    : $translation->start(17);
  Description: Getter/setter for the value of start, which is a position within
               the exon given by start_Exon.

193 194
               If you need genomic coordinates, use the genomic_start()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
195 196 197 198
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
199 200 201 202 203 204 205

=cut

sub start{
   my $obj = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
206
      
Ewan Birney's avatar
Ewan Birney committed
207 208 209 210 211 212 213
      $obj->{'start'} = $value;
    }
    return $obj->{'start'};

}


214 215
=head2 end

Patrick Meidl's avatar
Patrick Meidl committed
216 217 218 219
  Arg [1]    : (optional) int $end - end position to set
  Example    : $translation->end(8);
  Description: Getter/setter for the value of end, which is a position within
               the exon given by end_Exon.
220

221 222
               If you need genomic coordinates, use the genomic_end()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
223 224 225 226
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
227 228 229 230 231 232 233

=cut

sub end {
   my $self = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
234
      
235 236 237 238 239 240 241
      $self->{'end'} = $value;
    }
    return $self->{'end'};

}


Graham McVicker's avatar
Graham McVicker committed
242
=head2 start_Exon
243

Patrick Meidl's avatar
Patrick Meidl committed
244 245 246 247 248 249 250 251 252
  Arg [1]    : (optional) Bio::EnsEMBL::Exon - start exon to assign
  Example    : $translation->start_Exon($exon1);
  Description: Getter/setter for the value of start_Exon, which denotes the
               exon at which translation starts (and within this exon, at the
               position indicated by start, see above).
  Returntype : Bio::EnsEMBL::Exon
  Exceptions : thrown on wrong argument type
  Caller     : general
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
253 254 255

=cut

Graham McVicker's avatar
Graham McVicker committed
256
sub start_Exon {
257
   my $self = shift;
258

Ewan Birney's avatar
Ewan Birney committed
259 260
   if( @_ ) {
      my $value = shift;
261
      if( !ref $value || !$value->isa('Bio::EnsEMBL::Exon') ) {
262
         throw("Got to have an Exon object, not a $value");
263 264
      }
      $self->{'start_exon'} = $value;
Ewan Birney's avatar
Ewan Birney committed
265
    }
266
   return $self->{'start_exon'};
Ewan Birney's avatar
Ewan Birney committed
267 268 269
}


Graham McVicker's avatar
Graham McVicker committed
270
=head2 end_Exon
271

Patrick Meidl's avatar
Patrick Meidl committed
272 273 274 275 276 277 278 279 280
  Arg [1]    : (optional) Bio::EnsEMBL::Exon - start exon to assign
  Example    : $translation->start_Exon($exon1);
  Description: Getter/setter for the value of end_Exon, which denotes the
               exon at which translation ends (and within this exon, at the
               position indicated by end, see above).
  Returntype : Bio::EnsEMBL::Exon
  Exceptions : thrown on wrong argument type
  Caller     : general
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
281 282 283

=cut

Graham McVicker's avatar
Graham McVicker committed
284
sub end_Exon {
285
   my $self = shift;
Ewan Birney's avatar
Ewan Birney committed
286 287
   if( @_ ) {
      my $value = shift;
288
      if( !ref $value || !$value->isa('Bio::EnsEMBL::Exon') ) {
289
         throw("Got to have an Exon object, not a $value");
290 291
      }
      $self->{'end_exon'} = $value;
292
    } 
Ewan Birney's avatar
Ewan Birney committed
293

294
    return $self->{'end_exon'};
Ewan Birney's avatar
Ewan Birney committed
295 296
}

297 298
=head2 cdna_start

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
299 300
    Arg  [1]    : (optional) Bio::EnsEMBL::Transcript $transcript
                  The transcript which this is a translation of.
301 302 303
    Example     : $translation_cdna_start = $translation->cdna_start();
    Description : Returns the start position of the translation in cDNA
                  coordinates.
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
304 305 306
                  If no transcript is given, the method will use
                  TranscriptAdaptor->fetch_by_translation_id() to locate
                  the correct transcript.
307 308 309 310 311 312 313 314 315
    Return type : Integer
    Exceptions  : Throws if the given (optional) argument is not a
                  transcript.
    Caller      : General
    Status      : At Risk (Under Development)

=cut

sub cdna_start {
316
  my ( $self, $transcript ) = @_;
317

318 319 320 321 322 323
  if ( defined($transcript)
       && (    !ref($transcript)
            || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
  {
    throw("Argument is not a transcript");
  }
324

325 326 327 328 329
  if ( !exists( $self->{'cdna_start'} ) ) {
    if ( !defined($transcript) ) {
      # We were not given a transcript, get the transcript out of
      # the database.
      $transcript = $self->transcript();
330 331
    }

332 333 334 335 336 337
    $self->{'cdna_start'} =
      $self->start_Exon()->cdna_coding_start($transcript);
  }

  return $self->{'cdna_start'};
}
338 339 340

=head2 cdna_end

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
341 342
    Arg  [1]    : (optional) Bio::EnsEMBL::Transcript $transcript
                  The transcript which this is a translation of.
343 344 345
    Example     : $translation_cdna_end = $translation->cdna_end();
    Description : Returns the end position of the translation in cDNA
                  coordinates.
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
346 347 348
                  If no transcript is given, the method will use
                  TranscriptAdaptor->fetch_by_translation_id() to locate
                  the correct transcript.
349 350 351 352 353 354 355 356 357
    Return type : Integer
    Exceptions  : Throws if the given (optional) argument is not a
                  transcript.
    Caller      : General
    Status      : At Risk (Under Development)

=cut

sub cdna_end {
358
  my ( $self, $transcript ) = @_;
359

360 361 362 363 364 365
  if ( defined($transcript)
       && (    !ref($transcript)
            || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
  {
    throw("Argument is not a transcript");
  }
366

367 368 369 370 371
  if ( !exists( $self->{'cdna_end'} ) ) {
    if ( !defined($transcript) ) {
      # We were not given a transcript, get the transcript out of
      # the database.
      $transcript = $self->transcript();
372 373
    }

374 375 376 377 378 379
    $self->{'cdna_end'} =
      $self->end_Exon()->cdna_coding_end($transcript);
  }

  return $self->{'cdna_end'};
}
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438

=head2 genomic_start

    Args        : None
    Example     : $translation_genomic_start =
                      $translation->genomic_start();
    Description : Returns the start position of the translation in
                  genomic coordinates on the forward strand.
    Return type : Integer
    Exceptions  : None
    Caller      : General
    Status      : At Risk (Under Development)

=cut

sub genomic_start {
    my $self = shift;

    if ( !exists $self->{'genomic_start'} ) {
        if ( $self->start_Exon()->strand() >= 0 ) {
            $self->{'genomic_start'} =
              $self->start_Exon()->start() + ( $self->start() - 1 );
        } else {
            $self->{'genomic_start'} =
              $self->end_Exon()->end() - ( $self->end() - 1 );
        }
    }

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

=head2 genomic_end

    Args        : None
    Example     : $translation_genomic_end = $translation->genomic_end();
    Description : Returns the end position of the translation in genomic
                  coordinates on the forward strand.
    Return type : Integer
    Exceptions  : None
    Caller      : General
    Status      : At Risk (Under Development)

=cut

sub genomic_end {
    my $self = shift;

    if ( !exists $self->{'genomic_end'} ) {
        if ( $self->end_Exon()->strand() >= 0 ) {
            $self->{'genomic_end'} =
              $self->end_Exon()->start() + ( $self->end() - 1 );
        } else {
            $self->{'genomic_end'} =
              $self->start_Exon()->end() - ( $self->start() - 1 );
        }
    }

    return $self->{'genomic_end'};
}
Ewan Birney's avatar
Ewan Birney committed
439

440
=head2 version
441

Patrick Meidl's avatar
Patrick Meidl committed
442 443 444
  Arg [1]    : (optional) string $version - version to set
  Example    : $translation->version(2);
  Description: Getter/setter for attribute version
445 446 447
  Returntype : string
  Exceptions : none
  Caller     : general
448
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
449 450 451

=cut

452
sub version {
453
   my $self = shift;
454 455
  $self->{'version'} = shift if( @_ );
  return $self->{'version'};
Ewan Birney's avatar
Ewan Birney committed
456
}
457 458


459
=head2 stable_id
Graham McVicker's avatar
Graham McVicker committed
460

Patrick Meidl's avatar
Patrick Meidl committed
461 462 463
  Arg [1]    : (optional) string $stable_id - stable ID to set
  Example    : $translation->stable_id('ENSP0059890');
  Description: Getter/setter for attribute stable_id
464 465 466
  Returntype : string
  Exceptions : none
  Caller     : general
467
  Status     : Stable
468 469 470

=cut

471
sub stable_id {
472
   my $self = shift;
473 474
  $self->{'stable_id'} = shift if( @_ );
  return $self->{'stable_id'};
475 476
}

477 478
=head2 created_date

Patrick Meidl's avatar
Patrick Meidl committed
479 480 481
  Arg [1]    : (optional) string $created_date - created date to set
  Example    : $translation->created_date('2007-01-10 20:52:00');
  Description: Getter/setter for attribute created date
482 483 484 485 486 487 488
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

489 490 491 492 493 494 495
sub created_date {
  my $self = shift;
  $self->{'created_date'} = shift if ( @_ );
  return $self->{'created_date'};
}


496 497
=head2 modified_date

Patrick Meidl's avatar
Patrick Meidl committed
498 499 500
  Arg [1]    : (optional) string $modified_date - modification date to set
  Example    : $translation->modified_date('2007-01-10 20:52:00');
  Description: Getter/setter for attribute modified date
501 502 503 504 505 506 507
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

508 509 510 511 512 513
sub modified_date {
  my $self = shift;
  $self->{'modified_date'} = shift if ( @_ );
  return $self->{'modified_date'};
}

514

Graham McVicker's avatar
Graham McVicker committed
515

516 517
=head2 transform

Patrick Meidl's avatar
Patrick Meidl committed
518 519 520 521
  Arg [1]    : hashref $old_new_exon_map
               a hash that maps old to new exons for a whole gene
  Description: maps start end end exon according to mapping table.
              If an exon is not mapped, just keep the old one.
522
  Returntype : none
Patrick Meidl's avatar
Patrick Meidl committed
523 524
  Exceptions : none
  Caller     : Transcript->transform() 
525
  Status     : Stable
526 527 528 529 530 531 532

=cut

sub transform {
  my $self = shift;
  my $href_exons = shift;

Graham McVicker's avatar
Graham McVicker committed
533 534
  my $start_exon = $self->start_Exon();
  my $end_exon = $self->end_Exon();
535

Arne Stabenau's avatar
Arne Stabenau committed
536 537
  if ( exists $href_exons->{$start_exon} ) {
    $self->start_Exon($href_exons->{$start_exon});
538 539
  } else {
    # do nothing, the start exon wasnt mapped
540 541
  }

Arne Stabenau's avatar
Arne Stabenau committed
542 543
  if ( exists $href_exons->{$end_exon} ) {
    $self->end_Exon($href_exons->{$end_exon});
544 545
  } else { 
    # do nothing, the end exon wasnt mapped
546 547 548
  }
}

549 550 551

=head2 get_all_DBEntries

552 553 554 555 556 557 558 559 560 561 562 563 564 565
  Arg [1]    : (optional) String, external database name

  Arg [2]    : (optional) String, external_db type

  Example    : @dbentries = @{ $translation->get_all_DBEntries() };

  Description: Retrieves DBEntries (xrefs) for this translation.

               This method will attempt to lazy-load DBEntries
               from a database if an adaptor is available and no
               DBEntries are present on the translation (i.e. they
               have not already been added or loaded).

  Returntype : Listref to Bio::EnsEMBL::DBEntry objects
566
  Exceptions : none
567
  Caller     : TranslationAdaptor::store
568
  Status     : Stable
569 570 571 572

=cut

sub get_all_DBEntries {
573
  my ( $self, $ex_db_exp, $ex_db_type ) = @_;
574

575
  my $cache_name = 'dbentries';
576

577
  if ( defined($ex_db_exp) ) {
578 579
    $cache_name .= $ex_db_exp;
  }
580 581

  if ( defined($ex_db_type) ) {
Ian Longden's avatar
Ian Longden committed
582
    $cache_name .= $ex_db_type;
583
  }
584

585 586 587
  # if not cached, retrieve all of the xrefs for this translation
  if ( !defined( $self->{$cache_name} ) && defined( $self->adaptor() ) )
  {
588
    $self->{$cache_name} =
589 590
      $self->adaptor()->db()->get_DBEntryAdaptor()
      ->fetch_all_by_Translation( $self, $ex_db_exp, $ex_db_type );
591 592
  }

593
  $self->{$cache_name} ||= [];
594

595
  return $self->{$cache_name};
596
} ## end sub get_all_DBEntries
597

598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
=head2 get_all_object_xrefs

  Arg [1]    : (optional) String, external database name

  Arg [2]    : (optional) String, external_db type

  Example    : @oxrefs = @{ $translation->get_all_object_xrefs() };

  Description: Retrieves xrefs for this translation.

               This method will attempt to lazy-load xrefs from a
               database if an adaptor is available and no xrefs
               are present on the translation (i.e. they have not
               already been added or loaded).

613 614
                NB: This method is an alias for the
                    get_all_DBentries() method.
615 616 617 618 619 620 621

  Return type: Listref of Bio::EnsEMBL::DBEntry objects

  Status     : Stable

=cut

622 623 624 625
sub get_all_object_xrefs {
      my $self = shift;
            return $self->get_all_DBEntries(@_);
}
626 627 628 629 630

=head2 add_DBEntry

  Arg [1]    : Bio::EnsEMBL::DBEntry $dbe
               The dbEntry to be added
Patrick Meidl's avatar
Patrick Meidl committed
631 632 633 634
  Example    : $translation->add_DBEntry($xref);
  Description: Associates a DBEntry with this translation. Note that adding
               DBEntries will prevent future lazy-loading of DBEntries for this
               translation (see get_all_DBEntries).
635 636 637
  Returntype : none
  Exceptions : thrown on incorrect argument type
  Caller     : general
638
  Status     : Stable
639 640 641 642 643 644 645 646

=cut

sub add_DBEntry {
  my $self = shift;
  my $dbe = shift;

  unless($dbe && ref($dbe) && $dbe->isa('Bio::EnsEMBL::DBEntry')) {
647
    throw('Expected DBEntry argument');
648 649 650 651 652 653 654
  }

  $self->{'dbentries'} ||= [];
  push @{$self->{'dbentries'}}, $dbe;
}


Stephen Keenan's avatar
Stephen Keenan committed
655 656
=head2 get_all_DBLinks

657 658 659 660 661 662 663 664 665 666 667 668
  Arg [1]    : String database name (optional)
               SQL wildcard characters (_ and %) can be used to
               specify patterns.

  Example    :  my @dblinks = @{ $translation->get_all_DBLinks() };
                my @dblinks = @{ $translation->get_all_DBLinks('Uniprot%') };

  Description: This is here for consistancy with the Transcript
               and Gene classes.  It is a synonym for the
               get_all_DBEntries() method.

  Return type: Listref to Bio::EnsEMBL::DBEntry objects
669 670
  Exceptions : none
  Caller     : general
671
  Status     : Stable
Stephen Keenan's avatar
Stephen Keenan committed
672 673 674 675 676

=cut

sub get_all_DBLinks {
  my $self = shift;
677
  return $self->get_all_DBEntries(@_);
Stephen Keenan's avatar
Stephen Keenan committed
678 679
}

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
=head2 get_all_xrefs

  Arg [1]    : String database name (optional)
               SQL wildcard characters (_ and %) can be used to
               specify patterns.

  Example    : @xrefs = @{ $translation->get_all_xrefs() };
               @xrefs = @{ $translation->get_all_xrefs('Uniprot%') };

  Description: This method is here for consistancy with the Gene
               and Transcript classes.  It is an alias for the
               get_all_DBLinks() method, which in turn directly
               calls get_all_DBEntries().

  Return type: Listref of Bio::EnsEMBL::DBEntry objects

  Status     : Stable

=cut

700 701 702 703
sub get_all_xrefs {
  my $self = shift;
  return $self->get_all_DBLinks(@_);
}
704

705 706 707 708 709
=head2 get_all_ProteinFeatures

  Arg [1]    : (optional) string $logic_name
               The analysis logic_name of the features to retrieve.  If not
               specified, all features are retrieved instead.
710
               If no logic_name is found, looking for analysis db name instead.
711 712 713 714 715
  Example    : $features = $self->get_all_ProteinFeatures('PFam');
  Description: Retrieves all ProteinFeatures associated with this 
               Translation. If a logic_name is specified, only features with 
               that logic_name are returned.  If no logic_name is provided all
               associated protein_features are returned.
716 717 718

               ProteinFeatures are lazy-loaded from the database unless they
               added manually to the Translation or had already been loaded.
Kieron Taylor's avatar
Kieron Taylor committed
719
  Returntype : Listref of Bio::EnsEMBL::ProteinFeature
720 721
  Exceptions : none
  Caller     : general
722
  Status     : Stable
723 724 725 726 727 728 729

=cut

sub get_all_ProteinFeatures {
  my $self = shift;
  my $logic_name = shift;

730 731 732
  my (%hash, %db_hash);
  my $no_pf = 0;

733
  if(!$self->{'protein_features'}) {
734
    $no_pf = 1;
735 736
    my $adaptor = $self->adaptor();
    my $dbID    = $self->dbID();
737 738

    return [] if (!$adaptor || !$dbID);
739 740 741 742

    $self->{'protein_features'} = \%hash;

    my $pfa = $adaptor->db()->get_ProteinFeatureAdaptor();
743
    my ($name, $ana_db);
744 745 746
    foreach my $f (@{$pfa->fetch_all_by_translation_id($dbID)}) {
      my $analysis = $f->analysis();
      if($analysis) {
747
        $name = lc($f->analysis->logic_name());
748 749
        $ana_db = lc($f->analysis->db());
        $db_hash{$ana_db} = $name;
750
      } else {
751 752
        warning("ProteinFeature has no attached analysis\n");
        $name = '';
753 754 755 756 757 758
      }
      $hash{$name} ||= [];
      push @{$hash{$name}}, $f;
    }
  }

Patrick Meidl's avatar
Patrick Meidl committed
759
  # a specific type of protein feature was requested
760 761
  if(defined($logic_name)) {
    $logic_name = lc($logic_name);
762 763 764
    if (!$hash{$logic_name} && $no_pf) {
      $logic_name = $db_hash{$logic_name};
    }
765 766 767
    return $self->{'protein_features'}->{$logic_name} || [];
  }

768
  my @features = ();
769

Patrick Meidl's avatar
Patrick Meidl committed
770
  # all protein features were requested
771 772 773 774 775 776 777 778 779 780 781 782 783 784
  foreach my $type (keys %{$self->{'protein_features'}}) {
    push @features, @{$self->{'protein_features'}->{$type}};
  }

  return \@features;    
}


=head2 get_all_DomainFeatures

  Example    : @domain_feats = @{$translation->get_all_DomainFeatures};
  Description: A convenience method which retrieves all protein features
               that are considered to be 'Domain' features.  Features which
               are 'domain' features are those with analysis logic names:
Patrick Meidl's avatar
Patrick Meidl committed
785 786
               'pfscan', 'scanprosite', 'superfamily', 'pfam', 'prints',
               'smart', 'pirsf', 'tigrfam'.
Kieron Taylor's avatar
Kieron Taylor committed
787
  Returntype : listref of Bio::EnsEMBL::ProteinFeature
788 789
  Exceptions : none
  Caller     : webcode (protview)
790
  Status     : Stable
791 792 793 794 795 796 797 798

=cut

sub get_all_DomainFeatures{
 my ($self) = @_;

 my @features;

799 800 801
 my @types = ('pfscan',      #profile (prosite or pfam motifs)
              'scanprosite', #prosite
              'superfamily',
802
              'pfam',
803 804 805
              'smart',
              'tigrfam',
              'pirsf',
806 807 808 809 810 811 812 813 814
              'prints');

 foreach my $type (@types) {
   push @features, @{$self->get_all_ProteinFeatures($type)};
 }

 return \@features;
}

815

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
=head2 add_ProteinFeature

  Arg [1]    : Bio::EnsEMBL::ProteinFeature $pf
               The ProteinFeature to be added
  Example    : $translation->add_ProteinFeature($pf);
  Description: Associates a ProteinFeature with this translation. Note that
               adding ProteinFeatures will prevent future lazy-loading of
               ProteinFeatures for this translation (see
               get_all_ProteinFeatures).
  Returntype : none
  Exceptions : thrown on incorrect argument type
  Caller     : general
  Status     : Stable

=cut

sub add_ProteinFeature {
  my $self = shift;
  my $pf = shift;

  unless ($pf && ref($pf) && $pf->isa('Bio::EnsEMBL::ProteinFeature')) {
    throw('Expected ProteinFeature argument');
  }

  my $analysis = $pf->analysis;
  throw("ProteinFeature has no attached Analysis.") unless $analysis;

  push @{ $self->{'protein_features'}->{$analysis->logic_name} }, $pf;
}


847 848 849 850
=head2 display_id

  Example    : print $translation->display_id();
  Description: This method returns a string that is considered to be
851 852 853
               the 'display' identifier. For translations this is (depending on
               availability and in this order) the stable Id, the dbID or an
               empty string.
854 855 856
  Returntype : string
  Exceptions : none
  Caller     : web drawing code
857
  Status     : Stable
858 859 860 861 862

=cut

sub display_id {
  my $self = shift;
863
  return $self->{'stable_id'} || $self->dbID || '';
864 865 866
}


867 868 869 870 871 872 873 874
=head2 length

  Example    : print "Peptide length =", $translation->length();
  Description: Retrieves the length of the peptide sequence (i.e. number of
               amino acids) represented by this Translation object.
  Returntype : int
  Exceptions : none
  Caller     : webcode (protview etc.)
875
  Status     : Stable
876 877 878

=cut

Web Admin's avatar
Web Admin committed
879
sub length {
880 881
  my $self = shift;
  my $seq = $self->seq();
Web Admin's avatar
testing  
Web Admin committed
882

883
  return ($seq) ? CORE::length($seq) : 0;
884 885 886 887 888 889 890 891 892
}


=head2 seq

  Example    : print $translation->seq();
  Description: Retrieves a string representation of the peptide sequence
               of this Translation.  This retrieves the transcript from the
               database and gets its sequence, or retrieves the sequence which
Patrick Meidl's avatar
Patrick Meidl committed
893
               was set via the constructor.
894 895 896 897
  Returntype : string
  Exceptions : warning if the sequence is not set and cannot be retrieved from
               the database.
  Caller     : webcode (protview etc.)
898
  Status     : Stable
899 900 901 902

=cut

sub seq {
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
903
  my ( $self, $sequence ) = @_;
904

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
905
  if ( defined($sequence) ) {
906

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
907
    $self->{'seq'} = $sequence;
908

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
909
  } elsif ( !defined( $self->{'seq'} ) ) {
910

911
    my $transcript = $self->transcript();
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
912

913
    my $canonical_translation = $transcript->translation();
914
    my $is_alternative;
915 916 917
    if(!$canonical_translation) {
	throw "Transcript does not have a canonical translation";
    }
918 919 920
    if (    defined( $canonical_translation->stable_id() )
         && defined( $self->stable_id() ) )
    {
921
      # Try stable ID.
922 923
      $is_alternative =
        ( $canonical_translation->stable_id() ne $self->stable_id() );
924 925 926 927
    } elsif (    defined( $canonical_translation->dbID() )
              && defined( $self->dbID() ) )
    {
      # Try dbID.
928 929
      $is_alternative =
        ( $canonical_translation->dbID() != $self->dbID() );
930 931 932 933 934 935
    } else {
      # Resort to using geomic start/end coordinates.
      $is_alternative = ( ($canonical_translation->genomic_start() !=
                             $self->genomic_start() )
                           || ( $canonical_translation->genomic_end() !=
                                $self->genomic_end() ) );
936
    }
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
937

938 939 940 941
    if ($is_alternative) {
      # To deal with non-canonical (alternative) translations, subsitute
      # the canonical translation in the transcript with $self for a
      # while.
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
942

943 944 945 946
      $transcript->translation($self);
    }

    my $seq = $transcript->translate();
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
947 948 949
    if ( defined($seq) ) {
      $self->{'seq'} = $seq->seq();
    }
950

951 952 953 954 955 956 957
    if ($is_alternative) {
      # Reinstate the real canonical translation.

      $transcript->translation($canonical_translation);
    }

  } ## end elsif ( !defined( $self->...))
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
958 959 960

  if ( !defined( $self->{'seq'} ) ) {
    return '';    # Empty string
961
  }
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
962 963 964 965

  return $self->{'seq'};

} ## end sub seq
966

Patrick Meidl's avatar
Patrick Meidl committed
967

968 969 970 971
=head2 get_all_Attributes

  Arg [1]    : optional string $attrib_code
               The code of the attribute type to retrieve values for.
972
  Example    : ($sc_attr) = @{$tl->get_all_Attributes('_selenocysteine')};
973
               @tl_attributes = @{$translation->get_all_Attributes()};
974 975
  Description: Gets a list of Attributes of this translation.
               Optionally just get Attrubutes for given code.
976
               Recognized attribute "_selenocysteine"
977 978 979 980
  Returntype : listref Bio::EnsEMBL::Attribute
  Exceptions : warning if translation does not have attached adaptor and 
               attempts lazy load.
  Caller     : general, modify_translation
981
  Status     : Stable
982 983 984 985 986 987 988 989 990 991 992 993 994

=cut

sub get_all_Attributes {
  my $self = shift;
  my $attrib_code = shift;

  if( ! exists $self->{'attributes' } ) {
    if(!$self->adaptor() ) {
#      warning('Cannot get attributes without an adaptor.');
      return [];
    }

995 996
    my $aa = $self->adaptor->db->get_AttributeAdaptor();
    $self->{'attributes'} = $aa->fetch_all_by_Translation( $self );
997 998 999
  }

  if( defined $attrib_code ) {
1000
    my @results = grep { uc($_->code()) eq uc($attrib_code) }
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    @{$self->{'attributes'}};
    return \@results;
  } else {
    return $self->{'attributes'};
  }
}


=head2 add_Attributes

Patrick Meidl's avatar
Patrick Meidl committed
1011 1012
  Arg [1..N] : Bio::EnsEMBL::Attribute $attribute
               Attributes to add.
1013
  Example    : $translation->add_Attributes($selenocysteine_attribute);
1014
  Description: Adds an Attribute to the Translation. Usefull to 
1015
               do _selenocysteine.
1016 1017
               If you add an attribute before you retrieve any from database, 
               lazy load will be disabled.
1018
  Returntype : none
1019
  Exceptions : throw on incorrect arguments
1020
  Caller     : general
1021
  Status     : Stable
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034

=cut

sub add_Attributes {
  my $self = shift;
  my @attribs = @_;

  if( ! exists $self->{'attributes'} ) {
    $self->{'attributes'} = [];
  }

  for my $attrib ( @attribs ) {
    if( ! $attrib->isa( "Bio::EnsEMBL::Attribute" )) {
1035
      throw( "Argument to add_Attribute must be a Bio::EnsEMBL::Attribute" );
1036 1037
    }
    push( @{$self->{'attributes'}}, $attrib );
1038
    $self->{seq}=undef;
1039 1040 </