Cleanup

Author: labkey-jeckels

api/src/org/labkey/api/reports/report/InternalScriptEngineReport.java

@@ -15,15 +15,17 @@
  */
 package org.labkey.api.reports.report;
 
-import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.labkey.api.ApiModule;
 import org.labkey.api.module.ModuleLoader;
+import org.labkey.api.query.ValidationException;
 import org.labkey.api.reports.ExternalScriptEngine;
 import org.labkey.api.reports.report.r.ParamReplacement;
 import org.labkey.api.reports.report.r.ParamReplacementSvc;
 import org.labkey.api.reports.report.r.view.ConsoleOutput;
 import org.labkey.api.usageMetrics.SimpleMetricsService;
 import org.labkey.api.util.PageFlowUtil;
+import org.labkey.api.util.logging.LogHelper;
 import org.labkey.api.view.HtmlView;
 import org.labkey.api.view.HttpView;
 import org.labkey.api.view.VBox;
@@ -36,20 +38,21 @@
 import javax.script.ScriptContext;
 import javax.script.ScriptEngine;
 import javax.script.ScriptException;
+import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 
-/*
-* User: Karl Lum
-* Date: Jan 19, 2009
-* Time: 4:11:54 PM
-*/
+/**
+ * Executes scripts, such as R, and renders the results.
+ */
 public class InternalScriptEngineReport extends ScriptEngineReport
 {
     public static final String TYPE = "ReportService.internalScriptEngineReport";
+    private static final Logger LOG = LogHelper.getLogger(InternalScriptEngineReport.class, "Executes scripts, such as R, and renders the results.");
 
     @Override
     public String getType()
@@ -58,7 +61,7 @@ public String getType()
     }
 
     @Override
-    public HttpView<?> renderReport(ViewContext context) throws Exception
+    public HttpView<?> renderReport(ViewContext context) throws ValidationException, SQLException, IOException
     {
         VBox view = new VBox();
         String script = getDescriptor().getProperty(ScriptReportDescriptor.Prop.script);
@@ -81,7 +84,7 @@ public HttpView<?> renderReport(ViewContext context) throws Exception
         }
         catch (ScriptException e)
         {
-            LogManager.getLogger(getClass()).error("Error executing script", e);
+            LOG.error("Error executing script", e);
             final String error1 = "Error executing command";
             final String error2 = PageFlowUtil.filter(e.getMessage());
 
@@ -146,7 +149,7 @@ public String runScript(ViewContext context, List<ParamReplacement> outputSubst,
                 }
                 return output != null ? output.toString() : "";
             }
-            catch(Exception e)
+            catch (Exception e)
             {
                 if (!errors.getBuffer().isEmpty())
                     throw new ScriptException(e.getMessage() + errors.getBuffer());

api/src/org/labkey/api/reports/report/view/ReportUtil.java

@@ -19,7 +19,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.Strings;
 import org.apache.commons.lang3.math.NumberUtils;
-import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.json.JSONArray;
@@ -76,6 +76,7 @@
 import org.labkey.api.util.ThumbnailUtil;
 import org.labkey.api.util.URLHelper;
 import org.labkey.api.util.UniqueID;
+import org.labkey.api.util.logging.LogHelper;
 import org.labkey.api.view.ActionURL;
 import org.labkey.api.view.TabStripView;
 import org.labkey.api.view.ViewContext;
@@ -90,6 +91,8 @@
 
 public class ReportUtil
 {
+    private static final Logger LOG = LogHelper.getLogger(ReportUtil.class, "Utilities to help with report rendering and management");
+
     public static ActionURL getScriptReportDesignerURL(ViewContext context, ScriptReportBean bean)
     {
         ActionURL url = PageFlowUtil.urlProvider(ReportUrls.class).urlCreateScriptReport(context.getContainer());
@@ -395,7 +398,7 @@ public static void addErrors(List<ValidationError> reportErrors, Errors errors)
 
     public static String getErrors(List<ValidationError> reportErrors)
     {
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         for (ValidationError error : reportErrors)
             sb.append(error.getMessage()).append("\n");
 
@@ -527,31 +530,6 @@ public static boolean isInherited(CustomViewInfo view, Container container)
         return false;
     }
 
-    public static JSONArray getCreateReportButtons(ViewContext context)
-    {
-        List<ReportService.DesignerInfo> designers = new ArrayList<>();
-        for (ReportService.UIProvider provider : ReportService.get().getUIProviders())
-            designers.addAll(provider.getDesignerInfo(context));
-
-        designers.sort(Comparator.comparing(ReportService.DesignerInfo::getLabel));
-
-        JSONArray json = new JSONArray();
-
-        for (ReportService.DesignerInfo info : designers)
-        {
-            JSONObject o = new JSONObject();
-
-            o.put("text", info.getLabel());
-            o.put("id", info.getId());
-            o.put("disabled", info.isDisabled());
-            o.put("icon", info.getIconURL().getLocalURIString());
-            o.put("redirectUrl", info.getDesignerURL().getLocalURIString());
-
-            json.put(o);
-        }
-        return json;
-    }
-
     public static Report getReportById(ViewContext viewContext, String reportIdString)
     {
         ReportIdentifier reportId = ReportService.get().getReportIdentifier(reportIdString, viewContext.getUser(), viewContext.getContainer());
@@ -609,7 +587,7 @@ public static String createReportSessionId()
      */
     public static String makeExceptionString(Exception e, String formatString)
     {
-        LogManager.getLogger(ReportUtil.class).error("Error executing script - makeExceptionString", e);
+        LOG.warn("Error executing script", e);
         final String error1 = "Error executing command";
         final String error2 = PageFlowUtil.filter(e.getMessage());
         return String.format(formatString, error1, error2);