Bio IdCollectionI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::IdCollectionI - interface for objects with multiple identifiers
Package variables
No package variables defined.
Inherit
Bio::Root::RootI
Synopsis
    # to test this is an identifiable collection object
$obj->isa("Bio::IdCollectionI") || $obj->throw("$obj does not implement the Bio::IdCollectionI interface"); # accessors @authorities = $obj->id_authorities(); @ids = $obj->ids(); $id = $obj->ids($authority);
Description
This interface describes methods expected on objects that have
multiple identifiers, each of which is controlled by a different
authority.
Methods
id_authoritiesDescriptionCode
idsDescriptionCode
Methods description
id_authoritiescode    nextTop
 Title   : id_authorities
Usage : @array = $obj->id_authorities()
Function: Return the authorities which have names for this object.
The authorities can then be used to select ids.
Returns : An array Status : Virtual
idscodeprevnextTop
 Title   : ids
Usage : @ids = $obj->ids([$authority1,$authority2...])
Function: return a list of Bio::IdentifiableI objects, optionally
filtered by the list of authorities.
Returns : A list of Bio::IdentifiableI objects. Status : Virtual
Methods code
id_authoritiesdescriptionprevnextTop
sub id_authorities {
   my ($self) = @_;
   $self->throw_not_implemented();
}
idsdescriptionprevnextTop
sub ids {
   my ($self) = @_;
   my @authorities = @_;
   $self->throw_not_implemented();
}

1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to one
of the Bioperl mailing lists. Your participation is much appreciated.
  bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Support Top
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Lincoln SteinTop
Email lstein@cshl.org
Implementation Specific FunctionsTop
These functions are the ones that a specific implementation must
define.