Changeset 6014 for DASISH

Timestamp:

02/23/15 12:17:33 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Javadoc are updated for CachedRepresentationResource?.java

File:

• DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/CachedRepresentationResource.java (modified) (5 diffs)

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

@@ -59 +59 @@
 @Transactional(rollbackFor = {Exception.class, SQLException.class, IOException.class, ParserConfigurationException.class})
 public class CachedRepresentationResource extends ResourceResource {
-
+   
+    /**
+     * 
+     * @param request a {@link HttpServletRequest} object representing request; the set parameter is used in unit tests.
+     */
     public void setHttpRequest(HttpServletRequest request) {
         this.httpServletRequest = request;
     }
 
+    /**
+     * 
+     * @param externalId the external UUID of a cached representations.
+     * @return a {@link CachedRepresentationInfo} representing the metadata for the cached representation with the "externalId".
+     * @throws IOException if sending the error fails.
+     */
     @GET
     @Produces(MediaType.TEXT_XML)
@@ -95 +105 @@
     }
 
-    ////////////////////////////////////////////
+    /**
+     * 
+     * @param externalId the external UUID of a cached representation.
+     * @return the image-blob if the cached-representation's blob is an image file.
+     * @throws IOException if logging the error fails (should be changed to sending httpResponse error message).
+     */
     @GET
     @Produces({"image/jpeg", "image/png"})
@@ -128 +143 @@
     }
 
+    /**
+     * 
+     * @param externalId the external UUID of a cached representation.
+     * @return the cached-representation's blob.
+     * @throws IOException is sending the error fails.
+     */
     @GET
     //@Produces({"text/plain", "text/html", "text/xml", "application/zip", "image/png", "image/jpg"})
@@ -154 +175 @@
     }
 
-    ///////////////////////////////////////////////////////////////////
+    /**
+     * 
+     * @param cachedIdentifier the external uuid of a cached representation.
+     * @param multiPart a {@link MultiPart} object containing two parts: a {@linkCachedRepresentationInfo} object for the cached-representation's metadata, and its blob.
+     * @return a message about how many rows in "cached_representation" table have been update; "1" if updated, and "0" otherwisee.
+     * @throws IOException if sending the error fails.
+     */
     @PUT
     @Consumes("multipart/mixed")
@@ -231 +258 @@
     }
 
-    ///////////////////////////////////////////////////////////
+    /**
+     * 
+     * @param cachedInfo a {@link CachedRepresentationInfo} representing the new metadata.
+     * @return a message about how many rows in "cached_representation" table, "1" if updated, "0" otherwise.
+     * @throws IOException if sending the error fails.
+     */
     @PUT
     @Consumes(MediaType.TEXT_XML)