Bio/Factory/LocationFactoryI.pm

   1 # $Id$
   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 - A factory interface for generating locations from a string
  30
  31 =head1 SYNOPSIS
  32
  33  # Do not use directly, see Bio::Factory::LocationFactory for example
  34  use Bio::Factory::FTLocationFactory;
  35  my $locfact = Bio::Factory::FTLocationFactory->new();
  36  my $location = $locfact->from_string("1..200");
  37  print $location->start(), " ", $location->end(), " ", $location->strand,"\n";
  38
  39 =head1 DESCRIPTION
  40
  41 An interface for Location Factories which generate Bio::LocationI
  42 objects from a string.
  43
  44 =head1 FEEDBACK
  45
  46 =head2 Mailing Lists
  47
  48 User feedback is an integral part of the evolution of this and other
  49 Bioperl modules. Send your comments and suggestions preferably to
  50 the Bioperl mailing list.  Your participation is much appreciated.
  51
  52   bioperl-l@bioperl.org                  - General discussion
  53   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  54
  55 =head2 Reporting Bugs
  56
  57 Report bugs to the Bioperl bug tracking system to help us keep track
  58 of the bugs and their resolution. Bug reports can be submitted via the
  59 web:
  60
  61   http://bugzilla.open-bio.org/
  62
  63 =head1 AUTHOR - Hilmar Lapp
  64
  65 Email hlapp at gmx.net
  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 strict;
  80 use Carp;
  81
  82 use base qw(Bio::Root::RootI);
  83
  84 =head2 from_string
  85
  86  Title   : from_string
  87  Usage   : $loc = $locfactory->from_string("100..200");
  88  Function: Parses the given string and returns a Bio::LocationI implementing
  89            object representing the location encoded by the string.
  90
  91            Different implementations may support different encodings. An
  92            example of a commonly used encoding is the Genbank feature table
  93            encoding of locations.
  94  Example :
  95  Returns : A Bio::LocationI implementing object.
  96  Args    : A string.
  97
  98
  99 =cut
 100
 101 sub from_string{
 102     my ($self,@args) = @_;
 103
 104     $self->throw_not_implemented();
 105 }
 106
 107 1;