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

Timestamp:

02/24/15 18:53:22 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Revising javadoc is completed

File:

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

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

@@ -52 +52 @@
 
 /**
- * REST class for GETting, POSTing and PUTting cached representations; 
- * DELETing cached representation is provided by TargetRsource class;
- * Every REST method in the case of successful completion of its action outputs the declared output type
+ * A REST class for GETting, POSTing and PUTting cached representations. 
+ * DELETing cached representation is provided by {@link TargetRsource} class.
+ * Every REST method in the case of successful completion produces an object of the declared output type
  * (a JAXB-element or a message string) or sends a HTTP-error with the corresponding diagnostics otherwise.
  * @author olhsha
@@ -63 +63 @@
 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.
+   
+    /**
+     * 
+     * @param externalId the external UUID of a cached representation.
+     * @return a {@link CachedRepresentationInfo} object representing the metadata for the cached representation with the "externalId".
+     * @throws IOException if sending an error fails.
      */
     @GET
@@ -112 +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).
+     * @throws IOException if logging an error fails (should be changed to sending httpResponse error message).
      */
     @GET
@@ -150 +143 @@
      * @param externalId the external UUID of a cached representation.
      * @return the cached-representation's blob.
-     * @throws IOException is sending the error fails.
+     * @throws IOException is sending an error fails.
      */
     @GET
@@ -180 +173 @@
     /**
      * 
-     * @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.
+     * @param cachedIdentifier the external UUID of a cached representation.
+     * @param multiPart a {@link MultiPart} object containing two parts: a {@link CachedRepresentationInfo} object for the cached-representation's metadata, and its blob.
+     * @return a message about how many rows in "cached_representation" table have been updated; "1" if updated, and "0" otherwisee.
+     * @throws IOException if sending an error fails.
      */
     @PUT
@@ -263 +256 @@
     /**
      * 
-     * @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.
+     * @param cachedInfo a {@link CachedRepresentationInfo} object representing the new metadata.
+     * @return a message about how many rows in "cached_representation" table have been updated: "1" if updated, "0" otherwise.
+     * @throws IOException if sending an error fails.
      */
     @PUT