view release on metacpan or  search on metacpan

lib/Bio/Coordinate/MapperI.pm  view on Meta::CPAN

package Bio::Coordinate::MapperI;
our $AUTHORITY = 'cpan:BIOPERLML';
$Bio::Coordinate::MapperI::VERSION = '1.007001';
use utf8;
use strict;
use warnings;
use parent qw(Bio::Root::RootI);

# ABSTRACT: Interface describing coordinate mappers.
# AUTHOR:   Heikki Lehvaslaiho <heikki@bioperl.org>
# OWNER:    Heikki Lehvaslaiho
# LICENSE:  Perl_5



sub in {
   my ($self,$value) = @_;

   $self->throw_not_implemented();

}


sub out {
   my ($self,$value) = @_;

   $self->throw_not_implemented();
}


sub swap {
   my ($self) = @_;

   $self->throw_not_implemented();

}


sub test {
   my ($self) = @_;

   $self->throw_not_implemented();
}


sub map {
   my ($self,$value) = @_;

   $self->throw_not_implemented();

}


sub return_match {
   my ($self,$value) = @_;
   if( defined $value) {
       $value ? ( $self->{'_return_match'} = 1 ) :
                ( $self->{'_return_match'} = 0 );
   }
   return $self->{'_return_match'} || 0 ;
}

1;

__END__

=pod

=encoding utf-8

=head1 NAME

Bio::Coordinate::MapperI - Interface describing coordinate mappers.

=head1 VERSION

version 1.007001

=head1 SYNOPSIS

  # not to be used directly

=head1 DESCRIPTION

MapperI defines methods for classes capable for mapping locations
between coordinate systems.

=head1 METHODS

=head2 in

 Title   : in
 Usage   : $obj->in('peptide');
 Function: Set and read the input coordinate system.
 Example :
 Returns : value of input system
 Args    : new value (optional), Bio::LocationI

=head2 out

 Title   : out
 Usage   : $obj->out('peptide');
 Function: Set and read the output coordinate system.
 Example :
 Returns : value of output system
 Args    : new value (optional), Bio::LocationI

=head2 swap