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

3
  Copyright (c) 1999-2010 The European Bioinformatics Institute and
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
  Genome Research Limited.  All rights reserved.

  This software is distributed under a modified Apache license.
  For license details, please see

    http://www.ensembl.org/info/about/code_licence.html

=head1 CONTACT

  Please email comments or questions to the public Ensembl
  developers list at <ensembl-dev@ebi.ac.uk>.

  Questions may also be sent to the Ensembl help desk at
  <helpdesk@ensembl.org>.

=cut
Ewan Birney's avatar
Ewan Birney committed
20 21 22

=head1 NAME

23 24
Bio::EnsEMBL::Translation - A class representing the translation of a
transcript
Ewan Birney's avatar
Ewan Birney committed
25 26 27

=head1 SYNOPSIS

Patrick Meidl's avatar
Patrick Meidl committed
28 29 30 31 32 33 34 35 36 37 38 39
  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;
40
  my $end   = $translation->end;
41

Ewan Birney's avatar
Ewan Birney committed
42 43
=head1 DESCRIPTION

44
A Translation object defines the CDS and UTR regions of a Transcript
45
through the use of start_Exon/end_Exon, and start/end attributes.
Ewan Birney's avatar
Ewan Birney committed
46 47 48 49

=cut


50 51
package Bio::EnsEMBL::Translation;

Ewan Birney's avatar
Ewan Birney committed
52 53 54
use vars qw($AUTOLOAD @ISA);
use strict;

55 56
use Scalar::Util qw(weaken);

57 58
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw( rearrange );
Ewan Birney's avatar
Ewan Birney committed
59

60
use Bio::EnsEMBL::Storable;
Ewan Birney's avatar
Ewan Birney committed
61

62
@ISA = qw(Bio::EnsEMBL::Storable);
Ewan Birney's avatar
Ewan Birney committed
63 64


65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
=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.
80 81
  Arg [-CREATED_DATE]: the date the translation was created
  Arg [-MODIFIED_DATE]: the date the translation was modified
82 83 84 85 86 87 88 89 90
  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
91
  Status     : Stable
92 93 94

=cut

95
sub new {
Graham McVicker's avatar
Graham McVicker committed
96
  my $caller = shift;
97

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

100
  my ( $start_exon, $end_exon, $seq_start, $seq_end,
101
       $stable_id, $version, $dbID, $adaptor, $seq,
102 103 104 105
       $created_date, $modified_date ) =
	   rearrange( [ "START_EXON", "END_EXON", "SEQ_START", "SEQ_END",
			"STABLE_ID", "VERSION", "DBID", "ADAPTOR",
			"SEQ", "CREATED_DATE", "MODIFIED_DATE" ], @_ );
106 107 108

  my $self = bless {
		    'start_exon' => $start_exon,
109 110 111 112 113 114 115
		    'end_exon'   => $end_exon,
		    'adaptor'    => $adaptor,
		    'dbID'       => $dbID,
		    'start'      => $seq_start,
		    'end'        => $seq_end,
		    'stable_id'  => $stable_id,
		    'version'    => $version,
116 117
		    'created_date' => $created_date,
		    'modified_date' => $modified_date,
118
        'seq'        => $seq
119 120 121
		   }, $class;

  return $self;
Ewan Birney's avatar
Ewan Birney committed
122 123
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
=head2 new_fast

  Arg [1]    : hashref to be blessed
  Description: Construct a new Bio::EnsEMBL::Translation using the hashref.
  Exceptions : none
  Returntype : Bio::EnsEMBL::Translation
  Caller     : general, subclass constructors
  Status     : Stable

=cut


sub new_fast {
  my $class = shift;
  my $hashref = shift;
  return bless $hashref, $class;
}

142 143 144 145
sub transcript {
  my ( $self, $transcript ) = @_;

  if ( defined($transcript) ) {
146 147 148 149 150
    if (    !ref($transcript)
         || !$transcript->isa('Bio::EnsEMBL::Transcript') )
    {
      throw("Argument is not a transcript");
    }
151 152 153

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

154
    weaken( $self->{'transcript'} );
155

156 157 158
  } elsif ( !defined( $self->{'transcript'} ) ) {
    my $adaptor = $self->{'adaptor'};
    if ( !defined($adaptor) ) {
159 160
      throw(   "Adaptor is not set for translation, "
             . "can not fecth its transcript." );
161 162 163 164
    }

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

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

173
    weaken( $self->{'transcript'} );
174 175 176
  }

  return $self->{'transcript'};
177
} ## end sub transcript
178

Ewan Birney's avatar
Ewan Birney committed
179 180 181

=head2 start

Patrick Meidl's avatar
Patrick Meidl committed
182 183 184 185 186
  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.

187 188
               If you need genomic coordinates, use the genomic_start()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
189 190 191 192
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
193 194 195 196 197 198 199

=cut

sub start{
   my $obj = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
200
      
Ewan Birney's avatar
Ewan Birney committed
201 202 203 204 205 206 207
      $obj->{'start'} = $value;
    }
    return $obj->{'start'};

}


