Changeset 6042 for DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/dao/CachedRepresentationDao.java

Timestamp:

02/24/15 16:08:22 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Javadoc annotations are revised for "eu.daish.annotation.backend" and "eu.daish.annotation.backend.dao" packages.

File:

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

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

@@ -37 +37 @@
      *
      * @param internalID the internal database Id of the cached representation.
-     * @return the object of the class "CachedRepresentationInfo" with the internal id "internalID".
+     * @return a {@link CachedRepresentationInfo} object representing the metadata
+     * of the cached representation with the internal id "internalID".
      */
     public CachedRepresentationInfo getCachedRepresentationInfo(Number internalID);
@@ -43 +44 @@
     /**
      *
-     * @param internalID
+     * @param internalID the internal database Id of a target.
      * @return the Blob of the cached representation with the internal database id "internalID".
      */
     public InputStream getCachedRepresentationBlob(Number internalID);
 
-    /* 
-     * @param targetID
-     * @return the list of the cached representation's ID-s for the target the internal database ID "targetID". 
+    /** 
+     * @param targetID the internal database Id of a target.
+     * @return the list of the cached representation's ID-s for the target with the internal database ID "targetID". 
      */
     public List<Number> getCachedRepresentationsForTarget(Number targetID);
@@ -59 +60 @@
     /**
      *
-     * @param cachedInfo the metadata of the cached representation (incl.the date of creation and mime-type.
+     * @param cachedInfo a {@link CachedRepresentationInfo} object representing the metadata of a cached representation.
      * @param cachedBlob the content of the cached representation, considered as BLOB.
-     * @return the internal ID of the just added "cached", or throws the exception if adding fails.
+     * @return the internal ID of the just added cached representation, or throws an exception if adding fails.
      * @throws NotInDataBaseException if there is no object with the generated for the new cached representation external id. 
      * @throws IOException if reading blob fails.
@@ -74 +75 @@
     /**
      * 
-     * @param internalID the internal database id of the cached representation.
-     * @param cachedInfo the new metadata for it.
+     * @param internalID the internal database id of a cached representation.
+     * @param cachedInfo new metadata for it.
      * @return # of updated rows in the table "cached_representation". Must be 1 if updated, and 0 otherwise.
      */
@@ -82 +83 @@
     /**
      * 
-     * @param internalID the internal database id of the cached representation.
+     * @param internalID the internal database id of a cached representation.
      * @param cachedBlob the new content considered as BLOB.
      * @return # of updated rows in the table "cached_representation". Must be 1 if updated, and 0 otherwise.
@@ -94 +95 @@
     /**
      *
-     * @param internalID the internal database id of the cached representation.
+     * @param internalID the internal database id of a cached representation.
      * @return # deleted rows on the table "cached_representation".
      */