Mercurial > repos > willmclaren > ensembl_vep
diff variant_effect_predictor/Bio/Ontology/RelationshipFactory.pm @ 0:21066c0abaf5 draft
Uploaded
author | willmclaren |
---|---|
date | Fri, 03 Aug 2012 10:04:48 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/variant_effect_predictor/Bio/Ontology/RelationshipFactory.pm Fri Aug 03 10:04:48 2012 -0400 @@ -0,0 +1,115 @@ +# $Id: RelationshipFactory.pm,v 1.1.2.1 2003/03/27 10:07:56 lapp Exp $ +# +# BioPerl module for Bio::Ontology::RelationshipFactory +# +# Cared for by Hilmar Lapp <hlapp at gmx.net> +# +# Copyright Hilmar Lapp +# +# You may distribute this module under the same terms as perl itself + +# +# (c) Hilmar Lapp, hlapp at gmx.net, 2002. +# (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002. +# +# You may distribute this module under the same terms as perl itself. +# Refer to the Perl Artistic License (see the license accompanying this +# software package, or see http://www.perl.com/language/misc/Artistic.html) +# for the terms under which you may use, modify, and redistribute this module. +# +# THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +# WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +# MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. +# + +# POD documentation - main docs before the code + +=head1 NAME + +Bio::Ontology::RelationshipFactory - Instantiates a new Bio::Ontology::RelationshipI (or derived class) through a factory + +=head1 SYNOPSIS + + use Bio::Ontology::RelationshipFactory; + + # the default type is Bio::Ontology::Relationship + my $factory = new Bio::Ontology::RelationshipFactory(-type => 'Bio::Ontology::GOterm'); + my $clu = $factory->create_object(-name => 'peroxisome', + -ontology => 'Gene Ontology', + -identifier => 'GO:0005777'); + + +=head1 DESCRIPTION + +This object will build L<Bio::Ontology::RelationshipI> 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. + + bioperl-l@bioperl.org - 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: + + bioperl-bugs@bioperl.org + http://bugzilla.bioperl.org/ + +=head1 AUTHOR - Hilmar Lapp + +Email hlapp at gmx.net + + +=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::Ontology::RelationshipFactory; +use vars qw(@ISA); +use strict; + +use Bio::Root::Root; +use Bio::Factory::ObjectFactory; + +@ISA = qw(Bio::Factory::ObjectFactory); + +=head2 new + + Title : new + Usage : my $obj = new Bio::Ontology::RelationshipFactory(); + Function: Builds a new Bio::Ontology::RelationshipFactory object + Returns : Bio::Ontology::RelationshipFactory + Args : -type => string, name of a L<Bio::Ontology::RelationshipI> + derived class. + The default is L<Bio::Ontology::Relationship>. + +=cut + +sub new { + my($class,@args) = @_; + + my $self = $class->SUPER::new(@args); + + # make sure this matches our requirements + $self->interface("Bio::Ontology::RelationshipI"); + $self->type($self->type() || "Bio::Ontology::Relationship"); + + return $self; +} + +1;