annotate variant_effect_predictor/Bio/Factory/ObjectBuilderI.pm @ 0:1f6dce3d34e0

Uploaded
author mahtabm
date Thu, 11 Apr 2013 02:01:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 # $Id: ObjectBuilderI.pm,v 1.2 2002/10/22 07:45:14 lapp Exp $
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::Factory::ObjectBuilderI
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5 # Cared for by Hilmar Lapp <hlapp at gmx.net>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 # Copyright Hilmar Lapp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12 # (c) Hilmar Lapp, hlapp at gmx.net, 2002.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 # (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15 # You may distribute this module under the same terms as perl itself.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 # Refer to the Perl Artistic License (see the license accompanying this
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 # software package, or see http://www.perl.com/language/misc/Artistic.html)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18 # for the terms under which you may use, modify, and redistribute this module.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20 # THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22 # MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25 # POD documentation - main docs before the code
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 Bio::Factory::ObjectBuilderI - Interface for an object builder
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 Give standard usage here
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 An object builder is different from an object factory in that it
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 accumulates information for the object and finally, or constantly,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 depending on the implementation, builds the object. It also allows for
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 implementations that can tell the information feed in which kind of
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 information the builder is interested in which not. In addition, the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 implementation may choose to filter, transform, or completely ignore
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 certain content it is fed for certain slots.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 Implementations will hence be mostly used by stream-based parsers to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 parse only desired content, and/or skip over undesired entries.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 =head1 FEEDBACK
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 =head2 Mailing Lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 User feedback is an integral part of the evolution of this and other
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 Bioperl modules. Send your comments and suggestions preferably to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 the Bioperl mailing list. Your participation is much appreciated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 bioperl-l@bioperl.org - General discussion
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 http://bioperl.org/MailList.shtml - About the mailing lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 =head2 Reporting Bugs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 Report bugs to the Bioperl bug tracking system to help us keep track
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 of the bugs and their resolution. Bug reports can be submitted via
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 email or the web:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 bioperl-bugs@bioperl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 http://bugzilla.bioperl.org/
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 =head1 AUTHOR - Hilmar Lapp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 Email hlapp at gmx.net
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 Describe contact details here
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 =head1 CONTRIBUTORS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 Additional contributors names and emails here
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 =head1 APPENDIX
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 The rest of the documentation details each of the object methods.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 Internal methods are usually preceded with a _
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 # Let the code begin...
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 package Bio::Factory::ObjectBuilderI;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 use Carp;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 use Bio::Root::RootI;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 @ISA = qw( Bio::Root::RootI );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 =head2 want_slot
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 Title : want_slot
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 Usage :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 Function: Whether or not the object builder wants to populate the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 specified slot of the object to be built.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 The slot can be specified either as the name of the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 respective method, or the initialization parameter that
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 would be otherwise passed to new() of the object to be
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 built.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 Example :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 Returns : TRUE if the object builder wants to populate the slot, and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 FALSE otherwise.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 Args : the name of the slot (a string)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 sub want_slot{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 shift->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121 =head2 add_slot_value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 Title : add_slot_value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 Usage :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 Function: Adds one or more values to the specified slot of the object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 to be built.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 Naming the slot is the same as for want_slot().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 The object builder may further filter the content to be
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 set, or even completely ignore the request.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133 If this method reports failure, the caller should not add
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134 more values to the same slot. In addition, the caller may
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 find it appropriate to abandon the object being built
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136 altogether.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 Example :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139 Returns : TRUE on success, and FALSE otherwise
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 Args : the name of the slot (a string)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141 parameters determining the value to be set
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146 sub add_slot_value{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 shift->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150 =head2 want_object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152 Title : want_object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153 Usage :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154 Function: Whether or not the object builder is still interested in
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 continuing with the object being built.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157 If this method returns FALSE, the caller should not add any
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158 more values to slots, or otherwise risks that the builder
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159 throws an exception. In addition, make_object() is likely
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160 to return undef after this method returned FALSE.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162 Example :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163 Returns : TRUE if the object builder wants to continue building
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 the present object, and FALSE otherwise.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 sub want_object{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 shift->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174 =head2 make_object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176 Title : make_object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 Usage :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178 Function: Get the built object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180 This method is allowed to return undef if no value has ever
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181 been added since the last call to make_object(), or if
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182 want_object() returned FALSE (or would have returned FALSE)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183 before calling this method.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185 For an implementation that allows consecutive building of
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186 objects, a caller must call this method once, and only
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
187 once, between subsequent objects to be built. I.e., a call
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
188 to make_object implies 'end_object.'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
189
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
190 Example :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
191 Returns : the object that was built
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
192 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
193
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
194
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
195 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
196
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
197 sub make_object{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
198 shift->throw_not_implemented();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
199 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
200
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
201 1;