Christopher Fields > BioPerl > Bio::Map::EntityI



Annotate this POD


New  12
Open  4
View/Report Bugs
Module Version: 1.006924   Source  


Bio::Map::EntityI - An Entity Interface


    # do not use this module directly


This interface describes the basic methods required for entities. An Entity is a kind of Bio::Map object that holds instance-specific data but relies on registering itself with a PositionHandler to handle its relationships with other entities. These relationships between objects are based around shared Positions, so Bio::Map::PositionI objects are a special kind of EntityI, along with Bio::Map::MappableI and Bio::Map::MapI objects.


Mailing Lists

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.                  - General discussion  - About the mailing lists


Please direct usage questions or support issues to the mailing list:

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

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 the web:

AUTHOR - Sendu Bala ^



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


 Title   : get_position_handler
 Usage   : my $position_handler = $entity->get_position_handler();
 Function: Gets a PositionHandlerI that $entity is registered with.
 Returns : Bio::Map::PositionHandlerI object
 Args    : none

PositionHandlerI-based methods

 Any methods related to interation with other entities should be implemented
 as a call to the PositionHandler
syntax highlighting: