Translation.pm 27.9 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 146 147 148
sub transcript {
  my ( $self, $transcript ) = @_;

  if ( defined($transcript) ) {

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

149 150
    weaken($self->{'transcript'});

151 152 153
  } elsif ( !defined( $self->{'transcript'} ) ) {
    my $adaptor = $self->{'adaptor'};
    if ( !defined($adaptor) ) {
154 155
      throw(   "Adaptor is not set for translation, "
             . "can not fecth its transcript." );
156 157 158 159
    }

    my $dbID = $self->{'dbID'};
    if ( !defined($dbID) ) {
160 161
      throw(   "dbID is not set for translation, "
             . " can not fetch its transcript." );
162 163 164 165 166
    }

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

    weaken($self->{'transcript'});
169 170 171 172 173
  }

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

Ewan Birney's avatar
Ewan Birney committed
174 175 176

=head2 start

Patrick Meidl's avatar
Patrick Meidl committed
177 178 179 180 181
  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.

182 183
               If you need genomic coordinates, use the genomic_start()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
184 185 186 187
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
Ewan Birney's avatar
Ewan Birney committed
188 189 190 191 192 193 194

=cut

sub start{
   my $obj = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
195
      
Ewan Birney's avatar
Ewan Birney committed
196 197 198 199 200 201 202
      $obj->{'start'} = $value;
    }
    return $obj->{'start'};

}


203 204
=head2 end

Patrick Meidl's avatar
Patrick Meidl committed
205 206 207 208
  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.
209

210 211
               If you need genomic coordinates, use the genomic_end()
               method.
Patrick Meidl's avatar
Patrick Meidl committed
212 213 214 215
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable
216 217 218 219 220 221 222

=cut

sub end {
   my $self = shift;
   if( @_ ) {
      my $value = shift;
Laura Clarke's avatar
 
Laura Clarke committed
223
      
224 225 226 227 228 229 230
      $self->{'end'} = $value;
    }
    return $self->{'end'};

}


Graham McVicker's avatar
Graham McVicker committed
231
=head2 start_Exon
232

Patrick Meidl's avatar
Patrick Meidl committed
233 234 235 236 237 238 239 240 241
  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
242 243 244

=cut

Graham McVicker's avatar
Graham McVicker committed
245
sub start_Exon {
246
   my $self = shift;
247

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


Graham McVicker's avatar
Graham McVicker committed
259
=head2 end_Exon
260

Patrick Meidl's avatar
Patrick Meidl committed
261 262 263 264 265 266 267 268 269
  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
270 271 272

=cut

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

283
    return $self->{'end_exon'};
Ewan Birney's avatar
Ewan Birney committed
284 285
}

286 287
=head2 cdna_start

Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
288 289
    Arg  [1]    : (optional) Bio::EnsEMBL::Transcript $transcript
                  The transcript which this is a translation of.
290 291 292
    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
293 294 295
                  If no transcript is given, the method will use
                  TranscriptAdaptor->fetch_by_translation_id() to locate
                  the correct transcript.
296 297 298 299 300 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 {
    my $self = shift;
    my ($transcript) = @_;

    if ( defined $transcript
         && (    !ref $transcript
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
310 311
              || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
    {
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
        throw("Argument is not a transcript");
    }

    if ( !exists $self->{'cdna_start'} ) {
        if ( !defined $transcript ) {
            # We were not given a transcript, get the transcript out of
            # the database.

            my $transcript_adaptor =
              $self->adaptor()->db()->get_TranscriptAdaptor();

            $transcript =
              $transcript_adaptor->fetch_by_translation_id(
                                                        $self->dbID() );
        }

        $self->{'cdna_start'} =
          $self->start_Exon()->cdna_coding_start($transcript);
    }

    return $self->{'cdna_start'};
} ## end sub cdna_start

=head2 cdna_end

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

    if ( defined $transcript
         && (    !ref $transcript
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
359 360
              || !$transcript->isa('Bio::EnsEMBL::Transcript') ) )
    {
361 362 363 364 365 366 367 368 369 370 371 372 373 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 433 434 435 436 437 438 439 440 441
        throw("Argument is not a transcript");
    }

    if ( !exists $self->{'cdna_end'} ) {
        if ( !defined $transcript ) {
            # We were not given a transcript, get the transcript out of
            # the database.

            my $transcript_adaptor =
              $self->adaptor()->db()->get_TranscriptAdaptor();

            $transcript =
              $transcript_adaptor->fetch_by_translation_id(
                                                        $self->dbID() );
        }

        $self->{'cdna_end'} =
          $self->end_Exon()->cdna_coding_end($transcript);
    }

    return $self->{'cdna_end'};
} ## end sub cdna_end

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

443
=head2 version
444

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

=cut

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


462
=head2 stable_id
Graham McVicker's avatar
Graham McVicker committed
463

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

=cut

474
sub stable_id {
475
   my $self = shift;
476 477
  $self->{'stable_id'} = shift if( @_ );
  return $self->{'stable_id'};
478 479
}

480 481
=head2 created_date

Patrick Meidl's avatar
Patrick Meidl committed
482 483 484
  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
485 486 487 488 489 490 491
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

492 493 494 495 496 497 498
sub created_date {
  my $self = shift;
  $self->{'created_date'} = shift if ( @_ );
  return $self->{'created_date'};
}


499 500
=head2 modified_date

Patrick Meidl's avatar
Patrick Meidl committed
501 502 503
  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
504 505 506 507 508 509 510
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut 

511 512 513 514 515 516
sub modified_date {
  my $self = shift;
  $self->{'modified_date'} = shift if ( @_ );
  return $self->{'modified_date'};
}

517

Graham McVicker's avatar
Graham McVicker committed
518

519 520
=head2 transform

Patrick Meidl's avatar
Patrick Meidl committed
521 522 523 524
  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.
525
  Returntype: none
Patrick Meidl's avatar
Patrick Meidl committed
526 527
  Exceptions : none
  Caller     : Transcript->transform() 
528
  Status     : Stable
529 530 531 532 533 534 535

=cut

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

Graham McVicker's avatar
Graham McVicker committed
536 537
  my $start_exon = $self->start_Exon();
  my $end_exon = $self->end_Exon();
538

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

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

552 553 554

=head2 get_all_DBEntries

Patrick Meidl's avatar
Patrick Meidl committed
555 556
  Arg [1]    : (optional) $ex_db_exp - external db name
  Example    : @dbentries = @{$translation->get_all_DBEntries()};
557 558 559 560 561 562 563 564 565
  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
566
  Status     : Stable
567 568 569 570 571

=cut

sub get_all_DBEntries {
  my $self = shift;
572
  my $ex_db_exp = shift;
Ian Longden's avatar
Ian Longden committed
573
  my $ex_db_type = shift;
574 575 576 577 578 579

  my $cache_name = "dbentries";

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

Patrick Meidl's avatar
Patrick Meidl committed
584
  # if not cached, retrieve all of the xrefs for this gene
585
  if(!defined $self->{$cache_name}) {
586 587
    my $adaptor = $self->adaptor();
    my $dbID    = $self->dbID();
Graham McVicker's avatar
Graham McVicker committed
588 589

    return [] if(!$adaptor || !$dbID);
590
    $self->{$cache_name} =
Ian Longden's avatar
Ian Longden committed
591
      $self->adaptor->db->get_DBEntryAdaptor->fetch_all_by_Translation($self, $ex_db_exp, $ex_db_type);
592 593
  }

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

596
  return $self->{$cache_name};
597 598 599 600 601 602 603
}


=head2 add_DBEntry

  Arg [1]    : Bio::EnsEMBL::DBEntry $dbe
               The dbEntry to be added
Patrick Meidl's avatar
Patrick Meidl committed
604 605 606 607
  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).
608 609 610
  Returntype : none
  Exceptions : thrown on incorrect argument type
  Caller     : general
611
  Status     : Stable
612 613 614 615 616 617 618 619

=cut

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

  unless($dbe && ref($dbe) && $dbe->isa('Bio::EnsEMBL::DBEntry')) {
620
    throw('Expected DBEntry argument');
621 622 623 624 625 626 627
  }

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


Stephen Keenan's avatar
Stephen Keenan committed
628 629
=head2 get_all_DBLinks

630 631 632
  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
633
               classes. It is a synonym for the get_all_DBEntries method.
634 635 636
  Returntype : see get_all_DBEntries
  Exceptions : none
  Caller     : general
637
  Status     : Stable
