Bio/DB/DBFetch.pm

filter: Statementstmt 17.1% 17 / 99 Branchbran 0.0% 0 / 46 Conditioncond 0.0% 0 / 15 MC/DCmcdc 0.0% 0 / 10 Subroutinesub 31.2% 5 / 16 Podpod 100% 11 / 11 totaltotal 16.7% 33 / 197 CC 30 SCAR 32.4
CC
30
Cov
11%
postprocess_data
56.0
hostlocation
42.0
get_request
30.0
CRAP 25.6
« Bio/Tools/Coil.pm ↑ Summary Bio/Search/Processor.pm »
1 #
2 # BioPerl module for Bio::DB::DBFetch
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
7 #
8 # Copyright Heikki Lehvaslaiho
9 #
10 # You may distribute this module under the same terms as perl itself
11  
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::DB::DBFetch - Database object for retrieving using the dbfetch script
17  
18 =head1 SYNOPSIS
19  
20 #do not use this module directly
21  
22 =head1 DESCRIPTION
23  
24 Allows the dynamic retrieval of entries from databases using the
25 dbfetch script at EBI:
26 L<http:E<sol>E<sol>www.ebi.ac.ukE<sol>cgi-binE<sol>dbfetch>.
27  
28 In order to make changes transparent we have host type (currently only
29 ebi) and location (defaults to ebi) separated out. This allows later
30 additions of more servers in different geographical locations.
31  
32 This is a superclass which is called by instantiable subclasses with
33 correct parameters.
34  
35 =head1 FEEDBACK
36  
37 =head2 Mailing Lists
38  
39 User feedback is an integral part of the evolution of this and other
40 Bioperl modules. Send your comments and suggestions preferably to one
41 of the Bioperl mailing lists. Your participation is much appreciated.
42  
43 bioperl-l@bioperl.org - General discussion
44 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
45  
46 =head2 Support
47  
48 Please direct usage questions or support issues to the mailing list:
49  
50 I<bioperl-l@bioperl.org>
51  
52 rather than to the module maintainer directly. Many experienced and
53 reponsive experts will be able look at the problem and quickly
54 address it. Please include a thorough description of the problem
55 with code and data examples if at all possible.
56  
57 =head2 Reporting Bugs
58  
59 Report bugs to the Bioperl bug tracking system to help us keep track
60 the bugs and their resolution. Bug reports can be submitted via the
61 web:
62  
63 https://github.com/bioperl/bioperl-live/issues
64  
65 =head1 AUTHOR - Heikki Lehvaslaiho
66  
67 Email Heikki Lehvaslaiho E<lt>heikki-at-bioperl-dot-orgE<gt>
68  
69 =head1 APPENDIX
70  
71 The rest of the documentation details each of the object
72 methods. Internal methods are usually preceded with a _
73  
74 =cut
75  
76 # Let the code begin...
77  
78 package Bio::DB::DBFetch;
79 1 $Bio::DB::DBFetch::VERSION = '1.7.8';
80 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
81 1 ▶use vars qw($MODVERSION $DEFAULTFORMAT $DEFAULTLOCATION
Subroutine BEGIN: called CC=1 SCAR=0.0
82 1 $DEFAULTSERVERTYPE);
83  
84 1 $MODVERSION = '0.1';
85 1 ▶use HTTP::Request::Common;
Subroutine BEGIN: called CC=1 SCAR=0.0
86  
87 1 ▶use base qw(Bio::DB::WebDBSeqI);
Subroutine BEGIN: called CC=1 SCAR=0.0
88  
89 # the new way to make modules a little more lightweight
90  
91 1 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
92 # global vars
93 1 $DEFAULTSERVERTYPE = 'dbfetch';
94 1 $DEFAULTLOCATION = 'ebi';
95 }
96  
97  
98 =head1 Routines from Bio::DB::WebDBSeqI
99  
100 =head2 get_request
101  
102 Title : get_request
103 Usage : my $url = $self->get_request
104 Function: returns a HTTP::Request object
105 Returns :
106 Args : %qualifiers = a hash of qualifiers (ids, format, etc)
107  
108 =cut
109  
110 0 ▶sub get_request {
Subroutine get_request: not called CC=5 SCAR=34.0
Pod documented
111 0 my ($self, @qualifiers) = @_;
112 0 my ($uids, $format) = $self->_rearrange([qw(UIDS FORMAT)],
113 @qualifiers);
114  
115 0 ▶ $self->throw("Must specify a value for UIDs to fetch")
Branch: 1 branch
BranchTrueFalseTotal
unless defined $uids 0 0 0
116 unless defined $uids;
117 0 my $tmp;
118 0 my $format_string = '';
119 0 ▶ $format ||= $self->default_format;
Condition0%0/3
$format ||= $self->default_format
l!l&&r!l&&!r
000
MC/DC0%0/2
$format ||= $self->default_format
$format $self->default_format
Truth table0%0/3
A ||= B
A= $formatB= $self->default_format
ABresult
1X1
011
000
120 0 ($format, $tmp) = $self->request_format($format);
121 0 $format_string = "&format=$format";
122 0 my $url = $self->location_url();
123 0 my $uid;
124 0 ▶ if( ref($uids) =~ /ARRAY/i ) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref($uids) =~ /ARRAY/i) { } 0 0 0
125 0 $uid = join (',', @$uids);
126 0 ▶ $self->warn ('The server will accept maximum of 50 entries in a request. The rest are ignored.')
Branch: 1 branch
BranchTrueFalseTotal
if scalar @$uids > 50 0 0 0
127 if scalar @$uids >50;
128 } else {
129 0 $uid = $uids;
130 }
131  
132 0 return GET $url. $format_string. '&id='. $uid;
133 }
134  
135  
136 =head2 postprocess_data
137  
138 Title : postprocess_data
139 Usage : $self->postprocess_data ( 'type' => 'string',
140 'location' => \$datastr);
141 Function: process downloaded data before loading into a Bio::SeqIO
142 Returns : void
143 Args : hash with two keys - 'type' can be 'string' or 'file'
144 - 'location' either file location or string
145 reference containing data
146  
147 =cut
148  
149 # remove occasional blank lines at top of web output
150 0 ▶sub postprocess_data {
Subroutine postprocess_data: not called CC=7 SCAR=40.3
Pod documented
151 0 my ($self, %args) = @_;
152 0 ▶ if ($args{type} eq 'string') {
Branch: 2 branches
BranchTrueFalseTotal
if ($args{'type'} eq 'string') { } 0 0 0
elsif ($args{'type'} eq 'file') { } 0 0 0
153 0 ${$args{location}} =~ s/^\s+//; # get rid of leading whitespace
154 }
155 elsif ($args{type} eq 'file') {
156 0 my $F;
157 0 ▶ open $F,"<", $args{location} or $self->throw("Cannot open $args{location}: $!");
Branch: 1 branch
BranchTrueFalseTotal
open $F, "<", $args{"location"} or $self->throw(qq[Cannot open $args{"location"}: $!]) 0 0 0
158 0 my @data = <$F>;
159 0 for (@data) {
160 0 ▶ last unless /^\s+$/;
Branch: 1 branch
BranchTrueFalseTotal
unless /^\s+$/ 0 0 0
161 0 shift @data;
162 }
163 0 ▶ open $F,">", $args{location} or $self->throw("Cannot write to $args{location}: $!");
Branch: 1 branch
BranchTrueFalseTotal
open $F, ">", $args{"location"} or $self->throw(qq[Cannot write to $args{"location"}: $!]) 0 0 0
164 0 print $F @data;
165 0 close $F;
166 }
167 }
168  
169 =head2 default_format
170  
171 Title : default_format
172 Usage : my $format = $self->default_format
173 Function: Returns default sequence format for this module
174 Returns : string
175 Args : none
176  
177 =cut
178  
179 0 ▶sub default_format {
Subroutine default_format: not called CC=1 SCAR=6.9
Pod documented
180 0 my ($self) = @_;
181 0 return $self->{'_default_format'};
182 }
183  
184 =head1 Bio::DB::DBFetch specific routines
185  
186 =head2 get_Stream_by_id
187  
188 Title : get_Stream_by_id
189 Usage : $seq = $db->get_Stream_by_id($ref);
190 Function: Retrieves Seq objects from the server 'en masse', rather than one
191 at a time. For large numbers of sequences, this is far superior
192 than get_Stream_by_[id/acc]().
193 Example :
194 Returns : a Bio::SeqIO stream object
195 Args : $ref : either an array reference, a filename, or a filehandle
196 from which to get the list of unique ids/accession numbers.
197  
198 NOTE: for backward compatibility, this method is also called
199 get_Stream_by_batch.
200  
201 =cut
202  
203 0 ▶sub get_Stream_by_id {
Subroutine get_Stream_by_id: not called CC=1 SCAR=6.9
Pod documented
204 0 my ($self, $ids) = @_;
205 0 return $self->get_seq_stream('-uids' => $ids, '-mode' => 'batch');
206 }
207  
208 =head2 get_Seq_by_version
209  
210 Title : get_Seq_by_version
211 Usage : $seq = $db->get_Seq_by_version('X77802.1');
212 Function: Gets a Bio::Seq object by accession number
213 Returns : A Bio::Seq object
214 Args : version number (as a string)
215 Throws : "version does not exist" exception
216  
217 =cut
218  
219 0 ▶sub get_Seq_by_version {
Subroutine get_Seq_by_version: not called CC=2 SCAR=17.9
Pod documented
220 0 my ($self,$seqid) = @_;
221 0 my $seqio = $self->get_Stream_by_acc([$seqid]);
222 0 ▶ $self->throw("version does not exist") if( !defined $seqio );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $seqio 0 0 0
223 0 return $seqio->next_seq();
224 }
225  
226 =head2 request_format
227  
228 Title : request_format
229 Usage : my ($req_format, $ioformat) = $self->request_format;
230 $self->request_format("genbank");
231 $self->request_format("fasta");
232 Function: Get/Set sequence format retrieval. The get-form will normally not
233 be used outside of this and derived modules.
234 Returns : Array of two strings, the first representing the format for
235 retrieval, and the second specifying the corresponding SeqIO format.
236 Args : $format = sequence format
237  
238 =cut
239  
240 0 ▶sub request_format {
Subroutine request_format: not called CC=4 SCAR=30.0
Pod documented
241 0 my ($self, $value) = @_;
242 0 ▶ if( defined $value ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 0 0 0
243 0 $value = lc $value;
244 0 $self->{'_format'} = $value;
245 0 return ($value, $value);
246 }
247 0 $value = $self->{'_format'};
248 0 ▶ if( $value and defined $self->formatmap->{$value} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($value and defined $self->formatmap->{$value}) { } 0 0 0
Condition0%0/3
$value and defined $self->formatmap->{$value}
!ll&&!rl&&r
000
MC/DC0%0/2
$value and defined $self->formatmap->{$value}
$value defined $self->formatmap->{$value}
Truth table0%0/3
A and B
A= $valueB= defined $self->formatmap->{$value}
ABresult
0X0
100
111
249 0 return ($value, $self->formatmap->{$value});
250 } else {
251 # Try to fall back to a default.
252 0 return ($self->default_format, $self->default_format );
253 }
254 }
255  
256  
257 =head2 servertype
258  
259 Title : servertype
260 Usage : my $servertype = $self->servertype
261 $self->servertype($servertype);
262 Function: Get/Set server type
263 Returns : string
264 Args : server type string [optional]
265  
266 =cut
267  
268 0 ▶sub servertype {
Subroutine servertype: not called CC=5 SCAR=34.0
Pod documented
269 0 my ($self, $servertype) = @_;
270 0 ▶ if( defined $servertype && $servertype ne '') {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $servertype and $servertype ne "") 0 0 0
Condition0%0/3
defined $servertype and $servertype ne ""
!ll&&!rl&&r
000
MC/DC0%0/2
defined $servertype and $servertype ne ""
defined $servertype $servertype ne ""
Truth table0%0/3
A and B
A= defined $servertypeB= $servertype ne ""
ABresult
0X0
100
111
271 $self->throw("You gave an invalid server type ($servertype)".
272 " - available types are ".
273 0 ▶ keys %{$self->hosts}) unless( $self->hosts->{$servertype} );
Branch: 1 branch
BranchTrueFalseTotal
unless $self->hosts->{$servertype} 0 0 0
274 0 $self->{'_servertype'} = $servertype;
275 }
276 0 ▶ $self->{'_servertype'} = $DEFAULTSERVERTYPE unless $self->{'_servertype'};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"_servertype"} 0 0 0
277 0 return $self->{'_servertype'};
278 }
279  
280 =head2 hostlocation
281  
282 Title : hostlocation
283 Usage : my $location = $self->hostlocation()
284 $self->hostlocation($location)
285 Function: Set/Get Hostlocation
286 Returns : string representing hostlocation
287 Args : string specifying hostlocation [optional]
288  
289 =cut
290  
291 0 ▶sub hostlocation {
Subroutine hostlocation: not called CC=6 SCAR=37.4
Pod documented
292 0 my ($self, $location ) = @_;
293 0 my $servertype = $self->servertype;
294 0 ▶ $self->throw("Must have a valid servertype defined not $servertype")
Branch: 1 branch
BranchTrueFalseTotal
unless defined $servertype 0 0 0
295 unless defined $servertype;
296 0 my %hosts = %{$self->hosts->{$servertype}->{'hosts'}};
297 0 ▶ if( defined $location && $location ne '' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $location and $location ne "") 0 0 0
Condition0%0/3
defined $location and $location ne ""
!ll&&!rl&&r
000
MC/DC0%0/2
defined $location and $location ne ""
defined $location $location ne ""
Truth table0%0/3
A and B
A= defined $locationB= $location ne ""
ABresult
0X0
100
111
298 0 $location = lc $location;
299 0 ▶ if( ! $hosts{$location} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($hosts{$location}) 0 0 0
300 0 $self->throw("Must specify a known host, not $location,".
301 " possible values (".
302 join(",", sort keys %hosts ). ")");
303 }
304 0 $self->{'_hostlocation'} = $location;
305 }
306 0 ▶ $self->{'_hostlocation'} = $DEFAULTLOCATION unless $self->{'_hostlocation'};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"_hostlocation"} 0 0 0
307 0 return $self->{'_hostlocation'};
308 }
309  
310 =head2 location_url
311  
312 Title : location
313 Usage : my $url = $self->location_url()
314 Function: Get host url
315 Returns : string representing url
316 Args : none
317  
318 =cut
319  
320 0 ▶sub location_url {
Subroutine location_url: not called CC=3 SCAR=24.8
Pod documented
321 0 my ($self) = @_;
322 0 my $servertype = $self->servertype();
323 0 my $location = $self->hostlocation();
324 0 ▶ if( ! defined $location || !defined $servertype ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $location and defined $servertype) 0 0 0
Condition0%0/3
defined $location and defined $servertype
!ll&&!rl&&r
000
MC/DC0%0/2
defined $location and defined $servertype
defined $location defined $servertype
Truth table0%0/3
A and B
A= defined $locationB= defined $servertype
ABresult
0X0
100
111
325 0 $self->throw("must have a valid hostlocation and servertype set before calling location_url");
326 }
327 return sprintf($self->hosts->{$servertype}->{'baseurl'},
328 0 $self->hosts->{$servertype}->{'hosts'}->{$location});
329 }
330  
331 =head1 Bio::DB::DBFetch routines
332  
333 These methods allow subclasses to pass parameters.
334  
335 =head2 hosts
336  
337 Title : hosts
338 Usage :
339 Function: get/set for host hash
340 Returns :
341 Args : optional hash
342  
343 =cut
344  
345 0 ▶sub hosts {
Subroutine hosts: not called CC=3 SCAR=24.8
Pod documented
346 0 my ($self, $value) = @_;
347 0 ▶ if (defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 0 0 0
348 0 $self->{'_hosts'} = $value;
349 }
350 0 ▶ unless (exists $self->{'_hosts'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $self->{'_hosts'}) { } 0 0 0
351 0 return ('');
352 } else {
353 0 return $self->{'_hosts'};
354 }
355 }
356  
357 =head2 formatmap
358  
359 Title : formatmap
360 Usage :
361 Function: get/set for format hash
362 Returns :
363 Args : optional hash
364  
365 =cut
366  
367 0 ▶sub formatmap {
Subroutine formatmap: not called CC=3 SCAR=24.8
Pod documented
368 0 my ($self, $value) = @_;
369 0 ▶ if (defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 0 0 0
370 0 $self->{'_formatmap'} = $value;
371 }
372 0 ▶ unless (exists $self->{'_formatmap'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $self->{'_formatmap'}) { } 0 0 0
373 0 return ('');
374 } else {
375 0 return $self->{'_formatmap'};
376 }
377 }
378  
379  
380 1 1;
381 __END__
« Bio/Tools/Coil.pm ↑ Summary Bio/Search/Processor.pm »