Changeset 5480

Timestamp:

Nov 8, 2010, 10:56:02 AM (12 years ago)

Author:

Nicklas Nordborg

Message:

References #1542: Plug-ins should be able to suggest a better job name

Fixed in the core API. Plug-ins can now call Response.setSuggestedJobName() to suggest a job name. The reporter importer was used as a test case. I will fix this in the remaining core plug-ins.

Location:

trunk

Files:

• src/core/net/sf/basedb/core/PluginResponse.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/plugin/Response.java (modified) (1 diff)
• src/plugins/core/net/sf/basedb/plugins/ReporterFlatFileImporter.java (modified) (1 diff)
• src/plugins/core/net/sf/basedb/plugins/executor/ExternalProgramExecutor.java (modified) (1 diff)
• www/common/plugin/index.jsp (modified) (2 diffs)

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

@@ -58 +58 @@
   private String message;
   private boolean dryRun;
+  private String suggestedJobName;
   private List<? extends Throwable> errorList;
   private String nextCommand;
@@ -92 +93 @@
   
   /**
+    Get the job name that was suggested by the job.
+  
+    @return A job name or null if no name has been suggested
+    @since 2.17
+  */
+  public String getSuggestedJobName()
+  {
+    return suggestedJobName;
+  }
+  
+  /**
     Get the return message from the plugin.
   */
@@ -312 +324 @@
       PluginResponse.this.dryRun = dryRun;
     }
+    
+    @Override
+    public void setSuggestedJobName(String jobName)
+    {
+      PluginResponse.this.suggestedJobName = jobName;
+    }
     // -------------------------------------------
   }

trunk/src/core/net/sf/basedb/core/plugin/Response.java

@@ -143 +143 @@
   
   /**
+    A plug-in may call this method on it's job configuration phase
+    to suggest a name for the job. Otherwise a default name will be
+    generated by the core.
+    @param jobName
+    @since 2.17
+  */
+  public void setSuggestedJobName(String jobName);
+  
+  /**
     This will end the job execution or configuration and report it as a 
     failure. If in a configuration sequence the client application may try 

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

@@ -388 +388 @@
         storeValue(job, request, reporterIsUsedErrorParameter);
         
+        File importFile = (File)job.getValue(fileParameter.getName());
+        if (reporterListContext)
+        {
+          ReporterList reporterList = (ReporterList)job.getValue("reporterList");
+          response.setSuggestedJobName("Import reporters to list '" + reporterList.getName()
+              + "' from '" + importFile.getName() + "'");
+        }
+        else
+        {
+          response.setSuggestedJobName("Import reporters from '" + importFile.getName() + "'");
+        }
         response.setDone("Job configuration complete", Job.ExecutionTime.SHORT);
       }

trunk/src/plugins/core/net/sf/basedb/plugins/executor/ExternalProgramExecutor.java

@@ -1372 +1372 @@
     {}
 
+    
+    @Override
+    public void setSuggestedJobName(String jobName)
+    {}
+    
     @Override
     public void setError(String message, List<? extends Throwable> errorList)

trunk/www/common/plugin/index.jsp

@@ -61 +61 @@
   import="net.sf.basedb.core.Include"
   import="net.sf.basedb.core.SimpleProgressReporter"
+  import="net.sf.basedb.core.StringUtil"
   import="net.sf.basedb.core.query.Hql"
   import="net.sf.basedb.core.query.Expressions"
@@ -484 +485 @@
       if (job != null)
       {
+        String suggestedJobName = pluginResponse.getSuggestedJobName();
+        if (suggestedJobName != null) job.setName(StringUtil.trimString(suggestedJobName, Job.MAX_NAME_LENGTH));
         sc.setSessionSetting("plugin.configure.response", pluginResponse);
         forward = "finish_job.jsp";