[MOBY-guts] biomoby commit

[Dennis Wang]

dwang
Mon Jul 25 19:31:56 EDT 2005
Update of /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby
In directory pub.open-bio.org:/tmp/cvs-serv22227/Perl/MOBY/Adaptor/moby

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

moby-live/Perl/MOBY/Adaptor/moby queryapi.pm,1.10,1.11
===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/25 21:30:12	1.10
+++ /home/repository/moby/moby-live/Perl/MOBY/Adaptor/moby/queryapi.pm	2005/07/25 23:31:56	1.11
@@ -564,16 +564,69 @@
 	die "checkNamespaceUsedByService not implemented in adaptor\n";
 }
 
+=head2 checkKeywords
+
+ Title     :	checkKeywords
+ Usage     :	my $un = $API->checkKeywords(%args)
+ Function  :	Execute a custom query for services with keywords in its description
+ Args      :    findme => hashref - hash contains an array of keywords
+ Returns   :    listref of hashrefs:
+                [{service_instance_id => Integer,
+                category 			  => String, 
+                servicename 		  => String, 
+                service_type_uri 	  => String, 
+                authority_id 		  => Integer, 
+                url 			      => String, 
+                contact_email 		  => String, 
+                authoritative 		  => String, 
+                description 	      => String, 
+                signatureURL 		  => String, 
+                lsid   				  => Integer}, ...]
+                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...
+ 
+=cut
 # custom query routine for Moby::Central.pm -> findService()
 sub checkKeywords{
 	die "checkKeywords not implemented in adaptor\n";
 }
 
+=head2 getFromSimple
+
+ Title     :	getFromSimple
+ Usage     :	my $un = $API->getFromSimple(%args)
+ Function  :	Execute a custom query for service ids in simple_input/output
+ Args      :    inout => String - to specify if input or output
+				ancestor_string => String - values that occur in object_type_uri
+				namespaceURIs => array-ref - reference to an array of namespace URIs
+ Returns   :    listref of hashrefs:
+                [{service_instance_id => Integer,
+                namespace_type_uris   => String}, ...]
+ Notes     : 	the fact that it returns a service_instance_id is bad since this
+             	is only useful to an SQL-based API...
+ 
+=cut
 # custom query subroutine for Moby::Central.pm->_searchForSimple()
 sub getFromSimple{
 	die "getFromSimple not implemented in adaptor\n";
 }
 
+=head2 getFromCollection
+
+ Title     :	getFromCollection
+ Usage     :	my $un = $API->getFromCollection(%args)
+ Function  :	Execute a custom query for service ids from collections
+ Args      :    inout => String - to specify if input or output
+				objectURI => String - value that binds to object_type_uri
+				namespaceURIs => array-ref - reference to an array of namespace URIs
+ Returns   :    listref of hashrefs:
+                [{service_instance_id => Integer,
+                namespace_type_uris   => String}, ...]
+ Notes     : 	the fact that it returns a service_instance_id is bad since this
+             	is only useful to an SQL-based API...
+ 
+=cut
 # custom query subroutine for Moby::Central.pm->_searchForCollection()
 sub getFromCollection{
 	die "getFromCollection not implemented in adaptor\n";