Bio/Factory/MapFactoryI.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Factory::MapFactoryI
   4 #
   5 # Cared for by Jason Stajich <jason@bioperl.org>
   6 #
   7 # Copyright Jason Stajich
   8 #
   9 # You may distribute this module under the same terms as perl itself
  10
  11 # POD documentation - main docs before the code
  12
  13 =head1 NAME
  14
  15 Bio::Factory::MapFactoryI - A Factory for getting markers
  16
  17 =head1 SYNOPSIS
  18
  19     # get a Map Factory somehow likely from Bio::MapIO system
  20
  21     while( my $map = $mapin->next_map ) {
  22         print "map name is ", $map->name, " length is ",
  23             $map->length, " ", $map->units, "\n";
  24         $mapout->write_map($map);
  25     }
  26
  27 =head1 DESCRIPTION
  28
  29 This interface describes the necessary minimum methods for getting
  30 Maps from a data stream.  It also supports writing Map data back to a
  31 stream.
  32
  33 =head1 FEEDBACK
  34
  35 =head2 Mailing Lists
  36
  37 User feedback is an integral part of the evolution of this and other
  38 Bioperl modules. Send your comments and suggestions preferably to
  39 the Bioperl mailing list.  Your participation is much appreciated.
  40
  41   bioperl-l@bioperl.org                  - General discussion
  42   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  43
  44 =head2 Reporting Bugs
  45
  46 Report bugs to the Bioperl bug tracking system to help us keep track
  47 of the bugs and their resolution. Bug reports can be submitted via the
  48 web:
  49
  50   http://bugzilla.open-bio.org/
  51
  52 =head1 AUTHOR - Jason Stajich
  53
  54 Email jason@bioperl.org
  55
  56 =head1 APPENDIX
  57
  58 The rest of the documentation details each of the object methods.
  59 Internal methods are usually preceded with a _
  60
  61 =cut
  62
  63
  64 # Let the code begin...
  65
  66
  67 package Bio::Factory::MapFactoryI;
  68 use strict;
  69
  70 use base qw(Bio::Root::RootI);
  71
  72 =head2 next_map
  73
  74  Title   : next_map
  75  Usage   : my $map = $factory->next_map;
  76  Function: Get a map from the factory
  77  Returns : L<Bio::Map::MapI>
  78  Args    : none
  79
  80 =cut
  81
  82 sub next_map{
  83    my ($self,@args) = @_;
  84    $self->throw_not_implemented();
  85 }
  86
  87 =head2 write_map
  88
  89  Title   : write_map
  90  Usage   : $factory->write_map($map);
  91  Function: Write a map out through the factory
  92  Returns : none
  93  Args    : L<Bio::Map::MapI>
  94
  95 =cut
  96
  97 sub write_map{
  98    my ($self,@args) = @_;
  99    $self->throw_not_implemented();
 100 }
 101
 102 1;