Bio
AnnotatableI
Toolbar
Summary
Bio::AnnotatableI - the base interface an annotatable object must implement
Package variables
No package variables defined.
Included modules
Inherit
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.
Methods
Methods description
Title : annotation
Usage : $obj->annotation($newval)
Function: Get the annotation collection 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)
See Bio::AnnotationCollectionI |
Methods code
sub annotation
{ shift->throw_not_implemented();
}
1; } | 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/
Hilmar Lapp <hlapp@gmx.net>
Allen Day <allenday@ucla.edu>
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _