Christopher Fields
and 1 contributors

NAME

Bio::DB::Persistent::PersistentObjectFactory - DESCRIPTION of Object

SYNOPSIS

Give standard usage here

DESCRIPTION

Describe the object here

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::Persistent::PersistentObjectFactory->new();
 Function: Builds a new Bio::DB::Persistent::PersistentObjectFactory object 
 Returns : an instance of Bio::DB::Persistent::PersistentObjectFactory
 Args    : Named parameters, specifically
             -type     the type (class name) of the objects to be created,
                       apart from them being persistent objects
             -adaptor  the persistence adaptor for the newly created objects
                       (a Bio::DB::PersistenceAdaptorI compliant object)

object_type

 Title   : object_type
 Usage   : $obj->object_type($newval)
 Function: Get/set the type of the objects to be created by the factory, 
           apart from them being persistent objects. The type is essentially
           the class name.
 Example : 
 Returns : value of object_type (a scalar)
 Args    : new value (a scalar, optional)

persistence_adaptor

 Title   : persistence_adaptor
 Usage   : $obj->persistence_adaptor($newval)
 Function: Get/set the persistence adaptor for the desired object type. If
           not set, the adaptor for the created persistent objects needs to
           be set explicitly after creation before persistence methods can be
           called on it.
 Example : 
 Returns : a Bio::DB::PersistenceAdaptorI implementing object
 Args    : new value (a Bio::DB::PersistenceAdaptorI implementing object, 
           optional)

Methods to implement Bio::Factory::ObjectFactoryI

create_object

 Title   : create_object
 Usage   :
 Function: Creates a new object and returns it (like new() on a class name).
 Example :
 Returns : a new object (which will also implement Bio::DB::PersistentObjectI)
 Args    : an array of named parameters to be passed to the class''s new()