Changeset 7593

Timestamp:

Feb 20, 2019, 9:13:00 AM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2150: Batch item importers in item list members view

The annotation importer has been updated so that if it is started from the "Members" tab of an item list, it will only update annotations on items that are members of the list.

Location:

trunk/src/plugins/core/net/sf/basedb/plugins

Files:

• AnnotationFlatFileImporter.java (modified) (8 diffs)
• batchimport/AnnotationIdMethod.java (modified) (1 diff)

trunk/src/plugins/core/net/sf/basedb/plugins/AnnotationFlatFileImporter.java

@@ -53 +53 @@
 import net.sf.basedb.core.Item;
 import net.sf.basedb.core.ItemContext;
+import net.sf.basedb.core.ItemList;
 import net.sf.basedb.core.ItemNotFoundException;
 import net.sf.basedb.core.ItemParameterType;
@@ -495 +496 @@
         if (forJob)
         {
+          storeValue(job, request, ri.getParameter("memberOfList"));
           storeValue(job, request, ri.getParameter("includeMine"));
           storeValue(job, request, ri.getParameter("includeShared"));
@@ -614 +616 @@
   private Map<String, Set<NewAnnotations>> itemCache;
   private ItemQuery<?> itemQuery;
+  private ItemList itemList;
   private boolean addToUnlimited;
   private boolean replaceExisting;
@@ -684 +687 @@
     this.idMethod = getIdMethod(dc, itemType, (String)job.getValue("idMethod"));
     this.idMapping = (String)job.getValue(idMethod.getColumnMappingParameterName());
-
-    /*
-    if (job.getValue("externalIdColumnMapping") != null)
-    {
-      this.searchProperty = "externalId";
-      this.searchParameterType = Type.STRING;
-      this.searchMapping = (String)job.getValue("externalIdColumnMapping");
-    }
-    else if (job.getValue("internalIdColumnMapping") != null)
-    {
-      this.searchProperty = "id";
-      this.searchParameterType = Type.INT;
-      this.searchMapping = (String)job.getValue("internalIdColumnMapping");
-    }
-    else
-    {
-      this.searchProperty = "name";
-      this.searchParameterType = Type.STRING;
-      this.searchMapping = (String)job.getValue("nameColumnMapping");
-    }
-    */
+    this.itemList = (ItemList)job.getValue("memberOfList");
     
     this.addToUnlimited = Boolean.TRUE.equals(job.getValue("addToUnlimited"));
@@ -777 +760 @@
     if (Boolean.TRUE.equals((Boolean)job.getValue("includeOthers"))) includes.add(Include.OTHERS);
     
-    itemQuery = idMethod.prepareQuery(dc, createQuery(itemType));
+    itemQuery = idMethod.prepareQuery(dc, createQuery(itemType, itemList));
     itemQuery.setIncludes(includes);
   }
@@ -1039 +1022 @@
   } 
   
+  /**
+    If the current context is the "Members" tab for an item list we load
+    the item list and will later require that all items to be annotated
+    are members of that list.
+  */
+  private ItemList getItemListFromContext(DbControl dc, GuiContext context)
+  {
+    ItemList list = null;
+    String subcontext = context.getSubContext();
+    if (subcontext != null && subcontext.startsWith("listmembers"))
+    {
+      // If subcontext is: "listmembers.nnnn" nnn is the id of the item list
+      int listId = Values.getInt(subcontext.split("\\.")[1]);
+      list = ItemList.getById(dc, listId);
+      // Reject lists with different type of member item (should not happen)
+      if (list.getMemberType() != context.getItem()) list = null;
+    }
+    return list;
+  }
+  
   private RequestInformation getConfigureParserParameters(GuiContext context, boolean forJob)
   {
@@ -1096 +1099 @@
         if (forJob)
         {
+          ItemList list = getItemListFromContext(dc, context);
+          if (list != null)
+          {
+            parameters.add(new PluginParameter<ItemList>(
+              "memberOfList", "Member of list",
+              "The plug-in will only update annotations for items if they are members of this list.",
+              new ItemParameterType<>(ItemList.class, list, true, 1, Arrays.asList(list))
+            ));
+          }
+
           ItemContext cc = sc.getCurrentContext(context.getItem());
           Set<Include> include = cc.getInclude();
@@ -1343 +1356 @@
     @return A query that searches items of the specified type.
   */
-  private ItemQuery<?> createQuery(Item itemType)
-  {
-    return itemType.getQuery();
+  private ItemQuery<?> createQuery(Item itemType, ItemList list)
+  {
+    return list != null && list.getMemberType() == itemType ? list.getMembers() : itemType.getQuery();
   }
   

trunk/src/plugins/core/net/sf/basedb/plugins/batchimport/AnnotationIdMethod.java

@@ -183 +183 @@
   public String toString()
   {
-    return "[A] " + annotationType.getName();
+    return annotationType.getName();
   }
   // --------------------------