[MOBY-guts] biomoby commit

[Dennis Wang]

dwang
Thu Jul 28 14:09:46 EDT 2005
Update of /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby
In directory pub.open-bio.org:/tmp/cvs-serv4951/Perl/MOBY/Adaptor/moby

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

moby-live/Perl/MOBY/Adaptor/moby queryapi.pm,1.22,1.23
===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/27 22:57:47	1.22
+++ /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/28 18:09:46	1.23
@@ -399,14 +399,58 @@
 }
 
 # secondary_input table functions
+=head2 query_secondary_input
+
+ Title     :	query_secondary_input
+ Usage     :	my $un = $API->query_secondary_input(%args)
+ Function  :	Executes a query for Secondary input articles in the database
+ Args      :    service_instance_lsid => String
+ Returns   :    listref of hashrefs:
+ 				[{secondary_input_id => Integer,
+      			default_value		 => String,
+      			maximum_value		 => Float,
+     		 	minimum_value		 => Float,
+     			enum_value			 => String,
+      			datatype			 => String,
+      			article_name		 => String,
+      			service_instance_id  => Integer}]
+ Notes     : 	Only allows querying by lsid or type term, so service_instance_id is retrieved from lsid or term
+=cut
 sub query_secondary_input{
 	die "query_secondary_input not implemented in adaptor\n";
 }
 
+=head2 insert_secondary_input
+
+ Title     :	insert_secondary_input
+ Usage     :	my $un = $API->insert_secondar_input(%args)
+ Function  :	Inserts a Secondary input into the database
+ Args      :    default_value => String,
+				maximum_value => Float,
+				minimum_value => Float,
+				enum_value => String,
+				datatype => String,
+				article_name => String,
+				service_instance_lsid => String
+ Returns   :    Integer insertid
+ Notes     : 	the fact that it returns an insertid is bad since this
+             	is only useful to an SQL-based API...
+=cut
 sub insert_secondary_input{
 	die "insert_secondary_input not implemented in adaptor\n";
 }
 
+=head2 delete_secondary_input
+
+ Title     :	delete_secondary_input
+ Usage     :	my $un = $API->delete_secondary_input(%args)
+ Function  :	Deletes a Secondary input from the database
+ Args      :    service_instance_lsid => String 
+ Returns   :    ($err, $errstr)
+ 				$err = 1 if there was an delete error, 0 if successful
+ 				$errstr = String error message if there was an error	
+ 
+=cut
 sub delete_secondary_input{
 	die "delete_secondary_input not implemented in adaptor\n";
 }
@@ -478,8 +522,8 @@
  Returns   :    listref of hashrefs:
  				[{assertion_id	  	=> Integer,
           		relationship_type 	=> String,
-          		object1_id		  	=> Integer,
-          		object2_id		  	=> Integer,
+          		object1_id		  	=> String,
+          		object2_id		  	=> String,
           		object2_articlename => String}]
  Notes     : 	Only allows querying by lsid or type term
 =cut
@@ -492,9 +536,9 @@
  Title     :	insert_object_term2term
  Usage     :	my $un = $API->insert_object_term2term(%args)
  Function  :	Inserts an object relationship into the database
- Args      :    relationship_type => String, 
-				object1_id => Integer, - but may be string if lsid?
-				object2_id => Integer, - but may be string if lsid?
+ Args      :    relationship_type 	=> String, 
+				object1_id 		  	=> String,
+				object2_id 		  	=> String,
 				object2_articlename => String
  Returns   :    Integer insertid
  Notes     : 	the fact that it returns an insertid is bad since this
@@ -713,10 +757,10 @@
  Returns   :    listref of hashrefs:
  				[{assertion_id	  => Integer,
           		relationship_type => String,
-          		service1_id		  => Integer,
-          		service2_id		  => Integer}]
+          		service1_id		  => String,
+          		service2_id		  => String}]
  Notes     : 	the fact that it returns an service ids is bad since this
-             	is only useful to an SQL-based API...
+             	is only useful to an SQL-based API...should return lsids
 =cut
 sub query_service_term2term{
 	die "query_service_term2term not implemented in adaptor\n";
@@ -843,8 +887,9 @@
  Returns   :    listref of hashrefs:
  				[{assertion_id 	  => Integer,
           		relationship_type => String,
-          		namespace1_id 	  => Integer,
-          		namespace2_id	  => Integer}]	 				
+          		namespace1_id 	  => String,
+          		namespace2_id	  => String}]
+ Notes	   :    namespace1_id and namespace2_id will be lsids	 				
  
 =cut
 # namespace_term2term table functions