208 209
=head2 end

Patrick Meidl's avatar
Patrick Meidl committed
210 211 212 213
  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.
214

215 216
               If you need genomic coordinates, use the genomic_end()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
217 218 219 220
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
221 222 223 224 225 226 227

=cut

sub end {
   my $self = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
228
      
229 230 231 232 233 234 235
      $self->{'end'} = $value;
    }
    return $self->{'end'};

}


Graham McVicker's avatar
Graham McVicker committed
236
=head2 start_Exon
237

Patrick Meidl's avatar
Patrick Meidl committed
238 239 240 241 242 243 244 245 246
  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
247 248 249

=cut

Graham McVicker's avatar
Graham McVicker committed
250
sub start_Exon {
251
   my $self = shift;
252

Ewan Birney's avatar
Ewan Birney committed
253 254
   if( @_ ) {
      my $value = shift;
255
      if( !ref $value || !$value->isa('Bio::EnsEMBL::Exon') ) {
256
         throw("Got to have an Exon object, not a $value");
257 258
      }
      $self->{'start_exon'} = $value;
Ewan Birney's avatar
Ewan Birney committed
259
    }
260
   return $self->{'start_exon'};
Ewan Birney's avatar
Ewan Birney committed
261 262 263
}


Graham McVicker's avatar
Graham McVicker committed
264
=head2 end_Exon
265

Patrick Meidl's avatar
Patrick Meidl committed
266 267 268 269 270 271 272 273 274
  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
275 276 277

=cut

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

288
    return $self->{'end_exon'};
Ewan Birney's avatar
Ewan Birney committed
289 290
}

291 292
=head2 cdna_start

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
293 294
    Arg  [1]    : (optional) Bio::EnsEMBL::Transcript $transcript
                  The transcript which this is a translation of.
295 296 297
    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
298 299 300
                  If no transcript is given, the method will use
                  TranscriptAdaptor->fetch_by_translation_id() to locate
                  the correct transcript.
