Bio/Factory/ObjectFactoryI.pm

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