/
PersistentObjectFactory.pm
195 lines (135 loc) · 4.84 KB
/
PersistentObjectFactory.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# $Id$
#
# BioPerl module for Bio::DB::Persistent::PersistentObjectFactory
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Hilmar Lapp <hlapp at gmx.net>
#
# Copyright Hilmar Lapp
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::DB::Persistent::PersistentObjectFactory - DESCRIPTION of Object
=head1 SYNOPSIS
Give standard usage here
=head1 DESCRIPTION
Describe the object here
=head1 FEEDBACK
=head2 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
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<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.
=head2 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://bugzilla.open-bio.org/
=head1 AUTHOR - Hilmar Lapp
Email hlapp at gmx.net
Describe contact details here
=head1 CONTRIBUTORS
Additional contributors names and emails here
=head1 APPENDIX
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::DB::Persistent::PersistentObjectFactory;
use vars qw(@ISA);
use strict;
# Object preamble - inherits from Bio::Root::Root
use Bio::Root::Root;
use Bio::Factory::ObjectFactoryI;
@ISA = qw(Bio::Root::Root Bio::Factory::ObjectFactoryI);
=head2 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)
=cut
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;
}
=head2 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)
=cut
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'};
}
=head2 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)
=cut
sub persistence_adaptor{
my ($self,$value) = @_;
if( defined $value) {
$self->{'persistence_adaptor'} = $value;
}
return $self->{'persistence_adaptor'};
}
=head1 Methods to implement Bio::Factory::ObjectFactoryI
=cut
=head2 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()
=cut
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;