301 302 303 304 305 306 307 308 309
    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 {
310
  my ( $self, $transcript ) = @_;
311

312 313 314 315 316 317
  if ( defined($transcript)
       && (    !ref($transcript)
            || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
  {
    throw("Argument is not a transcript");
  }
318

319 320 321 322 323
  if ( !exists( $self->{'cdna_start'} ) ) {
    if ( !defined($transcript) ) {
      # We were not given a transcript, get the transcript out of
      # the database.
      $transcript = $self->transcript();
324 325
    }

326 327 328 329 330 331
    $self->{'cdna_start'} =
      $self->start_Exon()->cdna_coding_start($transcript);
  }

  return $self->{'cdna_start'};
}
332 333 334

=head2 cdna_end

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
335 336
    Arg  [1]    : (optional) Bio::EnsEMBL::Transcript $transcript
                  The transcript which this is a translation of.
337 338 339
    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
340 341 342
                  If no transcript is given, the method will use
                  TranscriptAdaptor->fetch_by_translation_id() to locate
                  the correct transcript.
343 344 345 346 347 348 349 350 351
    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 {
352
  my ( $self, $transcript ) = @_;
353

354 355 356 357 358 359
  if ( defined($transcript)
       && (    !ref($transcript)
            || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
  {
    throw("Argument is not a transcript");
  }
360

361 362 363 364 365
  if ( !exists( $self->{'cdna_end'} ) ) {
    if ( !defined($transcript) ) {
      # We were not given a transcript, get the transcript out of
      # the database.
      $transcript = $self->transcript();
366 367
    }

368 369 370 371 372 373
    $self->{'cdna_end'} =
      $self->end_Exon()->cdna_coding_end($transcript);
  }

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

=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
433

434
=head2 version
435

Patrick Meidl's avatar
Patrick Meidl committed
436 437 438
  Arg [1]    : (optional) string $version - version to set
  Example    : $translation->version(2);
  Description: Getter/setter for attribute version
439 440 441
  Returntype : string
  Exceptions : none
  Caller     : general
442
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
443 444 445

=cut

446
sub version {
447
   my $self = shift;
448 449
  $self->{'version'} = shift if( @_ );
  return $self->{'version'};
Ewan Birney's avatar
Ewan Birney committed
450
}
451 452


453
=head2 stable_id
Graham McVicker's avatar
Graham McVicker committed
454

Patrick Meidl's avatar
Patrick Meidl committed
455 456 457
  Arg [1]    : (optional) string $stable_id - stable ID to set
  Example    : $translation->stable_id('ENSP0059890');
  Description: Getter/setter for attribute stable_id
458 459 460
  Returntype : string
  Exceptions : none
  Caller     : general
461
  Status     : Stable
462 463 464

=cut

465
sub stable_id {
466
   my $self = shift;
467 468
  $self->{'stable_id'} = shift if( @_ );
  return $self->{'stable_id'};
469 470
}

471 472
=head2 created_date

Patrick Meidl's avatar
Patrick Meidl committed
473 474 475
  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
476 477 478 479 480 481 482
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

483 484 485 486 487 488 489
sub created_date {
  my $self = shift;
  $self->{'created_date'} = shift if ( @_ );
  return $self->{'created_date'};
}


490 491
=head2 modified_date

Patrick Meidl's avatar
Patrick Meidl committed
492 493 494
  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
495 496 497 498 499 500 501
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

502 503 504 505 506 507
sub modified_date {
  my $self = shift;
  $self->{'modified_date'} = shift if ( @_ );
  return $self->{'modified_date'};
}

508

Graham McVicker's avatar
Graham McVicker committed
509

510 511
=head2 transform

Patrick Meidl's avatar
Patrick Meidl committed
512 513 514 515
  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.
516
  Returntype: none
Patrick Meidl's avatar
Patrick Meidl committed
517 518
  Exceptions : none
  Caller     : Transcript->transform() 
519
  Status     : Stable
520 521 522 523 524 525 526

=cut

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

Graham McVicker's avatar
Graham McVicker committed
527 528
  my $start_exon = $self->start_Exon();
  my $end_exon = $self->end_Exon();
529

Arne Stabenau's avatar
Arne Stabenau committed
530 531
  if ( exists $href_exons->{$start_exon} ) {
    $self->start_Exon($href_exons->{$start_exon});
532 533
  } else {
    # do nothing, the start exon wasnt mapped
534 535
  }

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

543 544 545

=head2 get_all_DBEntries

Patrick Meidl's avatar
Patrick Meidl committed
546 547
  Arg [1]    : (optional) $ex_db_exp - external db name
  Example    : @dbentries = @{$translation->get_all_DBEntries()};
548 549 550 551 552 553 554 555 556
  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 : list reference to Bio::EnsEMBL::DBEntry objects
  Exceptions : none
  Caller     : get_all_DBLinks, TranslationAdaptor::store
557
  Status     : Stable
558 559 560 561 562

=cut

sub get_all_DBEntries {
  my $self = shift;
563
  my $ex_db_exp = shift;
Ian Longden's avatar
Ian Longden committed
564
  my $ex_db_type = shift;
565 566 567 568 569 570

  my $cache_name = "dbentries";

  if(defined($ex_db_exp)){
    $cache_name .= $ex_db_exp;
  }
Ian Longden's avatar
Ian Longden committed
571 572
  if(defined($ex_db_type)){
    $cache_name .= $ex_db_type;
573
  }
574

Patrick Meidl's avatar
Patrick Meidl committed
575
  # if not cached, retrieve all of the xrefs for this gene
576
  if(!defined $self->{$cache_name}) {
577 578
    my $adaptor = $self->adaptor();
    my $dbID    = $self->dbID();
Graham McVicker's avatar
Graham McVicker committed
579 580

    return [] if(!$adaptor || !$dbID);
581
    $self->{$cache_name} =
Ian Longden's avatar
Ian Longden committed
582
      $self->adaptor->db->get_DBEntryAdaptor->fetch_all_by_Translation($self, $ex_db_exp, $ex_db_type);
583 584
  }

585
  $self->{$cache_name} ||= [];
586

587
  return $self->{$cache_name};
588 589 590 591 592 593 594
}


=head2 add_DBEntry

  Arg [1]    : Bio::EnsEMBL::DBEntry $dbe
               The dbEntry to be added
Patrick Meidl's avatar
Patrick Meidl committed
595 596 597 598
  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).
599 600 601
  Returntype : none
  Exceptions : thrown on incorrect argument type
  Caller     : general
602
  Status     : Stable
603 604 605 606 607 608 609 610

=cut

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

  unless($dbe && ref($dbe) && $dbe->isa('Bio::EnsEMBL::DBEntry')) {
611
    throw('Expected DBEntry argument');
612 613 614 615 616 617 618
  }

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


Stephen Keenan's avatar
Stephen Keenan committed
619 620
=head2 get_all_DBLinks

621 622 623
  Arg [1]    : see get_all_DBEntries
  Example    : see get_all_DBEntries
  Description: This is here for consistancy with the Transcript and Gene 
Patrick Meidl's avatar
Patrick Meidl committed
624
               classes. It is a synonym for the get_all_DBEntries method.
625 626 627
  Returntype : see get_all_DBEntries
  Exceptions : none
  Caller     : general
628
  Status     : Stable
Stephen Keenan's avatar
Stephen Keenan committed
629 630 631 632 633

=cut

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

637

638 639 640 641 642 643 644 645 646 647
=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.
  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.
648 649 650

               ProteinFeatures are lazy-loaded from the database unless they
               added manually to the Translation or had already been loaded.
651 652 653
  Returntype : Bio::EnsEMBL::ProteinFeature
  Exceptions : none
  Caller     : general
654
  Status     : Stable
655 656 657 658 659 660 661 662 663 664

=cut

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

  if(!$self->{'protein_features'}) {
    my $adaptor = $self->adaptor();
    my $dbID    = $self->dbID();
665 666

    return [] if (!$adaptor || !$dbID);
667 668 669 670 671 672 673 674 675

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

    my $pfa = $adaptor->db()->get_ProteinFeatureAdaptor();
    my $name;
    foreach my $f (@{$pfa->fetch_all_by_translation_id($dbID)}) {
      my $analysis = $f->analysis();
      if($analysis) {
676
        $name = lc($f->analysis->logic_name());
677
      } else {
678 679
        warning("ProteinFeature has no attached analysis\n");
        $name = '';
680 681 682 683 684 685
      }
      $hash{$name} ||= [];
      push @{$hash{$name}}, $f;
    }
  }

Patrick Meidl's avatar
Patrick Meidl committed
686
  # a specific type of protein feature was requested
687 688 689 690 691
  if(defined($logic_name)) {
    $logic_name = lc($logic_name);
    return $self->{'protein_features'}->{$logic_name} || [];
  }

692
  my @features = ();
693

Patrick Meidl's avatar
Patrick Meidl committed
694
  # all protein features were requested
695 696 697 698 699 700 701 702 703 704 705 706 707 708
  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
709 710
               'pfscan', 'scanprosite', 'superfamily', 'pfam', 'prints',
               'smart', 'pirsf', 'tigrfam'.
711 712 713
  Returntype : listref of Bio::EnsEMBL::ProteinFeatures
  Exceptions : none
  Caller     : webcode (protview)
714
  Status     : Stable
715 716 717 718 719 720 721 722

=cut

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

 my @features;

723 724 725
 my @types = ('pfscan',      #profile (prosite or pfam motifs)
              'scanprosite', #prosite
              'superfamily',
726
              'pfam',
727 728 729
              'smart',
              'tigrfam',
              'pirsf',
730 731 732 733 734 735 736 737 738
              'prints');

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

 return \@features;
}

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


771 772 773 774
=head2 display_id

  Example    : print $translation->display_id();
  Description: This method returns a string that is considered to be
775 776 777
               the 'display' identifier. For translations this is (depending on
               availability and in this order) the stable Id, the dbID or an
               empty string.
778 779 780
  Returntype : string
  Exceptions : none
  Caller     : web drawing code
781
  Status     : Stable
782 783 784 785 786

=cut

sub display_id {
  my $self = shift;
787
  return $self->{'stable_id'} || $self->dbID || '';
788 789 790
}


791 792 793 794 795 796 797 798
=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.)
799
  Status     : Stable
800 801 802

=cut

Web Admin's avatar
Web Admin committed
803
sub length {
804 805
  my $self = shift;
  my $seq = $self->seq();
Web Admin's avatar
testing  
Web Admin committed
806

807
  return ($seq) ? CORE::length($seq) : 0;
808 809 810 811 812 813 814 815 816
}


=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
817
               was set via the constructor.
818 819 820 821
  Returntype : string
  Exceptions : warning if the sequence is not set and cannot be retrieved from
               the database.
  Caller     : webcode (protview etc.)
822
  Status     : Stable
823 824 825 826

=cut

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

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

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

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

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

837 838 839
    my $canonical_translation = $transcript->translation();
    my $is_alternative =
      ( $canonical_translation->stable_id() ne $self->stable_id() );
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
840

841 842 843 844
    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
845

846 847 848 849
      $transcript->translation($self);
    }

    my $seq = $transcript->translate();
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
850 851 852
    if ( defined($seq) ) {
      $self->{'seq'} = $seq->seq();
    }
853

854 855 856 857 858 859 860
    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
861 862 863

  if ( !defined( $self->{'seq'} ) ) {
    return '';    # Empty string
864
  }
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
865 866 867 868

  return $self->{'seq'};

} ## end sub seq
869

Patrick Meidl's avatar
Patrick Meidl committed
870

871 872 873 874
=head2 get_all_Attributes

  Arg [1]    : optional string $attrib_code
               The code of the attribute type to retrieve values for.
875
  Example    : ($sc_attr) = @{$tl->get_all_Attributes('_selenocysteine')};
876
               @tl_attributes = @{$translation->get_all_Attributes()};
877 878
  Description: Gets a list of Attributes of this translation.
               Optionally just get Attrubutes for given code.
879
               Recognized attribute "_selenocysteine"
880 881 882 883
  Returntype : listref Bio::EnsEMBL::Attribute
  Exceptions : warning if translation does not have attached adaptor and 
               attempts lazy load.
  Caller     : general, modify_translation
884
  Status     : Stable
885 886 887 888 889 890 891 892 893 894 895 896 897

=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 [];
    }

898 899
    my $aa = $self->adaptor->db->get_AttributeAdaptor();
    $self->{'attributes'} = $aa->fetch_all_by_Translation( $self );
900 901 902
  }

  if( defined $attrib_code ) {
903
    my @results = grep { uc($_->code()) eq uc($attrib_code) }
904 905 906 907 908 909 910 911 912 913
    @{$self->{'attributes'}};
    return \@results;
  } else {
    return $self->{'attributes'};
  }
}


