Toolbar

Summary

Bio::Factory::MapFactoryI - A Factory for getting markers

Package variables

Included modules

Inherit

Bio::Root::RootI

Synopsis

    # get a Map Factory somehow likely from Bio::MapIO system

    while( my $map = $mapin->next_map ) {
	print "map name is ", $map->name, " length is ", 
	    $map->length, " ", $map->units, "\n";
	$mapout->write_map($map);
    }

Description

This interface describes the necessary minimum methods for getting
Maps from a data stream. It also supports writing Map data back to a
stream.

Methods

Methods description

 Title   : next_map
 Usage   : my $map = $factory->next_map;
 Function: Get a map from the factory
 Returns : Bio::Map::MapI
 Args    : none

 Title   : write_map
 Usage   : $factory->write_map($map);
 Function: Write a map out through the factory
 Returns : none
 Args    : Bio::Map::MapI

Methods code

sub next_map {

   my ($self,@args) = @_;
   $self->throw_not_implemented();

}

sub write_map {

   my ($self,@args) = @_;
   $self->throw_not_implemented();
}

1;

}

General documentation

User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.

  bioperl-l@bioperl.org              - General discussion
  http://bioperl.org/MailList.shtml  - About the mailing lists

Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
email or the web:

  bioperl-bugs@bioperl.org
  http://bugzilla.bioperl.org/

Email jason@bioperl.org
Describe contact details here

Additional contributors names and emails here

The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _