Bio/Factory/LocationFactoryI.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Factory::LocationFactoryI
   4 #
   5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   6 #
   7 # Cared for by Hilmar Lapp <hlapp at gmx.net>
   8 #
   9 # Copyright Hilmar Lapp
  10 #
  11 # You may distribute this module under the same terms as perl itself
  12
  13 #
  14 # (c) Hilmar Lapp, hlapp at gnf.org, 2002.
  15 # (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002.
  16 #
  17 # You may distribute this module under the same terms as perl itself.
  18 # Refer to the Perl Artistic License (see the license accompanying this
  19 # software package, or see http://www.perl.com/language/misc/Artistic.html)
  20 # for the terms under which you may use, modify, and redistribute this module.
  21 #
  22 # THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
  23 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  24 # MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  25 #
  26
  27 # POD documentation - main docs before the code
  28
  29 =head1 NAME
  30
  31 Bio::Factory::LocationFactoryI - A factory interface for generating locations from a string
  32
  33 =head1 SYNOPSIS
  34
  35  # Do not use directly, see Bio::Factory::LocationFactory for example
  36  use Bio::Factory::FTLocationFactory;
  37  my $locfact = Bio::Factory::FTLocationFactory->new();
  38  my $location = $locfact->from_string("1..200");
  39  print $location->start(), " ", $location->end(), " ", $location->strand,"\n";
  40
  41 =head1 DESCRIPTION
  42
  43 An interface for Location Factories which generate Bio::LocationI
  44 objects from a string.
  45
  46 =head1 FEEDBACK
  47
  48 =head2 Mailing Lists
  49
  50 User feedback is an integral part of the evolution of this and other
  51 Bioperl modules. Send your comments and suggestions preferably to
  52 the Bioperl mailing list.  Your participation is much appreciated.
  53
  54   bioperl-l@bioperl.org                  - General discussion
  55   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  56
  57 =head2 Support
  58
  59 Please direct usage questions or support issues to the mailing list:
  60
  61 L<bioperl-l@bioperl.org>
  62
  63 rather than to the module maintainer directly. Many experienced and
  64 reponsive experts will be able look at the problem and quickly
  65 address it. Please include a thorough description of the problem
  66 with code and data examples if at all possible.
  67
  68 =head2 Reporting Bugs
  69
  70 Report bugs to the Bioperl bug tracking system to help us keep track
  71 of the bugs and their resolution. Bug reports can be submitted via the
  72 web:
  73
  74   http://bugzilla.open-bio.org/
  75
  76 =head1 AUTHOR - Hilmar Lapp
  77
  78 Email hlapp at gmx.net
  79
  80 =head1 APPENDIX
  81
  82 The rest of the documentation details each of the object methods.
  83 Internal methods are usually preceded with a _
  84
  85 =cut
  86
  87
  88 # Let the code begin...
  89
  90
  91 package Bio::Factory::LocationFactoryI;
  92 use strict;
  93 use Carp;
  94
  95 use base qw(Bio::Root::RootI);
  96
  97 =head2 from_string
  98
  99  Title   : from_string
 100  Usage   : $loc = $locfactory->from_string("100..200");
 101  Function: Parses the given string and returns a Bio::LocationI implementing
 102            object representing the location encoded by the string.
 103
 104            Different implementations may support different encodings. An
 105            example of a commonly used encoding is the Genbank feature table
 106            encoding of locations.
 107  Example :
 108  Returns : A Bio::LocationI implementing object.
 109  Args    : A string.
 110
 111
 112 =cut
 113
 114 sub from_string{
 115     my ($self,@args) = @_;
 116
 117     $self->throw_not_implemented();
 118 }
 119
 120 1;