Summary

Bio::Map::EntityI - An Entity Interface

Package variables

Inherit

Bio::Root::RootI

Synopsis

    # do not use this module directly

Description

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.

Methods

Methods description

 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

Methods code

sub get_position_handler {

    my $self = shift;
    $self->throw_not_implemented();

}

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/wiki/Mailing_lists  - 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 the
web:

  http://bugzilla.open-bio.org/

Email bix@sendu.me.uk

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

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