=head2 add_Attributes

Patrick Meidl's avatar
Patrick Meidl committed
914 915
  Arg [1..N] : Bio::EnsEMBL::Attribute $attribute
               Attributes to add.
916
  Example    : $translation->add_Attributes($selenocysteine_attribute);
917
  Description: Adds an Attribute to the Translation. Usefull to 
918
               do _selenocysteine.
919 920
               If you add an attribute before you retrieve any from database, 
               lazy load will be disabled.
921
  Returntype : none
922
  Exceptions : throw on incorrect arguments
923
  Caller     : general
924
  Status     : Stable
925 926 927 928 929 930 931 932 933 934 935 936 937

=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" )) {
938
      throw( "Argument to add_Attribute must be a Bio::EnsEMBL::Attribute" );
939 940
    }
    push( @{$self->{'attributes'}}, $attrib );
941
    $self->{seq}=undef;
942 943 944
  }
}

Patrick Meidl's avatar
Patrick Meidl committed
945

946
=head2 get_all_SeqEdits
947

948 949 950 951 952 953
  Example    : my @seqeds = @{$transcript->get_all_SeqEdits()};
  Description: Retrieves all post transcriptional sequence modifications for
               this transcript.
  Returntype : Bio::EnsEMBL::SeqEdit
  Exceptions : none
  Caller     : spliced_seq()
