Bio/Search/DatabaseI.pm

filter: Statementstmt 50.0% 8 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 33.3% 2 / 6 Podpod 100% 4 / 4 totaltotal 53.8% 14 / 26 CC 1 SCAR 5.1
CC
1
Cov
50%
name
2.0
date
2.0
letters
2.0
CRAP 1.7
« Bio/SeqFeature/Gene/GeneStructureI.pm ↑ Summary Bio/AnnotationI.pm »
1 #-----------------------------------------------------------------
2 #
3 # BioPerl module Bio::Search::DatabaseI
4 #
5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
6 #
7 # Cared for by Steve Chervitz <sac@bioperl.org>
8 #
9 # You may distribute this module under the same terms as perl itself
10 #-----------------------------------------------------------------
11  
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::Search::DatabaseI - Interface for a database used in a sequence search
17  
18 =head1 SYNOPSIS
19  
20 Bio::Search::DatabaseI objects should not be instantiated since this
21 module defines a pure interface.
22  
23 Given an object that implements the Bio::Search::DatabaseI interface,
24 you can do the following things with it:
25  
26 $name = $db->name();
27  
28 $date = $db->date();
29  
30 $num_letters = $db->letters();
31  
32 $num_entries = $db->entries();
33  
34 =head1 DESCRIPTION
35  
36 This module defines methods for an object that provides metadata
37 information about a database used for sequence searching.
38  
39 =head1 FEEDBACK
40  
41 =head2 Mailing Lists
42  
43 User feedback is an integral part of the evolution of this and other
44 Bioperl modules. Send your comments and suggestions preferably to one
45 of the Bioperl mailing lists. Your participation is much appreciated.
46  
47 bioperl-l@bioperl.org - General discussion
48 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
49  
50 =head2 Support
51  
52 Please direct usage questions or support issues to the mailing list:
53  
54 I<bioperl-l@bioperl.org>
55  
56 rather than to the module maintainer directly. Many experienced and
57 reponsive experts will be able look at the problem and quickly
58 address it. Please include a thorough description of the problem
59 with code and data examples if at all possible.
60  
61 =head2 Reporting Bugs
62  
63 Report bugs to the Bioperl bug tracking system to help us keep track
64 the bugs and their resolution. Bug reports can be submitted via the
65 web:
66  
67 https://github.com/bioperl/bioperl-live/issues
68  
69 =head1 AUTHOR
70  
71 Steve Chervitz E<lt>sac@bioperl.orgE<gt>
72  
73 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments.
74  
75 =head1 COPYRIGHT
76  
77 Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
78  
79 =head1 DISCLAIMER
80  
81 This software is provided "as is" without warranty of any kind.
82  
83 =cut
84  
85 =head1 APPENDIX
86  
87 The rest of the documentation details each of the object methods.
88  
89 =cut
90  
91 # Let the code begin...
92  
93 package Bio::Search::DatabaseI;
94 2 $Bio::Search::DatabaseI::VERSION = '1.7.8';
95 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
96  
97 2 ▶use base qw(Bio::Root::RootI);
Subroutine BEGIN: called CC=1 SCAR=0.0
98  
99  
100 =head2 name
101  
102 Usage : $name = $db->name();
103 Purpose : Get the name of the database searched.
104 Returns : String
105 Argument : n/a
106  
107 =cut
108  
109 0 ▶sub name {
Subroutine name: not called CC=1 SCAR=6.9
Pod documented
110 0 my $self = shift;
111 0 $self->throw_not_implemented;
112 }
113  
114 =head2 date
115  
116 Usage : $date = $db->date();
117 Purpose : Get the creation date of the queried database.
118 Returns : String
119 Argument : n/a
120  
121 =cut
122  
123 0 ▶sub date {
Subroutine date: not called CC=1 SCAR=6.9
Pod documented
124 0 my $self = shift;
125 0 $self->throw_not_implemented;
126 }
127  
128  
129 =head2 letters
130  
131 Usage : $num_letters = $db->letters();
132 Purpose : Get the number of letters in the queried database.
133 Returns : Integer
134 Argument : n/a
135  
136 =cut
137  
138 0 ▶sub letters {
Subroutine letters: not called CC=1 SCAR=6.9
Pod documented
139 0 my $self = shift;
140 0 $self->throw_not_implemented;
141 }
142  
143  
144 =head2 entries
145  
146 Usage : $num_entries = $db->entries();
147 Purpose : Get the number of entries in the queried database.
148 Returns : Integer
149 Argument : n/a
150  
151 =cut
152  
153 0 ▶sub entries {
Subroutine entries: not called CC=1 SCAR=6.9
Pod documented
154 0 my $self = shift;
155 0 $self->throw_not_implemented;
156 }
157  
158 2 1;
« Bio/SeqFeature/Gene/GeneStructureI.pm ↑ Summary Bio/AnnotationI.pm »