Bio::DB::Query::QueryResultI - DESCRIPTION of Interface
Give standard usage here
This outlines the basic interface for a query result that returns objects, not rows. Basically, it is a stream of objects, similarly in spirit to the other Bioperl streaming interfaces like, e.g., Bio::SeqIO.
There is no specific notion here of a schema or database.
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/
Email hlapp at gmx.net
Additional contributors names and emails here
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : next_object Usage : Function: Obtain the next object from the result stream and return it. Example : Returns : A Bioperl object (implementing at least Bio::Root::RootI) Args : none
Title : each_Object
Usage :
Function: This is primarily a convenience method and in most implementations
will just loop over next_object() and return an array of all
objects.
Example :
Returns : A reference to an array of objects.
Args : Optionally, an anonymous function for filtering objects. If given,
the function is passed one argument, the object to evaluate.
The object will be included in the returned array if the function
returns TRUE, and rejected otherwise.
Title : finish
Usage :
Function: Indicate being finished with this result so that possibly used
system resources can be released.
Example :
Returns : none
Args : none
