[MOBY-guts] biomoby commit

[Dennis Wang]

dwang
Tue Jul 26 17:55:28 EDT 2005
Update of /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby
In directory pub.open-bio.org:/tmp/cvs-serv25475/Perl/MOBY/Adaptor/moby

Modified Files:
	queryapi.pm 
Log Message:
slightly more comments

moby-live/Perl/MOBY/Adaptor/moby queryapi.pm,1.14,1.15
===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/26 05:19:37	1.14
+++ /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/26 21:55:28	1.15
@@ -527,14 +527,53 @@
 #
 # namespace table functions
 #
+=head2 query_namespace
+
+ Title     :	insert_namespace
+ Usage     :	my $un = $API->insert_namespace(%args)
+ Function  :	Deletes a namespace instance from the database
+ Args      :    namespace_type => String,
+ 				namespace_lsid => String,
+ 				description	   => String, 
+ 				authority      => String,
+ 				contact_email  => String
+ Returns   :    Integer mysql_insertid
+ Notes     : 	the fact that it returns a mysql_insertid is bad since this
+             	is only useful to an SQL-based API...
+=cut
 sub query_namespace{
 	die "query_namespace not implemented in adaptor\n";
 }
 
+=head2 insert_namespace
+
+ Title     :	insert_namespace
+ Usage     :	my $un = $API->insert_namespace(%args)
+ Function  :	Deletes a namespace instance from the database
+ Args      :    namespace_type => String,
+ 				namespace_lsid => String,
+ 				description	   => String, 
+ 				authority      => String,
+ 				contact_email  => String
+ Returns   :    Integer mysql_insertid
+ Notes     : 	the fact that it returns a mysql_insertid is bad since this
+             	is only useful to an SQL-based API...
+=cut
 sub insert_namespace{
 	die "insert_namespace not implemented in adaptor\n";
 }
 
+=head2 delete_namespace
+
+ Title     :	delete_namespace
+ Usage     :	my $un = $API->delete_namespace(%args)
+ Function  :	Deletes a namespace instance from the database
+ Args      :    namespace_lsid => String - lsid identifying a particular namespace
+ Returns   :    ($err, $errstr)
+ 				$err = 1 if there was an delete error, 0 otherwise
+ 				$errstr = String error message if there was an error	
+ 
+=cut
 sub delete_namespace{
 	die "delete_namespace not implemented in adaptor\n";
 }
@@ -609,7 +648,7 @@
                 authoritative 		  => String, 
                 description 	      => String, 
                 signatureURL 		  => String, 
-                lsid   				  => Integer}, ...]
+                lsid   				  => String}, ...]
                 Each hash represents a service
  Notes     : 	the fact that it returns a service_instance_id is bad since this
              	is only useful to an SQL-based API...
@@ -702,7 +741,7 @@
  Args      :    object1_id => Integer - a bind value for object1_id on an underlying SQL-based data source
  Returns   :    listref of hashrefs:
                 [{relationship_type => String,
-                object_lsid         => Integer,
+                object_lsid         => String,
                 object2_articlename => String}, ...]
 				one hashref for each relationship between two objects
  Notes     : 	relationship_type from object_term2term, object_lsid from object, and object2_articlename from object_term2term
@@ -721,10 +760,10 @@
  Function  :	Execute a query for a relationship between two ontologies
  Args      :    direction => String - direction in the ontology (eg. 'root')
  				ontology => String - name of the table ontology
- 				term => Integer - a bind value for lsid
+ 				term => String - a bind value for lsid
  				relationship => String - a bind value for relationship_type
  Returns   :	reference to array containing array-refs representing the result set:
- 				[[Integer lsid, String relationship_type], ...]
+ 				[[String lsid, String relationship_type], ...]
  				each array-ref represents one row
  Notes	   :	Only returns distinct lsid from $ontology and relationship_type from $ontology_term2term