Changeset 3914

Timestamp:

Nov 6, 2007, 10:51:40 AM (16 years ago)

Author:

Martin Svensson

Message:

References #809 Documentation updated

Location:

trunk

Files:

• build.xml (modified) (1 diff)
• doc/src/docbook/developerdoc/webservices.xml (modified) (6 diffs)
• src/webservices/client/java/net/sf/basedb/ws/info/QueryOptions.java (modified) (4 diffs)
• src/webservices/server/net/sf/basedb/ws/server/RawBioAssayService.java (modified) (1 diff)

trunk/build.xml

@@ -1067 +1067 @@
       <path refid="core.classpath" />
       <fileset dir="${lib}/servlet">
+        <include name="**/*.jar"/>
+      </fileset>
+      <fileset dir="${lib}/webservices">
         <include name="**/*.jar"/>
       </fileset>

trunk/doc/src/docbook/developerdoc/webservices.xml

@@ -54 +54 @@
         <para>
           Base offers a way for services to allow the client applications to put their own
-          includes and restrictions on a query before it is executed. 
+          includes and restrictions on a query before it is executed. For those who intend
+          to develop services it is recommended to have a look in javadoc for
+          <classname>net.sf.basedb.ws.info.QueryOptions</classname>
         </para>
       </listitem>
@@ -64 +66 @@
     <para>
       Web services can, at the moment, be used to provide some information and data related to
-      experiments in BASE, like information about raw bioassays or exported bioassay set. This
-      section lists all the available services in Base and gives a short description of what each
-      one can be used to.
+      experiments in BASE, like information about raw bioassays or exported bioassay set to
+      mention some. This section lists all the available services in Base and gives a short
+      description of each one.
     </para>
 
@@ -84 +86 @@
                   <para>
                     Creates a new session and returns it's id. Before a session can
-                    be used you have to login with it, see below.
+                    be used you have to login with it.
                   </para>
                   <important>
@@ -112 +114 @@
                 <listitem>
                   <para>
-                    Logout and stop an active session in Base.
+                    Logout and stops an active session in Base.
                   </para>
                 </listitem>
@@ -163 +165 @@
                 <listitem>
                   <para>
-                    Sets a project to be active. This will be the same as when a
+                    Sets a project to be active. This is the same as when a
                     project is set to be active in the web client, see
                     <xref linkend="project_permission.projects.active" />
@@ -176 +178 @@
                 <listitem>
                   <para>
-                    Gets information about each project the active session has
+                    Gets information about each project an active session has
                     permission to read.
                   </para>

trunk/src/webservices/client/java/net/sf/basedb/ws/info/QueryOptions.java

@@ -30 +30 @@
   It is which items to include in the query
   and which restriction to put on the query.
+  <p>
+    The includes in this class correspond 
+    directly to the includes in 
+    {@link net.sf.basedb.core.Include}.
+    The include options will be set to TRUE if nothing
+    else is specified. 
+  </p>
+  
     @author Martin
     @version 2.5
@@ -64 +72 @@
   /**
     A restriction to set on
-    the query. 
+    the query.
   */
   private String restriction = null;
@@ -70 +78 @@
   /**
     The prefix that represent a root alias in 
-    a query.
+    a query. This string can be used in {{@link #restriction} 
+    and will be replaced when the restriction is 
+    inserted into a HQL query.
    */
   private String prefix = null;
@@ -198 +208 @@
   }
   /**
-    Sets restriction for this query option
+    Sets restriction for these query options.
+    <p>
+      The string must be in right format so it can be inserted 
+      directly into a hql query. The restriction string
+      can contain a prefix, but it has to be set separatly 
+      {@link #setRestrictionPrefix(String)}. 
+    </p>
+    <p>
+      Example how this property can be used together with the prefix:<br>
+      <i>$name='item1'</i> <br>
+      When this string is used in a query, ie that select users, it will look like this:
+      <i>usr.name='item1'</i>.<br>
+    </p>
+    
     @param restriction A restriction as a string to use with HQL queries. 
    */

trunk/src/webservices/server/net/sf/basedb/ws/server/RawBioAssayService.java

@@ -46 +46 @@
 /**
   Web service class for 
-  {@net.sf.basedb.core.RawBioAssay}
+  {@link net.sf.basedb.core.RawBioAssay}
     @author Martin
   @version 2.5