File Coverage

Bio/Factory/ObjectFactoryI.pm
Criterion Covered Total %
statement 11 13 84.6
branch n/a
condition n/a
subroutine 4 5 80.0
pod 2 2 100.0
total 17 20 85.0


line stmt bran cond sub pod time code
1             #
2             # BioPerl module for Bio::Factory::ObjectFactoryI
3             #
4             # Please direct questions and support issues to
5             #
6             # Cared for by Jason Stajich
7             #
8             # Copyright Jason Stajich
9             #
10             # You may distribute this module under the same terms as perl itself
11              
12             # POD documentation - main docs before the code
13              
14             =head1 NAME
15              
16             Bio::Factory::ObjectFactoryI - A General object creator factory
17              
18             =head1 SYNOPSIS
19              
20             # see the implementations of this interface for details but
21             # basically
22              
23             my $obj = $factory->create(%args);
24              
25             =head1 DESCRIPTION
26              
27             This interface is the basic structure for a factory which creates new
28             objects. In this case it is up to the implementer to check arguments
29             and initialize whatever new object the implementing class is designed for.
30              
31             =head1 FEEDBACK
32              
33             =head2 Mailing Lists
34              
35             User feedback is an integral part of the evolution of this and other
36             Bioperl modules. Send your comments and suggestions preferably to
37             the Bioperl mailing list. Your participation is much appreciated.
38              
39             bioperl-l@bioperl.org - General discussion
40             http://bioperl.org/wiki/Mailing_lists - About the mailing lists
41              
42             =head2 Support
43              
44             Please direct usage questions or support issues to the mailing list:
45              
46             I
47              
48             rather than to the module maintainer directly. Many experienced and
49             reponsive experts will be able look at the problem and quickly
50             address it. Please include a thorough description of the problem
51             with code and data examples if at all possible.
52              
53             =head2 Reporting Bugs
54              
55             Report bugs to the Bioperl bug tracking system to help us keep track
56             of the bugs and their resolution. Bug reports can be submitted via the
57             web:
58              
59             https://github.com/bioperl/bioperl-live/issues
60              
61             =head1 AUTHOR - Jason Stajich
62              
63             Email jason@bioperl.org
64              
65             =head1 APPENDIX
66              
67             The rest of the documentation details each of the object methods.
68             Internal methods are usually preceded with a _
69              
70             =cut
71              
72              
73             # Let the code begin...
74              
75              
76             package Bio::Factory::ObjectFactoryI;
77 181     181   815 use strict;
  181         252  
  181         4314  
78 181     181   519 use Carp;
  181         193  
  181         8386  
79              
80 181     181   651 use base qw(Bio::Root::RootI);
  181         203  
  181         20353  
81              
82             =head2 create
83              
84             Title : create
85             Usage : $factory->create(%args)
86             Function: Create a new object
87             Returns : a new object
88             Args : hash of initialization parameters
89              
90              
91             =cut
92              
93             sub create{
94 0     0 1 0 my ($self,@args) = @_;
95 0         0 $self->throw_not_implemented();
96             }
97              
98             =head2 create_object
99              
100             Title : create_object
101             Usage : $obj = $factory->create_object(%args)
102             Function: Create a new object.
103              
104             This is supposed to supercede create(). Right now it only delegates
105             to create().
106             Returns : a new object
107             Args : hash of initialization parameters
108              
109              
110             =cut
111              
112             sub create_object{
113 351     351 1 1732 my ($self,@args) = @_;
114 351         1364 return $self->create(@args);
115             }
116              
117             1;