Stephen Keenan's avatar
Stephen Keenan committed
638 639 640 641 642

=cut

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

646

647 648 649 650 651 652 653 654 655 656
=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.
657 658 659

               ProteinFeatures are lazy-loaded from the database unless they
               added manually to the Translation or had already been loaded.
660 661 662
  Returntype : Bio::EnsEMBL::ProteinFeature
  Exceptions : none
  Caller     : general
663
  Status     : Stable
664 665 666 667 668 669 670 671 672 673

=cut

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

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

    return [] if (!$adaptor || !$dbID);
676 677 678 679 680 681 682 683 684

    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) {
685
        $name = lc($f->analysis->logic_name());
686
      } else {
687 688
        warning("ProteinFeature has no attached analysis\n");
        $name = '';
689 690 691 692 693 694
      }
      $hash{$name} ||= [];
      push @{$hash{$name}}, $f;
    }
  }

Patrick Meidl's avatar
Patrick Meidl committed
695
  # a specific type of protein feature was requested
696 697 698 699 700
  if(defined($logic_name)) {
    $logic_name = lc($logic_name);
    return $self->{'protein_features'}->{$logic_name} || [];
  }

701
  my @features = ();
702

Patrick Meidl's avatar
Patrick Meidl committed
703
  # all protein features were requested
704 705 706 707 708 709 710 711 712 713 714 715 716 717
  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
718 719
               'pfscan', 'scanprosite', 'superfamily', 'pfam', 'prints',
               'smart', 'pirsf', 'tigrfam'.
720 721 722
  Returntype : listref of Bio::EnsEMBL::ProteinFeatures
  Exceptions : none
  Caller     : webcode (protview)
723
  Status     : Stable
724 725 726 727 728 729 730 731

=cut

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

 my @features;

732 733 734
 my @types = ('pfscan',      #profile (prosite or pfam motifs)
              'scanprosite', #prosite
              'superfamily',
735
              'pfam',
736 737 738
              'smart',
              'tigrfam',
              'pirsf',
739 740 741 742 743 744 745 746 747
              'prints');

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

 return \@features;
}

748

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
=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;
}


780 781 782 783
=head2 display_id

  Example    : print $translation->display_id();
  Description: This method returns a string that is considered to be
784 785 786
               the 'display' identifier. For translations this is (depending on
               availability and in this order) the stable Id, the dbID or an
               empty string.
787 788 789
  Returntype : string
  Exceptions : none
  Caller     : web drawing code
790
  Status     : Stable
791 792 793 794 795

=cut

sub display_id {
  my $self = shift;
796
  return $self->{'stable_id'} || $self->dbID || '';
797 798 799
}


800 801 802 803 804 805 806 807
=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.)
808
  Status     : Stable
809 810 811

=cut

Web Admin's avatar
Web Admin committed
812
sub length {
813 814
  my $self = shift;
  my $seq = $self->seq();
Web Admin's avatar
testing  
Web Admin committed
815

816
  return ($seq) ? CORE::length($seq) : 0;
817 818 819 820 821 822 823 824 825
}


=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
826
               was set via the constructor.
827 828 829 830
  Returntype : string
  Exceptions : warning if the sequence is not set and cannot be retrieved from
               the database.
  Caller     : webcode (protview etc.)
831
  Status     : Stable
832 833 834 835

=cut

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

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

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

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

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

846 847 848
    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
849

850 851 852 853
    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
854

855 856 857 858
      $transcript->translation($self);
    }

    my $seq = $transcript->translate();
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
859 860 861
    if ( defined($seq) ) {
      $self->{'seq'} = $seq->seq();
    }
862

863 864 865 866 867 868 869
    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
870 871 872

  if ( !defined( $self->{'seq'} ) ) {
    return '';    # Empty string
873
  }
Andreas Kusalananda Kähäri's avatar
Andreas Kusalananda Kähäri committed
874 875 876 877

  return $self->{'seq'};

} ## end sub seq
878

Patrick Meidl's avatar
Patrick Meidl committed
879

880 881 882 883
=head2 get_all_Attributes

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

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

907 908
    my $aa = $self->adaptor->db->get_AttributeAdaptor();
    $self->{'attributes'} = $aa->fetch_all_by_Translation( $self );
