Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Bio::IdCollectionI(3) User Contributed Perl DocumentationBio::IdCollectionI(3)

NAME
       Bio::IdCollectionI - interface for objects with multiple	identifiers

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.

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 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
       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 Bugs
       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://github.com/bioperl/bioperl-live/issues

AUTHOR - Lincoln Stein
       Email lstein@cshl.org

Implementation Specific	Functions
       These functions are the ones that a specific implementation must
       define.

   id_authorities
	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

   ids
	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

perl v5.32.0			  2019-12-07		 Bio::IdCollectionI(3)

NAME | SYNOPSIS | DESCRIPTION | FEEDBACK | AUTHOR - Lincoln Stein | Implementation Specific Functions

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Bio::IdCollectionI&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help