Christopher Fields > BioPerl-DB-1.006900 > Bio::DB::Query::PrebuiltResult

Download:
BioPerl-DB-1.006900.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Bio::DB::Query::PrebuiltResult - DESCRIPTION of Object

SYNOPSIS ^

Give standard usage here

DESCRIPTION ^

This modules provides an implementation of Bio::DB::Query::QueryResultI for database queries through DBI.

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 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

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 of the bugs and their resolution. Bug reports can be submitted via the web:

  http://redmine.open-bio.org/projects/bioperl/

AUTHOR - Hilmar Lapp ^

Email hlapp at gmx.net

Describe contact details here

CONTRIBUTORS ^

Additional contributors names and emails here

APPENDIX ^

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

new

 Title   : new
 Usage   : my $obj = Bio::DB::Query::PrebuiltResult->new();
 Function: Builds a new Bio::DB::Query::PrebuiltResult object 
 Returns : an instance of Bio::DB::Query::PrebuiltResult
 Args    : named parameters
              -objs  a reference to an array of objects that should be
                     returned via next_object()

next_object

 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

each_Object

 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.

finish

 Title   : finish
 Usage   :
 Function: Indicate being finished with this result so that possibly used
           system resources can be released.
 Example :
 Returns : none
 Args    : none

objs

 Title   : objs
 Usage   : $obj->objs($newval)
 Function: Get/set the objects this result is going to return via next_object()
 Example : 
 Returns : value of objs (a reference to an array)
 Args    : new value (a reference to an array, optional)
syntax highlighting: