File Coverage

Bio/Map/EntityI.pm
Criterion Covered Total %
statement 6 8 75.0
branch n/a
condition n/a
subroutine 2 3 66.6
pod 1 1 100.0
total 9 12 75.0


line stmt bran cond sub pod time code
1             #
2             # BioPerl module for Bio::Map::EntityI
3             #
4             # Please direct questions and support issues to
5             #
6             # Cared for by Sendu Bala
7             #
8             # Copyright Sendu Bala
9             #
10             # You may distribute this module under the same terms as perl itself
11              
12             # POD documentation - main docs before the code
13              
14             =head1 NAME
15              
16             Bio::Map::EntityI - An Entity Interface
17              
18             =head1 SYNOPSIS
19              
20             # do not use this module directly
21              
22             =head1 DESCRIPTION
23              
24             This interface describes the basic methods required for entities. An Entity is a
25             kind of Bio::Map object that holds instance-specific data but relies on
26             registering itself with a PositionHandler to handle its relationships with
27             other entities. These relationships between objects are based around shared
28             Positions, so Bio::Map::PositionI objects are a special kind of EntityI, along
29             with Bio::Map::MappableI and Bio::Map::MapI objects.
30              
31             =head1 FEEDBACK
32              
33             =head2 Mailing Lists
34              
35             User feedback is an integral part of the evolution of this and other
36             Bioperl modules. Send your comments and suggestions preferably to
37             the Bioperl mailing list. Your participation is much appreciated.
38              
39             bioperl-l@bioperl.org - General discussion
40             http://bioperl.org/wiki/Mailing_lists - About the mailing lists
41              
42             =head2 Support
43              
44             Please direct usage questions or support issues to the mailing list:
45              
46             I
47              
48             rather than to the module maintainer directly. Many experienced and
49             reponsive experts will be able look at the problem and quickly
50             address it. Please include a thorough description of the problem
51             with code and data examples if at all possible.
52              
53             =head2 Reporting Bugs
54              
55             Report bugs to the Bioperl bug tracking system to help us keep track
56             of the bugs and their resolution. Bug reports can be submitted via the
57             web:
58              
59             https://github.com/bioperl/bioperl-live/issues
60              
61             =head1 AUTHOR - Sendu Bala
62              
63             Email bix@sendu.me.uk
64              
65             =head1 APPENDIX
66              
67             The rest of the documentation details each of the object methods.
68             Internal methods are usually preceded with a _
69              
70             =cut
71              
72             # Let the code begin...
73              
74             package Bio::Map::EntityI;
75 9     9   41 use strict;
  9         10  
  9         249  
76              
77 9     9   27 use base qw(Bio::Root::RootI);
  9         11  
  9         727  
78              
79             =head2 get_position_handler
80              
81             Title : get_position_handler
82             Usage : my $position_handler = $entity->get_position_handler();
83             Function: Gets a PositionHandlerI that $entity is registered with.
84             Returns : Bio::Map::PositionHandlerI object
85             Args : none
86              
87             =cut
88              
89             sub get_position_handler {
90 0     0 1   my $self = shift;
91 0           $self->throw_not_implemented();
92             }
93              
94             =head2 PositionHandlerI-based methods
95              
96             Any methods related to interation with other entities should be implemented
97             as a call to the PositionHandler
98              
99             =cut
100              
101             1;