diff variant_effect_predictor/Bio/EnsEMBL/Operon.pm @ 0:1f6dce3d34e0

Uploaded

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/variant_effect_predictor/Bio/EnsEMBL/Operon.pm	Thu Apr 11 02:01:53 2013 -0400
@@ -0,0 +1,367 @@
+
+=head1 LICENSE
+
+  Copyright (c) 1999-2012 The European Bioinformatics Institute and
+  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 <[e-mail]>.
+
+  Questions may also be sent to the Ensembl help desk at
+  <[e-mail]>.
+
+=cut
+
+=head1 NAME
+
+Bio::EnsEMBL::Operon - Object representing an operon
+
+=head1 SYNOPSIS
+
+  my $operon = Bio::EnsEMBL::Operon->new(
+    -START  => 123,
+    -END    => 1045,
+    -STRAND => 1,
+    -SLICE  => $slice,
+    -DISPLAY_LABEL   => $name
+  );
+
+  # print operon information
+  print("operon start:end:strand is "
+      . join( ":", map { $operon->$_ } qw(start end strand) )
+      . "\n" );
+
+=head1 DESCRIPTION
+
+A representation of an Operon within the Ensembl system. 
+An operon is a collection of one or more polycistronic transcripts which contain one or more genes.
+
+=head1 METHODS
+
+=cut
+
+package Bio::EnsEMBL::Operon;
+
+use strict;
+use warnings;
+
+use Bio::EnsEMBL::Feature;
+use Bio::EnsEMBL::Utils::Argument qw(rearrange);
+use Bio::EnsEMBL::Utils::Exception qw(throw warning deprecate);
+use Bio::EnsEMBL::Utils::Scalar qw(assert_ref);
+
+use vars qw(@ISA);
+@ISA = qw(Bio::EnsEMBL::Feature);
+
+=head2 new
+
+  Arg [-START]  : 
+       int - start postion of the operon
+  Arg [-END]    : 
+       int - end position of the operon
+  Arg [-STRAND] : 
+       int - 1,-1 the strand the operon is on
+  Arg [-SLICE]  : 
+       Bio::EnsEMBL::Slice - the slice the operon is on
+  Arg [-STABLE_ID] :
+        string - the stable identifier of this operon
+  Arg [-VERSION] :
+        int - the version of the stable identifier of this operon
+  Arg [-DISPLAY_LABEL]:
+        A name/label for this operon
+  Arg [-CREATED_DATE]:
+        string - the date the operon was created
+  Arg [-MODIFIED_DATE]:
+        string - the date the operon was last modified
+
+  Example    : $gene = Bio::EnsEMBL::Operon->new(...);
+  Description: Creates a new operon object
+  Returntype : Bio::EnsEMBL::Operon
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub new {
+	my $caller = shift;
+
+	my $class = ref($caller) || $caller;
+	my $self = $class->SUPER::new(@_);
+	my ( $stable_id, $version, $created_date, $modified_date,$display_label) =
+	  rearrange( [  'STABLE_ID',    'VERSION',
+					'CREATED_DATE', 'MODIFIED_DATE',
+					'DISPLAY_LABEL' ],
+				 @_ );
+
+	$self->stable_id($stable_id);
+	$self->version($version);
+	$self->{'created_date'}  = $created_date;
+	$self->{'modified_date'} = $modified_date;
+	$self->display_label($display_label);
+
+	return $self;
+}
+
+=head2 created_date
+
+  Arg [1]    : (optional) String - created date to set (as a UNIX time int)
+  Example    : $gene->created_date('1141948800');
+  Description: Getter/setter for attribute created_date
+  Returntype : String
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub created_date {
+  my $self = shift;
+  $self->{'created_date'} = shift if ( @_ );
+  return $self->{'created_date'};
+}
+
+
+=head2 modified_date
+
+  Arg [1]    : (optional) String - modified date to set (as a UNIX time int)
+  Example    : $gene->modified_date('1141948800');
+  Description: Getter/setter for attribute modified_date
+  Returntype : String
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub modified_date {
+  my $self = shift;
+  $self->{'modified_date'} = shift if ( @_ );
+  return $self->{'modified_date'};
+}
+
+
+=head2 display_label
+
+  Arg [1]    : (optional) String - the name/label to set
+  Example    : $operon->name('accBCD');
+  Description: Getter/setter for attribute name.
+  Returntype : String or undef
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub display_label {
+	my $self = shift;
+	$self->{'display_label'} = shift if (@_);
+	return $self->{'display_label'};
+}
+
+=head2 stable_id
+
+  Arg [1]    : (optional) String - the stable ID to set
+  Example    : $operon->stable_id("accR2");
+  Description: Getter/setter for stable id for this operon.
+  Returntype : String
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub stable_id {
+	my $self = shift;
+	$self->{'stable_id'} = shift if (@_);
+	return $self->{'stable_id'};
+}
+
+=head2 version
+
+  Arg [1]    : (optional) Int - the stable ID version to set
+  Example    : $operon->version(1);
+  Description: Getter/setter for stable id version for this operon.
+  Returntype : Int
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+sub version {
+  my $self = shift;
+  $self->{'version'} = shift if(@_);
+  return $self->{'version'};
+}
+
+=head2 get_all_OperonTranscripts
+
+  Example    : my $ots = $operon->get_all_OperonTranscripts();
+  Description: Retrieve all operon transcripts belonging to this operon
+  Returntype : Arrayref of Bio::EnsEMBL::OperonTranscript
+  Exceptions : none
+  Caller     : general
+  Status     : Stable
+
+=cut
+sub get_all_OperonTranscripts {
+	my $self = shift;
+	if ( !exists $self->{'_operon_transcript_array'} ) {
+		if ( defined $self->adaptor() ) {
+			my $ta = $self->adaptor()->db()->get_OperonTranscriptAdaptor();
+			my $transcripts = $ta->fetch_all_by_Operon($self);
+			$self->{'_operon_transcript_array'} = $transcripts;
+		}
+	}
+	return $self->{'_operon_transcript_array'};
+}
+
+=head2 add_OperonTranscript
+
+  Arg [1]    : Bio::EnsEMBL::OperonTranscript - operon transcript to attach to this operon
+  Example    : $operon->add_OperonTranscript($ot);
+  Description: Attach a polycistronic operon transcript to this operon
+  Exceptions : if argument is not Bio::EnsEMBL::OperonTranscript
+  Caller     : general
+  Status     : Stable
+
+=cut
+sub add_OperonTranscript {
+	my ( $self, $trans ) = @_;
+
+	assert_ref($trans,"Bio::EnsEMBL::OperonTranscript");
+
+	$self->{'_operon_transcript_array'} ||= [];
+	push( @{ $self->{'_operon_transcript_array'} }, $trans );
+
+	#$self->recalculate_coordinates();
+	return;
+}
+
+=head2 add_DBEntry
+
+  Arg [1]    : Bio::EnsEMBL::DBEntry $dbe
+               The dbEntry to be added
+  Example    : my $dbe = Bio::EnsEMBL::DBEntery->new(...);
+               $operon->add_DBEntry($dbe);
+  Description: Associates a DBEntry with this operon. Note that adding DBEntries
+               will prevent future lazy-loading of DBEntries for this operon
+               (see get_all_DBEntries).
+  Returntype : none
+  Exceptions : thrown on incorrect argument type
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub add_DBEntry {
+  my $self = shift;
+  my $dbe = shift;
+
+  unless($dbe && ref($dbe) && $dbe->isa('Bio::EnsEMBL::DBEntry')) {
+    throw('Expected DBEntry argument');
+  }
+
+  $self->{'dbentries'} ||= [];
+  push @{$self->{'dbentries'}}, $dbe;
+}
+
+
+=head2 get_all_Attributes
+
+  Arg [1]    : (optional) String $attrib_code
+               The code of the attribute type to retrieve values for
+  Example    : my ($author) = @{ $operon->get_all_Attributes('author') };
+               my @operon_attributes = @{ $operon->get_all_Attributes };
+  Description: Gets a list of Attributes of this operon.
+               Optionally just get Attributes for given code.
+  Returntype : Listref of Bio::EnsEMBL::Attribute
+  Exceptions : warning if gene does not have attached adaptor and attempts lazy
+               load.
+  Caller     : general
+  Status     : Stable
+
+=cut
+
+sub get_all_Attributes {
+	my $self        = shift;
+	my $attrib_code = shift;
+
+	if ( !exists $self->{'attributes'} ) {
+		if ( !$self->adaptor() ) {
+			return [];
+		}
+
+		my $attribute_adaptor = $self->adaptor->db->get_AttributeAdaptor();
+		$self->{'attributes'} = $attribute_adaptor->fetch_all_by_Operon($self);
+	}
+
+	if ( defined $attrib_code ) {
+		my @results =
+		  grep { uc( $_->code() ) eq uc($attrib_code) }
+		  @{ $self->{'attributes'} };
+		return \@results;
+	} else {
+		return $self->{'attributes'};
+	}
+}
+
+=head2 get_all_DBEntries
+
+  Arg [1]    : (optional) String, external database name
+
+  Arg [2]    : (optional) String, external_db type
+
+  Example    : @dbentries = @{ $gene->get_all_DBEntries() };
+
+  Description: Retrieves DBEntries (xrefs) for this operon.  This does
+               *not* include DBEntries that are associated with the
+               transcripts and corresponding translations of this
+               gene (see get_all_DBLinks()).
+
+               This method will attempt to lazy-load DBEntries
+               from a database if an adaptor is available and no
+               DBEntries are present on the gene (i.e. they have not
+               already been added or loaded).
+
+  Return type: Listref of Bio::EnsEMBL::DBEntry objects
+  Exceptions : none
+  Caller     : get_all_DBLinks, OperonAdaptor::store
+  Status     : Stable
+
+=cut
+
+sub get_all_DBEntries {
+	my ( $self, $db_name_exp, $ex_db_type ) = @_;
+
+	my $cache_name = 'dbentries';
+
+	if ( defined($db_name_exp) ) {
+		$cache_name .= $db_name_exp;
+	}
+
+	if ( defined($ex_db_type) ) {
+		$cache_name .= $ex_db_type;
+	}
+
+	# if not cached, retrieve all of the xrefs for this gene
+	if ( !defined( $self->{$cache_name} ) && defined( $self->adaptor() ) ) {
+		$self->{$cache_name} =
+		  $self->adaptor()->db()->get_DBEntryAdaptor()
+		  ->fetch_all_by_Operon( $self, $db_name_exp, $ex_db_type );
+	}
+
+	$self->{$cache_name} ||= [];
+
+	return $self->{$cache_name};
+}
+
+1;
+