954
  Status     : Stable
955 956 957

=cut

958
sub get_all_SeqEdits {
959 960
  my $self = shift;

961
  my @seqeds;
962

963 964
  my $attribs;
  
965
  my @edits = ('initial_met', '_selenocysteine', 'amino_acid_sub');
966 967 968 969
  

  foreach my $edit(@edits){
    $attribs = $self->get_all_Attributes($edit);
970

971 972 973 974
    # convert attributes to SeqEdit objects
    foreach my $a (@$attribs) {
      push @seqeds, Bio::EnsEMBL::SeqEdit->new(-ATTRIB => $a);
    }
975 976 977
  }
  return \@seqeds;
}
Patrick Meidl's avatar
Patrick Meidl committed
978
  
979 980 981

=head2 modify_translation

Patrick Meidl's avatar
Patrick Meidl committed
982
  Arg [1]    : Bio::Seq $peptide 
983 984
  Example    : my $seq = Bio::Seq->new(-SEQ => $dna)->translate();
               $translation->modify_translation($seq);
985
  Description: Applies sequence edits such as selenocysteines to the Bio::Seq 
986
               peptide thats passed in
987
  Returntype : Bio::Seq
Patrick Meidl's avatar
Patrick Meidl committed
988
  Exceptions : none
989
  Caller     : Bio::EnsEMBL::Transcript->translate
990
  Status     : Stable
991 992 993 994

=cut

sub modify_translation {
995
  my ( $self, $seq ) = @_;
996

997
  my @seqeds = @{ $self->get_all_SeqEdits() };
998

999 1000 1001
  # Sort in reverse order to avoid complication of adjusting
  # downstream edits.
  @seqeds = sort { $b->start() <=> $a->start() } @seqeds;
1002

1003
  # Apply all edits.
1004 1005
  my $peptide = $seq->seq();
  foreach my $se (@seqeds) {
1006
    $se->apply_edit( \$peptide );
1007
  }
1008

1009
  $seq->seq($peptide);
1010 1011 1012 1013 1014

  return $seq;
}


1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
=head2 temporary_id

  Description: DEPRECATED This method should not be needed. Use dbID,
               stable_id or something else.

=cut

sub temporary_id {
   my $self = shift;
   deprecate( "I cant see what a temporary_id is good for, please use " .
               "dbID or stableID or\n try without an id." );
  $self->{'temporary_id'} = shift if( @_ );
  return $self->{'temporary_id'};
}


1031 1032 1033
=head2 get_all_DASFactories

  Function  : Retrieves a listref of registered DAS objects
Patrick Meidl's avatar
Patrick Meidl committed
1034 1035
  Returntype: DAS objects
  Exceptions: none
1036
  Caller    : webcode
Patrick Meidl's avatar
Patrick Meidl committed
1037 1038
  Example   : $dasref = $prot->get_all_DASFactories;
  Status    : Stable
1039 1040 1041 1042 1043 1044 1045 1046 1047

=cut

sub get_all_DASFactories {
   my $self = shift;
   return [ $self->adaptor()->db()->_each_DASFeatureFactory ];
}