909 910 911
  }

  if( defined $attrib_code ) {
912
    my @results = grep { uc($_->code()) eq uc($attrib_code) }
913 914 915 916 917 918 919 920 921 922
    @{$self->{'attributes'}};
    return \@results;
  } else {
    return $self->{'attributes'};
  }
}


=head2 add_Attributes

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

=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" )) {
947
      throw( "Argument to add_Attribute must be a Bio::EnsEMBL::Attribute" );
948 949
    }
    push( @{$self->{'attributes'}}, $attrib );
950
    $self->{seq}=undef;
951 952 953
  }
}

Patrick Meidl's avatar
Patrick Meidl committed
954

955
=head2 get_all_SeqEdits
956

957 958 959 960 961 962
  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()
963
  Status     : Stable
964 965 966

=cut

967
sub get_all_SeqEdits {
968 969
  my $self = shift;

970
  my @seqeds;
971

972 973
  my $attribs;
  
974
  my @edits = ('initial_met', '_selenocysteine', 'amino_acid_sub');
975 976 977 978
  

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

980 981 982 983
    # convert attributes to SeqEdit objects
    foreach my $a (@$attribs) {
      push @seqeds, Bio::EnsEMBL::SeqEdit->new(-ATTRIB => $a);
    }
984 985 986
  }
  return \@seqeds;
}
Patrick Meidl's avatar
Patrick Meidl committed
987
  
988 989 990

=head2 modify_translation

Patrick Meidl's avatar
Patrick Meidl committed
991
  Arg [1]    : Bio::Seq $peptide 
992 993
  Example    : my $seq = Bio::Seq->new(-SEQ => $dna)->translate();
               $translation->modify_translation($seq);
994
  Description: Applies sequence edits such as selenocysteines to the Bio::Seq 
995
               peptide thats passed in
996
  Returntype : Bio::Seq
Patrick Meidl's avatar
Patrick Meidl committed
997
  Exceptions : none
998
  Caller     : Bio::EnsEMBL::Transcript->translate
999
  Status     : Stable
1000 1001 1002 1003

=cut

sub modify_translation {
1004
  my ( $self, $seq ) = @_;
1005

1006
  my @seqeds = @{ $self->get_all_SeqEdits() };
1007

1008 1009 1010
  # Sort in reverse order to avoid complication of adjusting
  # downstream edits.
  @seqeds = sort { $b->start() <=> $a->start() } @seqeds;
1011

1012
  # Apply all edits.
1013 1014
  my $peptide = $seq->seq();
  foreach my $se (@seqeds) {
1015
    $se->apply_edit( \$peptide );
1016
  }
1017

1018
  $seq->seq($peptide);
1019 1020 1021 1022 1023

  return $seq;
}


1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
=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'};
}


1040 1041 1042
=head2 get_all_DASFactories

  Function  : Retrieves a listref of registered DAS objects
Patrick Meidl's avatar
Patrick Meidl committed
1043 1044
  Returntype: DAS objects
  Exceptions: none
1045
  Caller    : webcode
Patrick Meidl's avatar
Patrick Meidl committed
1046 1047
  Example   : $dasref = $prot->get_all_DASFactories;
  Status    : Stable
1048 1049 1050 1051 1052 1053 1054 1055 1056

=cut

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


1057 1058 1059 1060 1061 1062 1063 1064 1065
=head2 get_all_DAS_Features

  Example    : $features = $prot->get_all_DAS_Features;
  Description: Retreives a hash reference to a hash of DAS feature
               sets, keyed by the DNS, NOTE the values of this hash
               are an anonymous array containing:
                (1) a pointer to an array of features;
                (2) a pointer to the DAS stylesheet
  Returntype : hashref of Bio::SeqFeatures
Patrick Meidl's avatar
Patrick Meidl committed
1066
  Exceptions : none
1067
  Caller     : webcode
1068
  Status     : Stable
1069 1070 1071 1072

=cut

sub get_all_DAS_Features{
Patrick Meidl's avatar
Patrick Meidl committed
1073
  my $self = shift;
1074 1075 1076

  my $db = $self->adaptor->db;
  my $GeneAdaptor = $db->get_GeneAdaptor;
1077
  my $Gene = $GeneAdaptor->fetch_by_translation_stable_id($self->stable_id) || return;
1078
  my $slice = $Gene->feature_Slice;