diff variant_effect_predictor/Bio/Seq/SeqFactory.pm @ 0:1f6dce3d34e0

Uploaded

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/variant_effect_predictor/Bio/Seq/SeqFactory.pm	Thu Apr 11 02:01:53 2013 -0400
@@ -0,0 +1,156 @@
+# $Id: SeqFactory.pm,v 1.8 2002/10/25 22:49:04 lapp Exp $
+#
+# BioPerl module for Bio::Seq::SeqFactory
+#
+# Cared for by Jason Stajich <[e-mail]>
+#
+# Copyright Jason Stajich
+#
+# You may distribute this module under the same terms as perl itself
+
+# POD documentation - main docs before the code
+
+=head1 NAME
+
+Bio::Seq::SeqFactory - Instantiates a new Bio::PrimarySeqI (or derived class) through a factory
+
+=head1 SYNOPSIS
+
+    use Bio::Seq::SeqFactory;
+    my $factory = new Bio::Seq::SeqFactory;
+    my $seq = $factory->create(-seq => 'WYRAVLC',
+			       -id  => 'name');
+
+    # If you want the factory to create Bio::Seq objects instead
+    # of the default Bio::PrimarySeq objects, use the -type parameter:
+
+    my $factory = new Bio::Seq::SeqFactory(-type => 'Bio::Seq');
+
+
+=head1 DESCRIPTION
+
+This object will build L<Bio::PrimarySeqI> and L<Bio::SeqI> objects
+generically.
+
+=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.
+
+  [e-mail]              - General discussion
+  http://bioperl.org/MailList.shtml  - About the mailing lists
+
+=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
+email or the web:
+
+  [e-mail]
+  http://bugzilla.bioperl.org/
+
+=head1 AUTHOR - Jason Stajich
+
+Email [e-mail]
+
+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::Seq::SeqFactory;
+use vars qw(@ISA);
+use strict;
+
+use Bio::Root::Root;
+use Bio::Factory::SequenceFactoryI;
+
+@ISA = qw(Bio::Root::Root Bio::Factory::SequenceFactoryI);
+
+=head2 new
+
+ Title   : new
+ Usage   : my $obj = new Bio::Seq::SeqFactory();
+ Function: Builds a new Bio::Seq::SeqFactory object 
+ Returns : Bio::Seq::SeqFactory
+ Args    : -type => string, name of a PrimarySeqI derived class
+                    This is optional. Default=Bio::PrimarySeq.
+
+=cut
+
+sub new {
+  my($class,@args) = @_;
+  my $self = $class->SUPER::new(@args);
+  my ($type) = $self->_rearrange([qw(TYPE)], @args);
+  if( ! defined $type ) { 
+      $type = 'Bio::PrimarySeq';
+  }
+  $self->type($type);
+  return $self;
+}
+
+
+=head2 create
+
+ Title   : create
+ Usage   : my $seq = $seqbuilder->create(-seq => 'CAGT', -id => 'name');
+ Function: Instantiates new Bio::SeqI (or one of its child classes)
+           This object allows us to genericize the instantiation of sequence
+           objects.
+ Returns : Bio::PrimarySeq object (default)
+           The return type is configurable using new(-type =>"...").
+ Args    : initialization parameters specific to the type of sequence
+           object we want.  Typically 
+           -seq        => $str,
+           -display_id => $name
+
+=cut
+
+sub create {
+   my ($self,@args) = @_;
+   return $self->type->new(-verbose => $self->verbose, @args);
+}
+
+=head2 type
+
+ Title   : type
+ Usage   : $obj->type($newval)
+ Function: 
+ Returns : value of type
+ Args    : newvalue (optional)
+
+
+=cut
+
+sub type{
+   my ($self,$value) = @_;
+   if( defined $value) {
+       eval "require $value";
+       if( $@ ) { $self->throw("$@: Unrecognized Sequence type for SeqFactory '$value'");}
+       
+       my $a = bless {},$value;
+       unless( $a->isa('Bio::PrimarySeqI') ||
+	       $a->isa('Bio::Seq::QualI') ) {
+	   $self->throw("Must provide a valid Bio::PrimarySeqI or Bio::Seq::QualI or child class to SeqFactory Not $value");
+       }
+      $self->{'type'} = $value;
+    }
+    return $self->{'type'};
+}
+
+1;