Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

bio::idcollectioni(3pm) [debian man page]

Bio::IdCollectionI(3pm) 				User Contributed Perl Documentation				   Bio::IdCollectionI(3pm)

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://redmine.open-bio.org/projects/bioperl/

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.14.2							    2012-03-02						   Bio::IdCollectionI(3pm)

Check Out this Related Man Page

Bio::DBLinkContainerI(3pm)				User Contributed Perl Documentation				Bio::DBLinkContainerI(3pm)

NAME

       Bio::DBLinkContainerI - Abstract interface for any object wanting to use
			       database cross references

SYNOPSIS

	   # get an objects containing database cross reference

	       foreach $obj ( @objs ) {
		       if( $obj->isa('Bio::DBLinkContainerI') ) {
			       foreach $dblink ( $obj->each_DBLink() ) {
				       # do stuff
			       }
		       }
	       }

DESCRIPTION

       This interface defines the functions one can expect for any object wanting to use database cross-references. This class does not actually
       provide any implementation, it just provides the definitions of what methods one can call.

       The database cross-references are implemented as Bio::Annotation::DBLink objects.

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://redmine.open-bio.org/projects/bioperl/

AUTHOR - Heikki Lehvaslaiho
       Email:  heikki-at-bioperl-dot-org

APPENDIX

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

   each_DBLink
	Title	: each_DBLink
	Usage	: foreach $ref ( $self->each_DBlink() )
	Function: gets an array of DBlink of objects
	Example :
	Returns : an array of Bio::Annotation::DBLink objects
	Args	: none

perl v5.14.2							    2012-03-02						Bio::DBLinkContainerI(3pm)
Man Page