Bio/DBLinkContainerI.pm

filter: Statementstmt 78.5% 11 / 14 Branchbran n/a Conditioncond 0.0% 0 / 3 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 75.0% 3 / 4 Podpod 100% 1 / 1 totaltotal 62.5% 15 / 24 CC 2 SCAR 11.0
CC
2
Cov
65%
each_DBLink
6.0
BEGIN
1.0
BEGIN
1.0
CRAP 3.0
« Bio/Search/BlastStatistics.pm ↑ Summary Bio/Tools/Phylo/Gerp.pm »
1 #
2 # BioPerl module for Bio::DBLinkContainerI
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::DBLinkContainerI - Abstract interface for any object wanting to use
17 database cross references
18  
19 =head1 SYNOPSIS
20  
21 # get an objects containing database cross reference
22  
23 foreach $obj ( @objs ) {
24 if( $obj->isa('Bio::DBLinkContainerI') ) {
25 foreach $dblink ( $obj->each_DBLink() ) {
26 # do stuff
27 }
28 }
29 }
30  
31 =head1 DESCRIPTION
32  
33 This interface defines the functions one can expect for any object
34 wanting to use database cross-references. This class does not actually
35 provide any implementation, it just provides the definitions of what
36 methods one can call.
37  
38 The database cross-references are implemented as L<Bio::Annotation::DBLink>
39 objects.
40  
41 =head1 FEEDBACK
42  
43 =head2 Mailing Lists
44  
45 User feedback is an integral part of the evolution of this and other
46 Bioperl modules. Send your comments and suggestions preferably to one
47 of the Bioperl mailing lists. Your participation is much appreciated.
48  
49 bioperl-l@bioperl.org - General discussion
50 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
51  
52 =head2 Support
53  
54 Please direct usage questions or support issues to the mailing list:
55  
56 I<bioperl-l@bioperl.org>
57  
58 rather than to the module maintainer directly. Many experienced and
59 reponsive experts will be able look at the problem and quickly
60 address it. Please include a thorough description of the problem
61 with code and data examples if at all possible.
62  
63 =head2 Reporting Bugs
64  
65 Report bugs to the Bioperl bug tracking system to help us keep track
66 the bugs and their resolution. Bug reports can be submitted via the
67 web:
68  
69 https://github.com/bioperl/bioperl-live/issues
70  
71 =head1 AUTHOR - Heikki Lehvaslaiho
72  
73 Email: heikki-at-bioperl-dot-org
74  
75 =head1 APPENDIX
76  
77 The rest of the documentation details each of the object
78 methods. Internal methods are usually preceded with a _
79  
80 =cut
81  
82 # Let the code begin...
83  
84 package Bio::DBLinkContainerI;
85 1 $Bio::DBLinkContainerI::VERSION = '1.7.8';
86 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
87  
88 1 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
89  
90 1 ▶use base qw(Bio::Root::RootI);
Subroutine BEGIN: called CC=1 SCAR=0.0
91  
92 =head2 each_DBLink
93  
94 Title : each_DBLink
95 Usage : foreach $ref ( $self->each_DBlink() )
96 Function: gets an array of DBlink of objects
97 Example :
98 Returns : an array of Bio::Annotation::DBLink objects
99 Args : none
100  
101  
102 =cut
103  
104 0 ▶sub each_DBLink{
Subroutine each_DBLink: not called CC=2 SCAR=17.9
Pod documented
105 0 my ($self) = @_;
106 0 ▶ my $class = ref($self) || $self;
Condition0%0/3
ref $self || $self
l!l&&r!l&&!r
000
MC/DC0%0/2
ref $self || $self
ref $self $self
Truth table0%0/3
A || B
A= ref $selfB= $self
ABresult
1X1
011
000
107 0 $self->throw("Class $class did not define method 'each_DBLink' for interface DBLinkContainerI");
108 }
109  
110 1 1;
111  
« Bio/Search/BlastStatistics.pm ↑ Summary Bio/Tools/Phylo/Gerp.pm »