|
0
|
1 # $Id: LocationFactoryI.pm,v 1.2 2002/10/22 07:45:14 lapp Exp $
|
|
|
2 #
|
|
|
3 # BioPerl module for Bio::Factory::LocationFactoryI
|
|
|
4 #
|
|
|
5 # Cared for by Hilmar Lapp <hlapp at gmx.net>
|
|
|
6 #
|
|
|
7 # Copyright Hilmar Lapp
|
|
|
8 #
|
|
|
9 # You may distribute this module under the same terms as perl itself
|
|
|
10
|
|
|
11 #
|
|
|
12 # (c) Hilmar Lapp, hlapp at gnf.org, 2002.
|
|
|
13 # (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002.
|
|
|
14 #
|
|
|
15 # You may distribute this module under the same terms as perl itself.
|
|
|
16 # Refer to the Perl Artistic License (see the license accompanying this
|
|
|
17 # software package, or see http://www.perl.com/language/misc/Artistic.html)
|
|
|
18 # for the terms under which you may use, modify, and redistribute this module.
|
|
|
19 #
|
|
|
20 # THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
|
|
|
21 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
|
|
|
22 # MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
23 #
|
|
|
24
|
|
|
25 # POD documentation - main docs before the code
|
|
|
26
|
|
|
27 =head1 NAME
|
|
|
28
|
|
|
29 Bio::Factory::LocationFactoryI - DESCRIPTION of Interface
|
|
|
30
|
|
|
31 =head1 SYNOPSIS
|
|
|
32
|
|
|
33 Give standard usage here
|
|
|
34
|
|
|
35 =head1 DESCRIPTION
|
|
|
36
|
|
|
37 Describe the interface here
|
|
|
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
|
|
|
45 the Bioperl mailing list. Your participation is much appreciated.
|
|
|
46
|
|
|
47 bioperl-l@bioperl.org - General discussion
|
|
|
48 http://bioperl.org/MailList.shtml - About the mailing lists
|
|
|
49
|
|
|
50 =head2 Reporting Bugs
|
|
|
51
|
|
|
52 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
53 of the bugs and their resolution. Bug reports can be submitted via
|
|
|
54 email or the web:
|
|
|
55
|
|
|
56 bioperl-bugs@bioperl.org
|
|
|
57 http://bugzilla.bioperl.org/
|
|
|
58
|
|
|
59 =head1 AUTHOR - Hilmar Lapp
|
|
|
60
|
|
|
61 Email hlapp at gmx.net
|
|
|
62
|
|
|
63 =head1 CONTRIBUTORS
|
|
|
64
|
|
|
65 Additional contributors names and emails here
|
|
|
66
|
|
|
67 =head1 APPENDIX
|
|
|
68
|
|
|
69 The rest of the documentation details each of the object methods.
|
|
|
70 Internal methods are usually preceded with a _
|
|
|
71
|
|
|
72 =cut
|
|
|
73
|
|
|
74
|
|
|
75 # Let the code begin...
|
|
|
76
|
|
|
77
|
|
|
78 package Bio::Factory::LocationFactoryI;
|
|
|
79 use vars qw(@ISA);
|
|
|
80 use strict;
|
|
|
81 use Carp;
|
|
|
82 use Bio::Root::RootI;
|
|
|
83
|
|
|
84 @ISA = qw( Bio::Root::RootI );
|
|
|
85
|
|
|
86 =head2 from_string
|
|
|
87
|
|
|
88 Title : from_string
|
|
|
89 Usage : $loc = $locfactory->from_string("100..200");
|
|
|
90 Function: Parses the given string and returns a Bio::LocationI implementing
|
|
|
91 object representing the location encoded by the string.
|
|
|
92
|
|
|
93 Different implementations may support different encodings. An
|
|
|
94 example of a commonly used encoding is the Genbank feature table
|
|
|
95 encoding of locations.
|
|
|
96 Example :
|
|
|
97 Returns : A Bio::LocationI implementing object.
|
|
|
98 Args : A string.
|
|
|
99
|
|
|
100
|
|
|
101 =cut
|
|
|
102
|
|
|
103 sub from_string{
|
|
|
104 my ($self,@args) = @_;
|
|
|
105
|
|
|
106 $self->throw_not_implemented();
|
|
|
107 }
|
