Remove extension of BaseRowsCommand

Author: labkey-nicka

src/org/labkey/remoteapi/query/BaseRowsCommand.java

@@ -239,48 +239,64 @@ public JSONObject getJsonObject()
             json.put("extraContext", getExtraContext());
         if (getAuditBehavior() != null)
             json.put("auditBehavior", getAuditBehavior());
-        if (getAuditUserComment() != null)
-            json.put("auditUserComment", getAuditUserComment());
 
+        stringToJson(json, "auditUserComment", getAuditUserComment());
+        json.put("rows", rowsToJson(getRows()));
+
+        return json;
+    }
+
+    @Override
+    protected RowsResponse createResponse(String text, int status, String contentType, JSONObject json)
+    {
+        return new RowsResponse(text, status, contentType, json, this);
+    }
+
+    static void stringToJson(JSONObject json, String prop, String value)
+    {
+        if (value != null && !value.isEmpty())
+        {
+            String trimmed = value.trim();
+            if (!trimmed.isEmpty())
+                json.put(prop, trimmed);
+        }
+    }
+
+    static JSONArray rowsToJson(List<Map<String, Object>> rows)
+    {
         //unfortunately, JSON simple is so simple that it doesn't
         //encode maps into JSON objects on the fly,
         //nor dates into property JSON format
         JSONArray jsonRows = new JSONArray();
-        if(null != getRows())
+        if (null != rows && !rows.isEmpty())
         {
-            SimpleDateFormat fmt = new SimpleDateFormat("d MMM yyyy HH:mm:ss Z");
-            for(Map<String, Object> row : getRows())
+            SimpleDateFormat dateFormat = new SimpleDateFormat("d MMM yyyy HH:mm:ss Z");
+            for (Map<String, Object> row : rows)
             {
-                JSONObject jsonRow;
-                if (row instanceof JSONObject jo) //optimization
+                if (row instanceof JSONObject jo)
                 {
-                    jsonRow = jo;
+                    jsonRows.put(jo);
                 }
                 else
                 {
-                    jsonRow = new JSONObject();
-                    //row map entries must be scalar values (no embedded maps or arrays)
-                    for(Map.Entry<String, Object> entry : row.entrySet())
+                    JSONObject jsonRow = new JSONObject();
+                    // Row map entries must be scalar values (no embedded maps or arrays)
+                    for (Map.Entry<String, Object> entry : row.entrySet())
                     {
                         Object value = entry.getValue();
 
-                        if(value instanceof Date)
-                            value = fmt.format((Date)value);
+                        if (value instanceof Date dateValue)
+                            value = dateFormat.format(dateValue);
 
                         // JSONObject.wrap allows us to save 'null' values.
                         jsonRow.put(entry.getKey(), JSONObject.wrap(value));
                     }
+
+                    jsonRows.put(jsonRow);
                 }
-                jsonRows.put(jsonRow);
             }
         }
-        json.put("rows", jsonRows);
-        return json;
-    }
 
-    @Override
-    protected RowsResponse createResponse(String text, int status, String contentType, JSONObject json)
-    {
-        return new RowsResponse(text, status, contentType, json, this);
+        return jsonRows;
     }
 }

src/org/labkey/remoteapi/query/SaveRowsCommand.java

@@ -1,11 +1,8 @@
 package org.labkey.remoteapi.query;
 
 import org.json.JSONObject;
-import org.labkey.remoteapi.CommandException;
-import org.labkey.remoteapi.Connection;
 import org.labkey.remoteapi.PostCommand;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -49,7 +46,7 @@
  *      )));
  *  updateCmd.setAuditBehavior(SaveRowsCommand.AuditBehavior.DETAILED);
  *  updateCmd.setAuditUserComment("Updated promoter region coordinates based on new assembly");
- *  saveCmd.addCommand(updateCmd);
+ *  saveCmd.addCommands(updateCmd);
  *
  *  // Delete obsolete annotation
  *  saveCmd.addCommand(new Command(CommandType.Delete, "genome", "GeneAnnotations",
@@ -156,105 +153,136 @@ public enum CommandType
         Delete
     }
 
-    public static class Command extends BaseRowsCommand
+    // N.B. You may be inclined to have this share implementation with BaseRowsCommand; however, I would caution
+    // against doing so. This class does not represent a command like a PostCommand or a GetCommand but rather
+    // aligns with the "commands" made on a request to the save rows endpoint.
+    public static class Command
     {
+        BaseRowsCommand.AuditBehavior _auditBehavior;
+        String _auditUserComment;
         final CommandType _commandType;
         String _containerPath;
+        Map<String, Object> _extraContext;
+        List<Map<String, Object>> _rows;
+        final String _queryName;
+        final String _schemaName;
         Boolean _skipReselectRows;
 
         public Command(CommandType commandType, String schemaName, String queryName, List<Map<String, Object>> rows)
         {
-            super(schemaName, queryName, null);
             assert null != commandType;
+            assert null != schemaName && !schemaName.isEmpty();
+            assert null != queryName && !queryName.isEmpty();
+
             _commandType = commandType;
-            setRows(rows);
+            _schemaName = schemaName;
+            _queryName = queryName;
+            _rows = rows;
         }
 
         public JSONObject getJsonObject()
         {
-            JSONObject json = super.getJsonObject();
+            JSONObject json = new JSONObject();
+
             json.put("command", getCommandType().name().toLowerCase());
+            json.put("schemaName", getSchemaName());
+            json.put("queryName", getQueryName());
+            json.put("rows", BaseRowsCommand.rowsToJson(getRows()));
+
+            if (getAuditBehavior() != null)
+                json.put("auditBehavior", getAuditBehavior());
+
+            BaseRowsCommand.stringToJson(json, "auditUserComment", getAuditUserComment());
+            BaseRowsCommand.stringToJson(json, "containerPath", getContainerPath());
 
-            if (getContainerPath() != null && !getContainerPath().isEmpty())
-                json.put("containerPath", getContainerPath());
+            if (getExtraContext() != null && !getExtraContext().isEmpty())
+                json.put("extraContext", getExtraContext());
 
             if (isSkipReselectRows() != null)
                 json.put("skipReselectRows", isSkipReselectRows());
 
             return json;
         }
 
-        public CommandType getCommandType()
+        public BaseRowsCommand.AuditBehavior getAuditBehavior()
         {
-            return _commandType;
+            return _auditBehavior;
         }
 
-        public String getContainerPath()
+        public Command setAuditBehavior(BaseRowsCommand.AuditBehavior auditBehavior)
         {
-            return _containerPath;
+            _auditBehavior = auditBehavior;
+            return this;
         }
 
-        public void setContainerPath(String containerPath)
+        public String getAuditUserComment()
         {
-            _containerPath = containerPath;
+            return _auditUserComment;
         }
 
-        public Boolean isSkipReselectRows()
+        public Command setAuditUserComment(String auditUserComment)
         {
-            return _skipReselectRows;
+            _auditUserComment = auditUserComment;
+            return this;
         }
 
-        public void setSkipReselectRows(Boolean skipReselectRows)
+        public CommandType getCommandType()
         {
-            _skipReselectRows = skipReselectRows;
+            return _commandType;
         }
 
-        @Override
-        public String getActionName()
+        public String getContainerPath()
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            return _containerPath;
         }
 
-        @Override
-        public String getControllerName()
+        public Command setContainerPath(String containerPath)
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            _containerPath = containerPath;
+            return this;
         }
 
-        @Override
-        public RowsResponse execute(Connection connection, String folderPath) throws IOException, CommandException
+        public Map<String, Object> getExtraContext()
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            return _extraContext;
         }
 
-        @Override
-        public double getRequiredVersion()
+        public Command setExtraContext(Map<String, Object> extraContext)
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            _extraContext = extraContext;
+            return this;
         }
 
-        @Override
-        public void setRequiredVersion(double requiredVersion)
+        public String getQueryName()
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            return _queryName;
         }
 
-        @Override
-        public Integer getTimeout()
+        public String getSchemaName()
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            return _schemaName;
         }
 
-        @Override
-        public void setTimeout(Integer timeout)
+        public List<Map<String, Object>> getRows()
         {
-            throw new UnsupportedOperationException(unsupportedMethodMessage());
+            return _rows;
         }
 
-        private String unsupportedMethodMessage()
+        public Command setRows(List<Map<String, Object>> rows)
         {
-            // "Command does not support methodName()."
-            return Command.class.getSimpleName() + " does not support " + new Throwable().getStackTrace()[1].getMethodName() + "().";
+            _rows = rows;
+            return this;
+        }
+
+        public Boolean isSkipReselectRows()
+        {
+            return _skipReselectRows;
+        }
+
+        public Command setSkipReselectRows(Boolean skipReselectRows)
+        {
+            _skipReselectRows = skipReselectRows;
+            return this;
         }
     }
 }