Changeset 7590

Timestamp:

Feb 18, 2019, 1:19:56 PM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2149: Batch item importers should be able to use an annotation for item identification

Implemented a way to set the identifier when creating new items. This used to work automatically before since it was handled by the column mappers for each of the identification methods. This did not work when using annotations since there are no column mappers for annotation types.

IdMethod.setIdentifierOnNewItem() method was added and implemented by the AnnotationIdMethod to make sure that the specified annotation is set on new items.

Location:

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

Files:

• AbstractItemImporter.java (modified) (1 diff)
• AnnotationIdMethod.java (modified) (2 diffs)
• IdMethod.java (modified) (1 diff)

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

@@ -766 +766 @@
         {
           item = createItem(dc, data);
+          idMethod.setIdentifierOnNewItem(dc, item, identifier);
           if (permissionTemplateMapper != null) updatePermissions(dc, (Shareable)item, data, true);
           dc.saveItem(item);

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

@@ -24 +24 @@
 import java.util.List;
 
+import net.sf.basedb.core.Annotatable;
+import net.sf.basedb.core.Annotation;
 import net.sf.basedb.core.AnnotationType;
 import net.sf.basedb.core.BasicItem;
@@ -117 +119 @@
     return query.list(dc);
   }
+  
+  /**
+    Set the annotation on a newly created item.
+  */
+  @Override
+  public <I extends BasicItem> boolean setIdentifierOnNewItem(DbControl dc, I item, String identifier)
+  {
+    if (annotationType == null)
+    {
+      throw new NullPointerException("No annotation type has been specified for 'Annotation' identification method.");
+    }
+    Annotatable aItem = (Annotatable)item;
+    Type idType = annotationType.getValueType();
+    Annotation annotation = aItem.getAnnotationSet().getAnnotation(annotationType);
+    boolean changed = annotation.setValueIfDifferent(idType.parseString(identifier), null);
+    return changed;
+  }
+  
   // ---------------------------
   

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

@@ -80 +80 @@
   public <I extends BasicItem> List<I> find(DbControl dc, ItemQuery<I> query, String identifier);
 
+  /**
+    Set the ID on a newly created item when this is not done by other regular
+    column mappers. The default implementation of this method does nothing.
+    @return TRUE if the identifier was set, FALSE if not
+    @since 3.15
+  */
+  public default <I extends BasicItem> boolean setIdentifierOnNewItem(DbControl dc, I item, String identifier)
+  {
+    return false;
+  }
+  
 }