[MOBY-guts] biomoby commit

[Mark Wilkinson]

mwilkinson
Mon Dec  3 17:26:54 EST 2007
Update of /home/repository/moby/moby-live/Perl/MOBY
In directory dev.open-bio.org:/tmp/cvs-serv15265/MOBY

Modified Files:
	Config.pm 
Log Message:
adding documentation for the Config module
moby-live/Perl/MOBY Config.pm,1.10,1.11
===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Config.pm,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- /home/repository/moby/moby-live/Perl/MOBY/Config.pm	2006/05/04 18:38:15	1.10
+++ /home/repository/moby/moby-live/Perl/MOBY/Config.pm	2007/12/03 22:26:54	1.11
@@ -1,3 +1,37 @@
+#$Id$
+
+=head1 NAME
+
+MOBY::Config.pm - An object containing information about how to get access to teh Moby databases, resources, etc. from the 
+mobycentral.config file
+
+=cut
+
+
+=head2 USAGE
+
+  $CONF = MOBY::Config->new();
+
+  # for fields in the mobycentral.config file, use the section name
+  # as the first object, then the item name as the hash-hey within that
+  # object.
+  # i.e.    $CONF->mobycentral returns a MOBY::dbConfig representing the
+  # [mobycentral] part of the mobycentral.config file
+
+  $centraluser = $CONF->mobycentral->{username}
+  $centralpass = $CONF->mobycentral->{password}
+  $objectuser =  $CONF->mobyobject->{username}
+
+  $ADAPTOR = $CONF->getDataAdaptor('mobyobject');
+  # $ADAPTOR is probably a MOBY::adaptor::queryapi::mysql object
+
+  my $dbh = $ADAPTOR->dbh();
+  my $sth = $object_dbh->prepare("select description from object where object_type = ?");
+  $sth->execute("GenericSequence");
+
+=cut
+
+
 package MOBY::Config;
 
 BEGIN {}