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

Timestamp:

08/25/13 21:05:37 (11 years ago)

Author:

olhsha

Message:

making javadoc comments for signatures in all dao-s (except dispatcher)

File:

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

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

@@ -34 +34 @@
      * 
      * @param internalID
-     * @return the instance of Version.class  with the internal Id equal to "internalID"
+     * @return the Version-object build from the version  with the "internalID".
      * 
      */
@@ -43 +43 @@
      * 
      * @param versionID
-     * @return The list of the cached representation internal id-s of all the cached representations of the version with "versionID"
+     * @return The list of the cached-representation internal ID-s of all the cached representations of the version with "versionID".
      */
     public List<Number> retrieveCachedRepresentationList(Number versionID);
     
      
-    // Not tested
-    public boolean versionIsInUse(Number versionsID);
+    /**
+     * 
+     * @param versionsID
+     * @return true if "versionID" occurs in the table "versions_cached_representations".
+     */
+    public boolean versionIsInUse(Number versionID);
     
     
@@ -56 +60 @@
      **/
     
-    
+    /**
+     * 
+     * @param versionID
+     * @param cachedID
+     * @return # rows added to the table "versions_cached_representations", when adding the pair (versionID, sourceID). Should be 1, if it has been added.
+     */
     public int addVersionCachedRepresentation(Number versionID, Number cachedID);
     
@@ -63 +72 @@
      * 
      * @param version
-     * @return the internal Id of the just added version
+     * @return the internal Id of the just added "version", or null if it has not been added.
      * 
      */
@@ -76 +85 @@
      
     /** @param versionID
-     * @return deleted rows in "version" table
+     * @return # deleted rows in "version" table after deleting the version with "versionID". Should be "1" if the version has been deleted.
      */
     
     public int deleteVersion(Number versionID);
     
-    
+    /**
+     * 
+     * @param versionID
+     * @param cachedID
+     * @return # deleted rows in the table "versions_cached_representations" after deleting the pair (versionID, cachedID).
+     */
     public int deleteVersionCachedRepresentation(Number versionID, Number cachedID);
     
     
-    
+    /**
+     * 
+     * @param versionID
+     * @return # deleted rows in the table "versions_cached_representations" after deleting all the pairs of the form (versionID, *).
+     */
     public int deleteAllVersionCachedRepresentation(Number versionID);