Changeset 4076

Timestamp:

Jan 11, 2008, 4:16:30 PM (15 years ago)

Author:

Martin Svensson

Message:

Fixes #879 Add column holding the filename of last file used for updating reporter annotations. The documentation, reporter importer plugins and web client are now also updated to support this new column.

Location:

trunk

Files:

• doc/src/docbook/developerdoc/api_overview.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/ReporterBatcher.java (modified) (6 diffs)
• src/plugins/core/net/sf/basedb/plugins/CdfFileReporterImporter.java (modified) (1 diff)
• src/plugins/core/net/sf/basedb/plugins/ReporterFlatFileImporter.java (modified) (2 diffs)
• src/plugins/core/net/sf/basedb/plugins/ReporterMapFlatFileImporter.java (modified) (1 diff)
• www/views/reporters/index.jsp (modified) (1 diff)
• www/views/reporters/list_reporters.jsp (modified) (2 diffs)
• www/views/reporters/view_reporter.jsp (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/api_overview.xml

@@ -730 +730 @@
         
         <para>
-          The <property>lastUpdate</property> property holds the data and time
-          the reporter information was last updated. The value is managed automatically
-          by the <classname>ReporterBatcher</classname> class.
+          The
+          <property>lastUpdate</property>
+          property holds the data and time the reporter information was last updated. The
+          value is managed automatically by the
+          <classname>ReporterBatcher</classname>
+          class. That goes for
+          <property>lastSource</property>
+          property too, which holds information about where the last update comes from. By
+          default this is set to the name of the logged in user, but it can be changed by
+          calling
+          <methodname>ReporterBatcher.setUpdateSource(String source)</methodname>
+          before the batcher commits the updates to the database. The source-string 
+          should have the format: <synopsis>[ITEM_TYPE]:[ITEM_NAME]</synopsis> where,in 
+          the file-case, ITEM_TYPE is File and ITEM_NAME is the file's name.
         </para>
       </sect3>

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

@@ -43 +43 @@
   extends BasicBatcher<ReporterData>
 {
+  
+  /**
+    A string to hold the name of the source, 
+    used to update the reporters.
+   */
+  private String updateSource = null;
 
   /**
@@ -49 +55 @@
     @param dc The DbControl to use for database access and 
       permission checking
+    @return A new instance of ReporterBatcher.
     @throws BaseException If there is an error
   */
@@ -56 +63 @@
     ReporterBatcher rb = new ReporterBatcher(dc);
     rb.initPermissions(0, 0);
-    rb.checkPermission(Permission.READ);
+    rb.checkPermission(Permission.READ);    
     return rb;
   }
@@ -155 +162 @@
   {
     setPropertyValue(data, "lastUpdate", new Date());
-    setPropertyValue(data, "lastSource", updateSource != null ? updateSource : "n/a");
+    if (updateSource == null)
+    {
+      int editorId = this.getDbControl().getSessionControl().getLoggedInUserId();
+      User editor = User.getById(this.getDbControl(), editorId);
+      updateSource = "User: " + editor.getName();
+    }
+    setPropertyValue(data, "lastSource", updateSource);
   }
   // -------------------------------------------
@@ -164 +177 @@
   private org.hibernate.Query findReporter;
   
-  /**
-    A string to hold the name of the source, 
-    used to update the reporters.
-   */
-  private String updateSource = null;
   /**
     Check if a reporter with a given external id exists in the database or
@@ -258 +266 @@
   /**
     Set the source that was used when updating the reporters. 
-    This must be set before committing this batcher.       
+    This must be set before committing this batcher otherwise the column 
+    for last update source will be set to n/a.       
     @param source The source to be set. The format of the source string 
       should be like: "[item_type]:[item_name]"   

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

@@ -463 +463 @@
   {
     ReporterBatcher batcher = ReporterBatcher.getNew(dc);
+    if (job.getValue("file") != null)
+    {
+      batcher.setUpdateSource("File: " + ((File)job.getValue("file")).getName());
+    }
     ReporterType type = (ReporterType)job.getValue("reporterType");
     String mode = (String)job.getValue("mode");

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

@@ -26 +26 @@
 package net.sf.basedb.plugins;
 
+import net.sf.basedb.core.File;
 import net.sf.basedb.core.FileType;
 import net.sf.basedb.core.HibernateUtil;
@@ -442 +443 @@
       deleted = HibernateUtil.getDbEngine().caseInsensitiveComparison() ?
         new TreeSet<String>(String.CASE_INSENSITIVE_ORDER) : new HashSet<String>();
+    }
+    if (job.getValue("file") != null)
+    {
+      batcher.setUpdateSource("File: " + ((File)job.getValue("file")).getName());
     }
     numInserted = 0;

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

@@ -423 +423 @@
       addErrorHandler(ItemNotFoundException.class, new SimpleErrorHandler("skip".equals(method)));
     }
+    if (job.getValue("file") != null)
+    {
+      reporterBatcher.setUpdateSource("File: " + ((File)job.getValue("file")).getName());
+    }
     
     numFeatures = 0;

trunk/www/views/reporters/index.jsp

@@ -42 +42 @@
   import="net.sf.basedb.core.PermissionDeniedException"
   import="net.sf.basedb.core.BaseException"
+  import="net.sf.basedb.core.User"
   import="net.sf.basedb.util.RemovableUtil"
   import="net.sf.basedb.util.ShareableUtil"

trunk/www/views/reporters/list_reporters.jsp

@@ -243 +243 @@
         exportable="true"
         formatter="<%=timeFormatter%>"
+      />
+      <tbl:columndef 
+        id="lastSource"
+        property="lastSource"
+        datatype="string"
+        title="Last source"
+        sortable="true"
+        filterable="true"
+        exportable="true"
       />
       <%
@@ -424 +433 @@
                 <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
                 <tbl:cell column="lastUpdate" value="<%=item.getLastUpdate()%>" />
+                <tbl:cell column="lastSource"><%=HTML.encodeTags(item.getLastSource())%></tbl:cell>
                 <tbl:cell column="reporterType"
                   ><base:propertyvalue 

trunk/www/views/reporters/view_reporter.jsp

@@ -191 +191 @@
         <td><%=dateFormatter.format(reporter.getLastUpdate())%></td>
       </tr>
+      <tr>
+        <td class="prompt">Last source</td>
+        <td><%=HTML.niceFormat(reporter.getLastSource())%></td>
+      </tr>
       </table>