Bio::Search::HSP HSPFactory
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Search::HSP::HSPFactory - A factory to create Bio::Search::HSP::HSPI objects
Package variables
No package variables defined.
Inherit
Bio::Factory::ObjectFactoryI Bio::Root::Root
Synopsis
    use Bio::Search::HSP::HSPFactory;
my $factory = Bio::Search::HSP::HSPFactory->new();
my $resultobj = $factory->create(@args);
Description
This is a general way of hiding the object creation process so that we
can dynamically change the objects that are created by the SearchIO
parser depending on what format report we are parsing.
This object is for creating new HSPs.
Methods
BEGIN Code
newDescriptionCode
createDescriptionCode
typeDescriptionCode
Methods description
newcode    nextTop
 Title   : new
Usage : my $obj = Bio::Search::HSP::HSPFactory->new();
Function: Builds a new Bio::Search::HSP::HSPFactory object
Returns : Bio::Search::HSP::HSPFactory
Args :
createcodeprevnextTop
 Title   : create
Usage : $factory->create(%args)
Function: Create a new Bio::Search::HSP::HSPI object
Returns : Bio::Search::HSP::HSPI
Args : hash of initialization parameters
typecodeprevnextTop
 Title   : type
Usage : $factory->type('Bio::Search::HSP::GenericHSP');
Function: Get/Set the HSP creation type
Returns : string
Args : [optional] string to set
Methods code
BEGINTop
BEGIN {
     $DEFAULT_TYPE = 'Bio::Search::HSP::GenericHSP';
}
newdescriptionprevnextTop
sub new {
  my($class,@args) = @_;

  my $self = $class->SUPER::new(@args);
  my ($type) = $self->_rearrange([qw(TYPE)],@args);
  $self->type($type) if defined $type;
  return $self;
}
createdescriptionprevnextTop
sub create {
   my ($self,@args) = @_;
   my $type = $self->type;
   eval { $self->_load_module($type) };
   if( $@ ) { $self->throw("Unable to load module $type"); }
   return $type->new(@args);
}
typedescriptionprevnextTop
sub type {
    my ($self,$type) = @_;
    if( defined $type ) { 
	# redundancy with the create method which also calls _load_module
# I know - but this is not a highly called object so I am going
# to leave it in
eval {$self->_load_module($type) }; if( $@ ){ $self->warn("Cannot find module $type, unable to set type. $@") } else { $self->{'_type'} = $type; } } return $self->{'_type'} || $DEFAULT_TYPE; } 1;
}
General documentation
FEEDBACKTop
Mailing ListsTop
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
Support Top
Please direct usage questions or support issues to the mailing list:
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.
Reporting BugsTop
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:
  https://redmine.open-bio.org/projects/bioperl/
AUTHOR - Jason StajichTop
Email jason-at-bioperl.org
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _