Changeset 6021

Timestamp:

02/23/15 15:53:03 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Javadocs are updated for NotebookResource? andProjectResourceInfo, + very minor correction for retrieval of annotations for notebooks.

Location:

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src

Files:

• main/java/eu/dasish/annotation/backend/dao/DBDispatcher.java (modified) (1 diff)
• main/java/eu/dasish/annotation/backend/dao/impl/DBDispatcherImlp.java (modified) (2 diffs)
• main/java/eu/dasish/annotation/backend/rest/NotebookResource.java (modified) (8 diffs)
• main/java/eu/dasish/annotation/backend/rest/ProjectInfoResource.java (modified) (1 diff)
• test/java/eu/dasish/annotation/backend/dao/impl/DBDispatcherTest.java (modified) (1 diff)

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/DBDispatcher.java

@@ -359 +359 @@
      * 
      * @param notebookID the internal database id of a notebook.
-     * @param startAnnotation the first index for the list (of annotations).
+     * @param startAnnotation the first index for the list (of annotations). min value is "1".
      * @param maximumAnnotations the maximum # of annotations in the output list expected.
      * @param orderedBy SQL "orderedBy" string value, must be one of the fields in the table "annotation".

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/impl/DBDispatcherImlp.java

@@ -634 +634 @@
 
     /////////////////////////////////////////////////////////////
+ 
     @Override
     public ReferenceList getAnnotationsForNotebook(Number notebookID, int startAnnotation, int maximumAnnotations, String orderedBy, boolean desc) {
         List<Number> annotationIDs = annotationDao.getAnnotations(notebookID);
 
-        if (startAnnotation < -1) {
+        if (startAnnotation < 0) {
             logger.info("Variable's startAnnotation value " + startAnnotation + " is invalid. I will return null.");
             return null;
@@ -648 +649 @@
         }
 
-        int offset = (startAnnotation > 0) ? startAnnotation - 1 : 0;
+        int offset = startAnnotation - 1;
         String direction = desc ? "DESC" : "ASC";
         List<Number> selectedAnnotIDs = annotationDao.sublistOrderedAnnotationIDs(annotationIDs, offset, maximumAnnotations, orderedBy, direction);

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/NotebookResource.java

@@ -59 +59 @@
     }
 
-    // changed w.r.t.the spec, query parameter persmission is added
+   /**
+    * 
+    * @param accessMode a string, representing an access mode: "none", "read", "write", "all".
+    * @return the {@link NotebookInfoList} element containing the list of {@link NotebookInfo} elements
+    * of all the notebooks to which the in-logged principal has "access" access.
+    * @throws IOException if sending the error fails.
+    */
     @GET
     @Produces(MediaType.APPLICATION_XML)
@@ -77 +83 @@
     }
 
+    /**
+     * 
+     * @return the {@link ReferenceList} element containing the list of h-references of all the notebooks owned by the in-logged principal.
+     * @throws IOException if sending the error fails.
+     */
     @GET
     @Produces(MediaType.APPLICATION_XML)
@@ -90 +101 @@
     }
 
+    /**
+     * 
+     * @param externalIdentifier the external UUID identifier of a notebook.
+     * @param accessMode the access mode on which principals must be filtered, 
+     * can be "none", "read", "write", "all".
+     * @return a {@link ReferenceList} element representing the list of h-references of the
+     * principal that have access "accessMode"
+     * @throws IOException if sending the error fails.
+     */
     @GET
     @Produces(MediaType.APPLICATION_XML)
@@ -115 +135 @@
         }
     }
-// Notebook and NotebookInfo (metadata) schemata may be changed
-// 1) we do not have information "private notebook" directly in the xml, but we have reads and writes in the schema
-//so if both are empty then we see that it is private for the owner
-// or shall we change the scheme? for notebooks
-// 2) d we need to include the reference list of annotations in teh metadata of the notebook
+    
+  /**
+   * 
+   * @param externalIdentifier the external UUID identifier of a notebook.
+   * @return a {@link Notebook} element built up on the whole information 
+   * ("notebook" table and the corresponding junction tables) for the notebook with "externalIdentifier".
+   * @throws IOException if sending the error fails.
+   */
+    
 
     @GET
@@ -125 +149 @@
     @Path("{notebookid: " + BackendConstants.regExpIdentifier + "}/metadata")
     @Transactional(readOnly = true)
-    public JAXBElement<Notebook> getNotebook(@PathParam("notebookid") String externalIdentifier) throws IOException, HTTPException {
+    public JAXBElement<Notebook> getNotebook(@PathParam("notebookid") String externalIdentifier) throws IOException{
         Number remotePrincipalID = this.getPrincipalID();
         if (remotePrincipalID == null) {
@@ -147 +171 @@
     }
 
+    /**
+     * 
+     * @param externalIdentifier the external UUID identifier of a notebook.
+     * @param maximumAnnotations the maximum amount of annotations from this notebook to output
+     * if the amount of annotations in the notebook is more than  (startAnnotations-1) + maximumAnnotations,
+     * then exactly maximumAnnotations will be output, otherwise  the amount of annotations of 
+     * output is limited by "# of annotations in the notebook" - startAnnotation
+     * @param startAnnotations the index of the first annotation, min value is "1". 
+     * @param orderBy the field in the table "notebook" on which annotations must be ordered.
+     * @param desc if true then the annotations in the list must be ordered in descending order, otherwise in ascending order.
+     * @return a {@link ReferenceList} element representing the list of (maximum) maximumAnnotations
+     * @throws IOException if sending the error fails.
+     */
     @GET
     @Produces(MediaType.APPLICATION_XML)
@@ -155 +192 @@
             @QueryParam("startAnnotation") int startAnnotations,
             @QueryParam("orderBy") String orderBy,
-            @QueryParam("descending") boolean desc) throws IOException, HTTPException {
+            @QueryParam("descending") boolean desc) throws IOException{
 
         Number remotePrincipalID = this.getPrincipalID();
@@ -178 +215 @@
 
     }
-
+    
+    /**
+     * 
+     * @param externalIdentifier the external UUID identifier of a notebook.
+     * @param notebookInfo the fresh {@link NotebookInfo} object.
+     * @return a {@link ResponseBody} element containing the just updated {@link Notebook} element
+     * and the list of actions, which are not yet specified for the notebooks.
+     * @throws IOException if sending the error fails.
+     */
     @PUT
     @Consumes(MediaType.APPLICATION_XML)

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/ProjectInfoResource.java

@@ -42 +42 @@
     @Path("version")
     @Transactional(readOnly = true)
-    public String getAnnotation() throws IOException {
+    public String getVersion() throws IOException {
         Number principalID = this.getPrincipalID();
         String retVal = "?.?";

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/test/java/eu/dasish/annotation/backend/dao/impl/DBDispatcherTest.java

@@ -1811 +1811 @@
         });
 
-        ReferenceList result = dbDispatcher.getAnnotationsForNotebook(1, -1, 3, "last_modified", true);
+        ReferenceList result = dbDispatcher.getAnnotationsForNotebook(1, 1, 3, "last_modified", true);
         assertEquals(2, result.getHref().size());
         assertEquals("/api/annotations/00000000-0000-0000-0000-000000000021", result.getHref().get(0).toString());