File Coverage

Bio/DB/Failover.pm
Criterion Covered Total %
statement 6 58 10.3
branch 0 20 0.0
condition 0 3 0.0
subroutine 2 7 28.5
pod 5 5 100.0
total 13 93 13.9


line stmt bran cond sub pod time code
1              
2             # POD documentation - main docs before the code
3              
4             =head1 NAME
5              
6             Bio::DB::Failover - A Bio::DB::RandomAccessI compliant class which
7             wraps a prioritized list of DBs
8              
9             =head1 SYNOPSIS
10              
11             $failover = Bio::DB::Failover->new();
12              
13             $failover->add_database($db);
14              
15             # fail over Bio::DB::RandomAccessI.pm
16              
17             # this will check each database in priority, returning when
18             # the first one succeeds
19              
20             $seq = $failover->get_Seq_by_id($id);
21              
22             =head1 DESCRIPTION
23              
24             This module provides fail over access to a set of Bio::DB::RandomAccessI
25             objects.
26              
27             =head1 CONTACT
28              
29             Ewan Birney Ebirney@ebi.ac.ukE originally wrote this class.
30              
31             =head2 Support
32              
33             Please direct usage questions or support issues to the mailing list:
34              
35             I
36              
37             rather than to the module maintainer directly. Many experienced and
38             reponsive experts will be able look at the problem and quickly
39             address it. Please include a thorough description of the problem
40             with code and data examples if at all possible.
41              
42             =head2 Reporting Bugs
43              
44             Report bugs to the Bioperl bug tracking system to help us keep track
45             the bugs and their resolution. Bug reports can be submitted via the
46             web:
47              
48             https://github.com/bioperl/bioperl-live/issues
49              
50             =head1 APPENDIX
51              
52             The rest of the documentation details each of the object
53             methods. Internal methods are usually preceded with a _
54              
55             =cut
56              
57             # Let the code begin...
58              
59             package Bio::DB::Failover;
60              
61 1     1   3 use strict;
  1         0  
  1         25  
62              
63 1     1   3 use base qw(Bio::Root::Root Bio::DB::RandomAccessI);
  1         1  
  1         310  
64              
65             sub new {
66 0     0 1   my ($class,@args) = @_;
67              
68 0           my $self = $class->SUPER::new(@args);
69              
70 0           $self->{'_database'} = [];
71 0           return $self;
72             }
73              
74             =head2 add_database
75              
76             Title : add_database
77             Usage : add_database(%db)
78             Function: Adds a database to the Failover object
79             Returns : Count of number of databases
80             Args : Array of db resources
81             Throws : Not a RandomAccessI exception
82              
83             =cut
84              
85             sub add_database {
86 0     0 1   my ($self,@db) = @_;
87 0           for my $db ( @db ) {
88 0 0 0       if ( !ref $db || !$db->isa('Bio::DB::RandomAccessI') ) {
89 0           $self->throw("Database object $db is a not a Bio::DB::RandomAccessI");
90 0           next;
91             }
92              
93 0           push(@{$self->{'_database'}},$db);
  0            
94             }
95 0           scalar @{$self->{'_database'}};
  0            
96             }
97              
98              
99             =head2 get_Seq_by_id
100              
101             Title : get_Seq_by_id
102             Usage : $seq = $db->get_Seq_by_id('ROA1_HUMAN')
103             Function: Gets a Bio::Seq object by its name
104             Returns : a Bio::Seq object
105             Args : the id (as a string) of a sequence
106             Throws : "no id" exception
107              
108             =cut
109              
110             sub get_Seq_by_id {
111 0     0 1   my ($self,$id) = @_;
112              
113 0 0         if( !defined $id ) {
114 0           $self->throw("no id is given!");
115             }
116              
117 0           foreach my $db ( @{$self->{'_database'}} ) {
  0            
118 0           my $seq;
119              
120 0           eval {
121 0           $seq = $db->get_Seq_by_id($id);
122             };
123 0 0         $self->warn($@) if $@;
124 0 0         if ( defined $seq ) {
125 0           return $seq;
126             } else {
127 0           $self->warn("No sequence retrieved by database " . ref($db));
128             }
129             }
130              
131 0           return;
132             }
133              
134             =head2 get_Seq_by_acc
135              
136             Title : get_Seq_by_acc
137             Usage : $seq = $db->get_Seq_by_acc('X77802');
138             Function: Gets a Bio::Seq object by accession number
139             Returns : A Bio::Seq object
140             Args : accession number (as a string)
141             Throws : "no id" exception
142              
143             =cut
144              
145             sub get_Seq_by_acc {
146 0     0 1   my ($self,$id) = @_;
147              
148 0 0         if( !defined $id ) {
149 0           $self->throw("no id is given!");
150             }
151              
152 0           foreach my $db ( @{$self->{'_database'}} ) {
  0            
153 0           my $seq;
154 0           eval {
155 0           $seq = $db->get_Seq_by_acc($id);
156             };
157 0 0         $self->warn($@) if $@;
158 0 0         if ( defined $seq ) {
159 0           return $seq;
160             } else {
161 0           $self->warn("No sequence retrieved by database " . ref($db));
162             }
163             }
164 0           return;
165             }
166              
167             =head2 get_Seq_by_version
168              
169             Title : get_Seq_by_version
170             Usage : $seq = $db->get_Seq_by_acc('X77802.2');
171             Function: Gets a Bio::Seq object by versioned accession number
172             Returns : A Bio::Seq object
173             Args : accession number (as a string)
174             Throws : "acc does not exist" exception
175              
176             =cut
177              
178             sub get_Seq_by_version {
179 0     0 1   my ($self,$id) = @_;
180              
181 0 0         if( !defined $id ) {
182 0           $self->throw("no acc is given!");
183             }
184              
185 0           foreach my $db ( @{$self->{'_database'}} ) {
  0            
186 0           my $seq;
187 0           eval {
188 0           $seq = $db->get_Seq_by_version($id);
189             };
190 0 0         $self->warn($@) if $@;
191 0 0         if ( defined $seq ) {
192 0           return $seq;
193             } else {
194 0           $self->warn("No sequence retrieved by database " . ref($db));
195             }
196             }
197 0           return;
198             }
199              
200             ## End of Package
201              
202             1;
203              
204             __END__