|
0
|
1 #-----------------------------------------------------------------
|
|
|
2 # $Id: HitFactoryI.pm,v 1.6 2002/10/22 07:38:32 lapp Exp $
|
|
|
3 #
|
|
|
4 # BioPerl module for Bio::Factory::HitFactoryI
|
|
|
5 #
|
|
|
6 # Cared for by Steve Chervitz <sac@bioperl.org>
|
|
|
7 #
|
|
|
8 # You may distribute this module under the same terms as perl itself
|
|
|
9 #-----------------------------------------------------------------
|
|
|
10
|
|
|
11 # POD documentation - main docs before the code
|
|
|
12
|
|
|
13 =head1 NAME
|
|
|
14
|
|
|
15 Bio::Factory::HitFactoryI - Interface for an object that builds Bio::Search::Hit::HitI objects
|
|
|
16
|
|
|
17 =head1 SYNOPSIS
|
|
|
18
|
|
|
19 To be completed.
|
|
|
20
|
|
|
21 =head1 DESCRIPTION
|
|
|
22
|
|
|
23 To be completed.
|
|
|
24
|
|
|
25 =head1 FEEDBACK
|
|
|
26
|
|
|
27 =head2 Mailing Lists
|
|
|
28
|
|
|
29 User feedback is an integral part of the evolution of this
|
|
|
30 and other Bioperl modules. Send your comments and suggestions preferably
|
|
|
31 to one of the Bioperl mailing lists.
|
|
|
32 Your participation is much appreciated.
|
|
|
33
|
|
|
34 bioperl-l@bioperl.org - General discussion
|
|
|
35 http://bio.perl.org/MailList.html - About the mailing lists
|
|
|
36
|
|
|
37 =head2 Reporting Bugs
|
|
|
38
|
|
|
39 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
40 the bugs and their resolution. Bug reports can be submitted via email
|
|
|
41 or the web:
|
|
|
42
|
|
|
43 bioperl-bugs@bio.perl.org
|
|
|
44 http://bugzilla.bioperl.org/
|
|
|
45
|
|
|
46 =head1 AUTHOR
|
|
|
47
|
|
|
48 Steve Chervitz E<lt>sac@bioperl.orgE<gt>
|
|
|
49
|
|
|
50 See L<the FEEDBACK section | FEEDBACK> for where to send bug reports and comments.
|
|
|
51
|
|
|
52 =head1 COPYRIGHT
|
|
|
53
|
|
|
54 Copyright (c) 2001 Steve Chervitz. All Rights Reserved.
|
|
|
55
|
|
|
56 =head1 DISCLAIMER
|
|
|
57
|
|
|
58 This software is provided "as is" without warranty of any kind.
|
|
|
59
|
|
|
60 =head1 APPENDIX
|
|
|
61
|
|
|
62 The rest of the documentation details each of the object methods.
|
|
|
63
|
|
|
64 =cut
|
|
|
65
|
|
|
66 #'
|
|
|
67
|
|
|
68 package Bio::Factory::HitFactoryI;
|
|
|
69
|
|
|
70 use strict;
|
|
|
71 use Bio::Root::RootI;
|
|
|
72
|
|
|
73 use vars qw(@ISA);
|
|
|
74
|
|
|
75 @ISA = qw(Bio::Root::RootI);
|
|
|
76
|
|
|
77 =head2 create_hit
|
|
|
78
|
|
|
79 Title : create_hit
|
|
|
80 Usage : $hit = $factory->create_hit( %params );
|
|
|
81 Function: Creates a new Bio::Search::Hit::HitI object.
|
|
|
82 Returns : An object that implements the Bio::Search::Hit::HitI interface
|
|
|
83 Args : Named parameters (to be defined)
|
|
|
84
|
|
|
85 =cut
|
|
|
86
|
|
|
87 sub create_hit {
|
|
|
88 my ($self, @args) = @_;
|
|
|
89 $self->throw_not_implemented;
|
|
|
90 }
|
|
|
91
|
|
|
92
|
|
|
93 1;
|
