annotate variant_effect_predictor/Bio/EnsEMBL/SeqRegionSynonym.pm @ 3:d30fa12e4cc5 default tip

Merge heads 2:a5976b2dce6f and 1:09613ce8151e which were created as a result of a recently fixed bug.
author devteam <devteam@galaxyproject.org>
date Mon, 13 Jan 2014 10:38:30 -0500
parents 1f6dce3d34e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::SeqRegionSynonym -
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 Object representing an alternatice name.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 This object holds information about alternative name to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 Ensembl seq regions.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 package Bio::EnsEMBL::SeqRegionSynonym;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 use warnings;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 no warnings qw(uninitialized);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 use Bio::EnsEMBL::Storable;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 use Bio::Annotation::DBLink;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 use Bio::EnsEMBL::Utils::Exception qw(deprecate);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 our @ISA = qw(Bio::EnsEMBL::Storable);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 =head2 new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 Args [...] : list of named parameters
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 Example : my $srs = new Bio::EnsEMBL::SeqRegionSynonym(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 -adaptor => $adaptor,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 -synonym => $alt_name,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 -external_db_id => 1234
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 -seq_region_id => 12);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 Description: Creates a new SeqRegionSynonym object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 Returntype : Bio::EnsEMBL::SeqRegionSynonym
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 Caller : Bio::EnsEMBL::SeqRegionSynonymAdaptor
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 my ($class, @args) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 my $self = bless {},$class;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 my ( $adaptor, $synonym, $ex_db, $seq_region_id, $dbid) =
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 rearrange ( ['ADAPTOR','SYNONYM','EXTERNAL_DB_ID','SEQ_REGION_ID','DBID'], @args );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 $self->adaptor($adaptor);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 if( defined $ex_db ) { $self->external_db_id( $ex_db ) }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 if( defined $seq_region_id ) { $self->seq_region_id( $seq_region_id ) }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 if (defined $dbid) { $self->{'dbID'} = $dbid}
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 if( defined $synonym ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 $self->name( $synonym ) ;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 warn "No alternative name given\n";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 return undef;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 sub name{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 $self->{'name'} = shift if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 return $self->{'name'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 sub external_db_id{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 $self->{'ex_db'} = shift if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 return $self->{'ex_db'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 sub seq_region_id{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 $self->{'seq_region_id'} = shift if(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 return $self->{'seq_region_id'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 1;