Bio::DB::Persistent PersistentObjectFactory
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::DB::Persistent::PersistentObjectFactory - DESCRIPTION of Object
Package variables
No package variables defined.
Included modules
Bio::Factory::ObjectFactoryI
Bio::Root::Root
Inherit
Bio::Factory::ObjectFactoryI Bio::Root::Root
Synopsis
Give standard usage here
Description
Describe the object here
Methods
newDescriptionCode
object_typeDescriptionCode
persistence_adaptorDescriptionCode
create_objectDescriptionCode
Methods description
newcode    nextTop
 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_typecodeprevnextTop
 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_adaptorcodeprevnextTop
 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)
create_objectcodeprevnextTop
 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()
Methods code
newdescriptionprevnextTop
sub new {
    my($class,@args) = @_;
    
    my $self = $class->SUPER::new(@args);

    my ($type,$adp) = $self->_rearrange([qw(TYPE ADAPTOR)], @args);
    $self->object_type($type) if $type;
    $self->persistence_adaptor($adp) if $adp;
    
    return $self;
}
object_typedescriptionprevnextTop
sub object_type {
    my ($self,$value) = @_;
    if( defined $value) {
	# make sure it loads, or is loaded already (this will throw an
# exception if anything is fishy)
$self->_load_module($value); # set ...
$self->{'object_type'} = $value; } return $self->{'object_type'};
}
persistence_adaptordescriptionprevnextTop
sub persistence_adaptor {
    my ($self,$value) = @_;
    if( defined $value) {
	$self->{'persistence_adaptor'} = $value;
    }
    return $self->{'persistence_adaptor'};
}
create_objectdescriptionprevnextTop
sub create_object {
    my ($self,@args) = @_;

    # create object of desired type
my $class = $self->object_type(); my $obj = $class->new(@args); # wrap it as a persistent object
my $pobj = Bio::DB::Persistent::PersistentObject->new( -object => $obj, -adaptor => $self->persistence_adaptor()); return $pobj; } 1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
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 Top
 
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 BugsTop
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/
AUTHOR - Hilmar LappTop
Email hlapp at gmx.net
Describe contact details here
CONTRIBUTORSTop
Additional contributors names and emails here
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Methods to implement Bio::Factory::ObjectFactoryITop