[MOBY-guts] biomoby commit

[Dirk Haase]

d.haase
Mon Feb  5 09:30:46 EST 2007
Update of /home/repository/moby/moby-live/Docs/MOBY-S_API
In directory dev.open-bio.org:/tmp/cvs-serv14907

Modified Files:
	XMLPayloads.html 
Log Message:
Updated documentation of Relationships function in order to describe new 'direction' parameter

moby-live/Docs/MOBY-S_API XMLPayloads.html,1.17,1.18
===================================================================
RCS file: /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html	2006/11/21 23:04:27	1.17
+++ /home/repository/moby/moby-live/Docs/MOBY-S_API/XMLPayloads.html	2007/02/05 14:30:46	1.18
@@ -650,6 +650,7 @@
          <relationshipType>RelationshipOntologyTerm1</relationshipType>
          <relationshipType>RelationshipOntologyTerm2</relationshipType>
                  ...
+         <direction>root|leaves</direction>
          <expandRelationship>1|0</expandRelationship>
         <Relationships>
 </pre>                          
@@ -668,26 +669,62 @@
 <h4>Notes</h4>
 <ul>
 
-<li>  Retrieves the Object or Service Classnames that stand in 'X'
-relationship to the given object type based on the Object Class
-ontology, where X is the relationship(s) specified in the input message  </li>
-
+<li>  Retrieves the Entity (Object or Service) Classnames that stand in 'X'
+relationship to the given entity type based on the regarding Class
+ontology, where X is the relationship(s) specified in the input message</li>
+
+    <li> The result list is composed of all entities which are related
+    to the query entity by any relevant relationship instance. The
+    given direction dictates which relationship instances are
+    considered:
+     <ul>
+      <li> ISA: suppose a relationship instance <code>R:= A ISA
+      B</code>. If direction is 'root' <code>R</code> is considered if
+      <code>B</code> is the query entity. If direction is 'leaves'
+      <code>R</code> is considered if <code>A</code> is the query
+      entity.</li>
+      
+      <li> HAS: suppose a relationship instance <code>R:= A HAS
+      B</code>. If direction is 'root' <code>R</code> is considered if
+      <code>A</code> is the query entity. If direction is 'leaves'
+      <code>R</code> is considered if <code>B</code> is the query
+      entity.</li>
+      
+      <li> HASA: suppose a relationship instance <code>R:= A HASA
+      B</code>. If direction is 'root' <code>R</code> is considered if
+      <code>A</code> is the query entity. If direction is 'leaves'
+      <code>R</code> is considered if <code>B</code> is the query
+      entity.</li>
+     </ul>
+    </li>
+   
 <li> If the expandRelationships flag is NOT set, the response will contain only
-the classnames that lie immediately in that relationship to the given object.</li>
+the classnames that lie immediately in that relationship to the given entity.</li>
 
 <li> If the expandRelationships flag is set, the ontology will be traversed
 in the following way:
 <ul>
-	<li>ISA:  the ontology will be traversed along the ISA path back to root
-	("Object" or "Service")</li>
-	<li>HAS(not applicable to Service ontology):  Object ontology will be traversed along
-	the ISA path back to root, and every HAS relationship of every Object along that path
-	will be added to the output as a <strong>flattened list</strong>.  The HAS, HASA, or ISA
-	realtionships of these will NOT be followed.</li>
-	<li>HASA (not applicable to Service ontology):  Object ontology will be traversed along
-	the ISA path back to root, and every HASA relationship of every Object along that path
-	will be added to the output as a <strong>flattened list</strong>.  The HAS, HASA, or ISA
-	realtionships of these will NOT be followed.</li>
+      <li>ISA: the ontology will be traversed along the ISA path in
+       the given direction; up to the root entity ("Object" or
+       "Service") for 'root' direction, down to the ontology leaves
+       for 'leaves' direction</li>
+      
+      <li>HAS(not applicable to Service ontology): Object ontology
+      will be traversed along the ISA path as described above. For
+      each node in the resulting ISA hierarchy all objects related by
+      HAS will be added to the output as a <strong>flattened
+      list</strong> (direction dependent rules for considering
+      relationships apply). The HAS, HASA, or ISA realtionships of
+      these will NOT be followed.</li>
+      
+      <li>HASA(not applicable to Service ontology): Object ontology
+      will be traversed along the ISA path as described above. For
+      each node in the resulting ISA hierarchy all objects related by
+      HAS will be added to the output as a <strong>flattened
+      list</strong> (direction dependent rules for considering
+      relationships apply). The HAS, HASA, or ISA realtionships of
+      these will NOT be followed.</li>
+      
 </ul> 
 </ul>