Changeset 7298

Timestamp:

Feb 21, 2017, 9:49:31 AM (6 years ago)

Author:

Nicklas Nordborg

Message:

References #2056: Improve API for project-specific annotations

The AnnotationBatcher should now have support for setting a specific project to work with. A single batcher may only work with one project (or with default values) during it's lifetime. It is not possible to switch strategy between items or annotation types.

Location:

trunk/src/core

Files:

• common-queries.xml (modified) (1 diff)
• net/sf/basedb/core/AnnotationBatcher.java (modified) (7 diffs)

trunk/src/core/common-queries.xml

@@ -3583 +3583 @@
       SELECT [annotationtype_id], [id], [version], [unit_id], [value_id], [last_update], [project_id], [override_id]
       FROM [Annotations] 
-      WHERE [annotationset_id] = :annotationSet AND [source] = 0 AND ([project_id] = 0 OR [project_id] = :activeProject)
+      WHERE [annotationset_id] = :annotationSet AND [source] = 0 AND ([project_id] = :defaultProject OR [project_id] = :activeProject)
     </sql>
     <description>

trunk/src/core/net/sf/basedb/core/AnnotationBatcher.java

@@ -77 +77 @@
   </ul>
   
+  The batcher support project-specific annotations. The default mode (setting projectId=null)
+  makes the batcher to use the currently active project. Project-specific annotation values
+  will only be created if they are different from the default values.
+  
+  Setting projectId to 0 or to a specific project makes the batcher to only consider
+  default or the project-specific values. The currently active project is not taken into
+  account.
+  
   @author nicklas
   @since 3.8
@@ -90 +98 @@
   private final Item itemType;
   private final int activeProjectId;
+  private final Integer projectId;
   
   // All updates through this batcher get the same date+time
@@ -163 +172 @@
   private final Map<String, UnitConverter> unitConvertes;
   
+  public AnnotationBatcher(DbControl dc, Item itemType)
+  {
+    this(dc, itemType, null);
+  }
+  
   /**
     Create a new batcher instance. 
     @param dc A DbControl to use for database access
     @param itemType The type of items to work with. This must be an annotatable item type.
+    @param projectId Specify a project id to only consider values for that project
+      when working with a project-specific annotation, or 0 to only consider default
+      values, or null to automatically use the default or project-specific values for
+      the currently active project
+    @since 3.11
   */
   @SuppressWarnings({ "unchecked", "rawtypes" })
-  public AnnotationBatcher(DbControl dc, Item itemType)
+  public AnnotationBatcher(DbControl dc, Item itemType, Integer projectId)
   {
     if (dc == null) throw new NullPointerException("dc");
@@ -179 +198 @@
     
     this.itemType = itemType;
-    this.activeProjectId = dc.getSessionControl().getActiveProjectId();
+    this.projectId = projectId;
+    this.activeProjectId = projectId == null ? dc.getSessionControl().getActiveProjectId() : projectId;
     this.batchDate = new Date();
     
@@ -218 +238 @@
         PredefinedQuery.getQueryString("AB_LOAD_ANNOTATION_INFO"));
       loadAnnotationInfo.setInteger("activeProject", activeProjectId);
+      loadAnnotationInfo.setInteger("defaultProject", projectId == null ? 0 : projectId);
       this.loadAnnotationValues = new org.hibernate.Query[types.length];
       this.valueIds = new List[types.length];
@@ -675 +696 @@
         {
           
-          if (info.useProjectAnnotations && info.projectId == 0 && activeProjectId != 0)
+          if (projectId == null && info.useProjectAnnotations && info.projectId == 0 && activeProjectId != 0)
           {
             // Deleting a default value for a project-specific annotation type is only allowed
@@ -787 +808 @@
             // If the current info is default values for a project-specific annotation 
             // type we need to create a new annotation that is overriding the default values
-            if (info.useProjectAnnotations && info.projectId == 0 && activeProjectId != 0)
+            if (projectId == null && info.useProjectAnnotations && info.projectId == 0 && activeProjectId != 0)
             {
               info.overrideId = info.annotationId;