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

Timestamp:

02/20/15 15:17:07 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Javadoc are updated for the interfaces NotebookDao?, ResourceDao?, TargetDao? and some helpers.

File:

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

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

@@ -37 +37 @@
     /**
      *
-     * @param inernalID
-     * @return the Target with the intrenal Id "internalID".
+     * @param inernalID the internal database id of a target.
+     * @return the {@link Target} object with the intrenal Id "internalID".
      */
     public Target getTarget(Number internalID);
@@ -44 +44 @@
     /**
      *
-     * @param targets
-     * @return the list of TargetInfo objects corresponding to the Targets with
-     * the internalIds from the list "Targets".
+     * @param targets the list of internal database ids of targets.
+     * @return the list of {@link TargetInfo} objects corresponding to the targets with the internalIds from the list "targets".
      */
     public List<TargetInfo> getTargetInfos(List<Number> targets);
@@ -52 +51 @@
     /**
      *
-     * @param targetID
-     * @return the list of pairs (cached_representation_id, fragment_descriptor)
-     * for the target with the internal ID "targetID".
+     * @param targetID the internal database id of a target.
+     * @return the list of pairs "cached_representation_id -> fragment_descriptor" for the target with the internal ID "targetID".
      */
     public Map<Number, String> getCachedRepresentationFragmentPairs(Number targetID);
@@ -62 +60 @@
     /**
      *
-     * @param targetID
-     * @return The link (uri) to the source to which the target refers
+     * @param targetID the internal database id of a target.
+     * @return The link (uri) to the source to which the target refers.
      */
     public String getLink(Number targetID);
@@ -69 +67 @@
     /**
      *
-     * @param link
-     * @return the list of Target ID's which link-fields is exactly "link"
+     * @param link a string representing a link (uri) to a target source.
+     * @return the list of internal database target ID's whose link-fields is exactly "link".
      */
     public List<Number> getTargetsForLink(String link);
 
+  /**
+   * 
+   * @param cachedID the internal database id of a cached representation.
+   * @return true iff "cachedID" is referred to for some target in "targets_cached_representations" table.
+   */
     boolean cachedIsInUse(Number cachedID);