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

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

NAME

       Bio::DescribableI - interface for objects with human readable names and descriptions

SYNOPSIS

	   # to test this is a describable object

	   $obj->isa("Bio::DescribableI") ||
	     $obj->throw("$obj does not implement the Bio::DescribableI interface");

	   # accessors

	   $name = $obj->display_name();
	   $desc = $obj->description();

DESCRIPTION

       This interface describes methods expected on describable objects, ie ones which have human displayable names and descriptions

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 - Ewan Birney
       Email birney@sanger.ac.uk

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

   display_name
	Title	: display_name
	Usage	: $string    = $obj->display_name()
	Function: A string which is what should be displayed to the user
		  the string should have no spaces (ideally, though a cautious
		  user of this interface would not assumme this) and should be
		  less than thirty characters (though again, double checking
		  this is a good idea)
	Returns : A scalar
	Status	: Virtual

   description
	Title	: description
	Usage	: $string    = $obj->description()
	Function: A text string suitable for displaying to the user a
		  description. This string is likely to have spaces, but
		  should not have any newlines or formatting - just plain
		  text. The string should not be greater than 255 characters
		  and clients can feel justified at truncating strings at 255
		  characters for the purposes of display
	Returns : A scalar
	Status	: Virtual

perl v5.14.2							    2012-03-02						    Bio::DescribableI(3pm)

Check Out this Related 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)

Linux and UNIX Man Pages

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

Check Out this Related Man Page