annotate variant_effect_predictor/Bio/EnsEMBL/SeqRegionSynonym.pm @ 0:2bc9b66ada89 draft default tip

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