NAME

Bio::AnnotatableI - the base interface an annotatable object must implement

SYNOPSIS

use Bio::SeqIO;
# get an annotatable object somehow: for example, Bio::SeqI objects
# are annotatable
my $seqio = Bio::SeqIO->new(-fh => \*STDIN, -format => 'genbank);
while (my $seq = $seqio->next_seq()) {
    # $seq is-a Bio::AnnotatableI, hence:
    my $ann_coll = $seq->annotation();
    # $ann_coll is-a Bio::AnnotationCollectionI, hence:
    my @all_anns = $ann_coll->get_Annotations();
    # do something with the annotation objects
}

DESCRIPTION

This is the base interface that all annotatable objects must implement. A good example is Bio::Seq which is an AnnotableI object; if you are a little confused about what this module does, start a Bio::Seq.

FEEDBACK

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.

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

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

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

AUTHOR - Hilmar Lapp

Email hlapp at gmx.net

Describe contact details here

CONTRIBUTORS

Additional contributors names and emails here

APPENDIX

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

annotation

Title   : annotation
Usage   : $obj->annotation($newval)
Function: Get the annotation collection (see L<Bio::AnnotationCollectionI>)
          for this annotatable object.
Example : 
Returns : a Bio::AnnotationCollectionI implementing object, or undef
Args    : on set, new value (a Bio::AnnotationCollectionI
          implementing object, optional) (an implementation may not
          support changing the annotation collection)