[MOBY-guts] biomoby commit

[Eddie Kawas]

kawas
Mon Aug 29 17:16:04 EDT 2005
Update of /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types
In directory pub.open-bio.org:/tmp/cvs-serv15655/org/biomoby/registry/definitions/types

Modified Files:
	JNamespaceI.java JObjectsI.java JServiceI.java 
Log Message:
added some clarifying (hopefully) comments.

Eddie

moby-live/Java/src/main/org/biomoby/registry/definitions/types JNamespaceI.java,1.1,1.2 JObjectsI.java,1.1,1.2 JServiceI.java,1.1,1.2
===================================================================
RCS file: /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JNamespaceI.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JNamespaceI.java	2005/08/29 20:19:20	1.1
+++ /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JNamespaceI.java	2005/08/29 21:16:04	1.2
@@ -27,7 +27,8 @@
      * method that returns the various namespace types and descriptions all tab-delimited. 
      * <p><b>PRE:</b>None.
      * <p><b>POST:</b>A string array containing sub string arrays containing all of the various namespace types and definitions all tab-delimited.
-     * @return - A string array, with each item in the array being another string array containing a namespace type and definition all tab-delimited.
+     * <p>Example of the structure that is returned: [[namespace type, description of the namespace]]
+     * @return A string array, with each item in the array being another string array containing a namespace type and definition all tab-delimited.
      */
     public String[][] getNamespacesAsArray();
 }

===================================================================
RCS file: /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JObjectsI.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JObjectsI.java	2005/08/29 20:19:20	1.1
+++ /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JObjectsI.java	2005/08/29 21:16:04	1.2
@@ -26,7 +26,9 @@
      * method that returns the various object types, object relationship, object type that this relationship is with, the articlename (if it exists), and description, all tab-delimited. 
      * <p><b>PRE:</b>None.
      * <p><b>POST:</b>A string array containing sub string arrays containing the various object types, object relationship, object type that this relationship is with, the articlename (if it exists), and description, all tab-delimited.
-     * @return - A string array, with each item in the array being another string array containing an object type, object relationship, object type that this relationship is with, the articlename (if it exists), and description, all tab-delimited.
+     * <p>Example of the structure that is returned: [[object type, relationship type, object type relationship is with, articlename, description of the object type]]
+     * <p><b><i>note that articlename may not be applicable to all relationship types</i></b>
+     * @return A string array, with each item in the array being another string array containing an object type, object relationship, object type that this relationship is with, the articlename (if it exists), and description, all tab-delimited.
      */
     public String[][] getObjectsAsArray();
     

===================================================================
RCS file: /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JServiceI.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JServiceI.java	2005/08/29 20:19:20	1.1
+++ /home/repository/moby/moby-live/Java/src/main/org/biomoby/registry/definitions/types/JServiceI.java	2005/08/29 21:16:04	1.2
@@ -27,7 +27,8 @@
      * method that returns the various service types, service relationship, service type that this relationship is with, and description, all tab-delimited. 
      * <p><b>PRE:</b>None.
      * <p><b>POST:</b>A string array containing sub string arrays containing the various service types, service relationship, service type that this relationship is with, and description, all tab-delimited.
-     * @return - A string array , with each item in the array being another string array containing a service type, service relationship, service type that this relationship is with, and description, all tab-delimited.
+     * <p>Example of the structure that is returned: [[service type, relationship type, service type parent, description of the service type]]
+     * @return A string array , with each item in the array being another string array containing a service type, service relationship, service type that this relationship is with, and description, all tab-delimited.
      */
     public String[][] getServicesAsArray();
 }