Update Truncate table response and command for external API

SVN r64435 |2019-09-04 20:29:01 +0000

Author: i.hilerio

.gitattributes

@@ -89,6 +89,7 @@ java/src/org/labkey/remoteapi/query/SelectRowsResponse.java -text
 java/src/org/labkey/remoteapi/query/Sort.java -text
 java/src/org/labkey/remoteapi/query/SqlExecuteCommand.java -text
 java/src/org/labkey/remoteapi/query/TruncateTableCommand.java -text
+java/src/org/labkey/remoteapi/query/TruncateTableResponse.java -text
 java/src/org/labkey/remoteapi/query/UpdateRowsCommand.java -text
 java/src/org/labkey/remoteapi/sas/Main.java -text
 java/src/org/labkey/remoteapi/sas/SASBaseSelectCommand.java -text

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

@@ -15,35 +15,98 @@
  */
 package org.labkey.remoteapi.query;
 
+import org.json.simple.JSONArray;
+import org.json.simple.JSONObject;
+import org.labkey.remoteapi.PostCommand;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Map;
+
 /**
  * Command for deleting rows from a read-write schema. The user associated
  * with the connection used when executing this command must have
  * permission to delete the data.
  * <p>
- * For details on schemas and queries, and example code, see the {@link SaveRowsCommand}.
  */
-public class TruncateTableCommand extends SaveRowsCommand
+public class TruncateTableCommand extends PostCommand<TruncateTableResponse>
 {
+    private String _schemaName;
+    private String _queryName;
+
     /**
      * Constructs a TruncateTableCommand for the given schemaName and queryName.
-     * See the {@link SaveRowsCommand} for more details.
      * @param schemaName The schemaName
-     * @param queryName The queryName.
-     * @see SaveRowsCommand
+     * @param queryName The queryName
      */
     public TruncateTableCommand(String schemaName, String queryName)
     {
-        super(schemaName, queryName, "truncateTable");
+        super("query", "truncateTable");
+        assert null != schemaName;
+        assert null != queryName;
+        _schemaName = schemaName;
+        _queryName = queryName;
     }
 
     public TruncateTableCommand(TruncateTableCommand source)
     {
         super(source);
     }
 
+    /**
+     * Returns the schema name.
+     * @return The schema name.
+     */
+    public String getSchemaName()
+    {
+        return _schemaName;
+    }
+
+    /**
+     * Sets the schema name
+     * @param schemaName The new schema name.
+     */
+    public void setSchemaName(String schemaName)
+    {
+        _schemaName = schemaName;
+    }
+
+    /**
+     * Returns the query name
+     * @return the query name.
+     */
+    public String getQueryName()
+    {
+        return _queryName;
+    }
+
+    /**
+     * Sets a new query name to update
+     * @param queryName the query name.
+     */
+    public void setQueryName(String queryName)
+    {
+        _queryName = queryName;
+    }
+
     @Override
     public TruncateTableCommand copy()
     {
         return new TruncateTableCommand(this);
     }
+
+    @Override
+    protected TruncateTableResponse createResponse(String text, int status, String contentType, JSONObject json)
+    {
+        return new TruncateTableResponse(text, status, contentType, json, copy());
+    }
+
+    public JSONObject getJsonObject()
+    {
+        JSONObject json = new JSONObject();
+        json.put("schemaName", getSchemaName());
+        json.put("queryName", getQueryName());
+        //json.put("rows", jsonRows);
+        return json;
+    }
 }

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

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2008-2009 LabKey Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.labkey.remoteapi.query;
+
+import org.json.simple.JSONObject;
+
+/*
+* User: Dave
+* Date: Jul 14, 2008
+* Time: 1:16:58 PM
+*/
+
+/**
+ * Response object used for commands that derive from SaveRowsCommand.
+ * This response object provides helper methods for accessing the important
+ * bits of the parsed response data.
+ */
+public class TruncateTableResponse extends RowsResponse
+{
+    /**
+     * Constructs a new SaveRowsResponse given the response text and status code
+     * @param text The response text.
+     * @param statusCode The HTTP status code.
+     * @param contentType The Content-Type header value.
+     * @param json The parsed JSONObject (or null if JSON was not returned).
+     * @param sourceCommand A copy of the command that created this response
+     */
+    public TruncateTableResponse(String text, int statusCode, String contentType, JSONObject json, TruncateTableCommand sourceCommand)
+    {
+        super(text, statusCode, contentType, json, sourceCommand);
+    }
+
+    /**
+     * Returns the 'rowsAffected' response property.
+     * @return The number of rows affected by the command, or null if this property
+     * was not present in the response.
+     */
+    public Number getDeletedRows()
+    {
+        return getProperty("deletedRows");
+    }
+
+    /**
+     * Returns the 'schemaName' response property.
+     * @return The schema name affected by the command, or null if this property
+     * was not present in the response.
+     */
+    public String getSchemaName()
+    {
+        return getProperty("schemaName");
+    }
+
+    /**
+     * Returns the 'queryName' response property.
+     * @return The query name affected by the command, or null if this property
+     * was not present in the response.
+     */
+    public String getQueryName()
+    {
+        return getProperty("queryName");
+    }
+
+    /**
+     * Returns the 'command' response property.
+     * @return The command executed, or null if this property
+     * was not present in the response.
+     */
+    public String getCommand()
+    {
+        return getProperty("command");
+    }
+}

java/src/org/labkey/remoteapi/test/Test.java

@@ -43,26 +43,26 @@ public class Test
     public static void main(String[] args) throws Exception
     {
         String baseUrl = "http://localhost:8080/labkey";
-        Connection cn = args.length < 2 ? new Connection(baseUrl) : new Connection(baseUrl, args[0], args[1]);
+        Connection cn = args.length < 2 ? new Connection(baseUrl) : new Connection(baseUrl, "israelh@labkey.com", "devdev1");
         //Connection cn = new Connection(baseUrl, new ApiKeyCredentialsProvider("session:d7c3a4aeb283e3e54c4126a707908420"));
         //Connection cn = new Connection(baseUrl, new NetRcCredentialsProvider(baseUrl));
 
         try
         {
             // Import /remoteapi/sas/People.xls as list "People" into project "Api Test"
-            selectTest(cn, "Api Test");
-            crudTest(cn, "Api Test");
-            execSqlTest(cn, "Api Test");
-            schemasTest(cn, "Api Test");
-            extendedFormatTest(cn, "Api Test");
-
-            // Run ShortStudyTest with -Dclean=false
-            datasetTest(cn, "StudyVerifyProject/My Study");
-
-            // Run NabAssayTest with -Dclean=false and rename subfolder "Rename############" to "nabassay"
-            nabTest(cn, "/Nab Test Verify Project/nabassay");
-            assayTest(cn, "/Nab Test Verify Project/nabassay");
-            truncateAssayFailsTest(cn, "/Nab Test Verify Project/nabassay");
+//            selectTest(cn, "Api Test");
+//            crudTest(cn, "Api Test");
+//            execSqlTest(cn, "Api Test");
+//            schemasTest(cn, "Api Test");
+//            extendedFormatTest(cn, "Api Test");
+//
+//            // Run ShortStudyTest with -Dclean=false
+//            datasetTest(cn, "StudyVerifyProject/My Study");
+//
+//            // Run NabAssayTest with -Dclean=false and rename subfolder "Rename############" to "nabassay"
+//            nabTest(cn, "/Nab Test Verify Project/nabassay");
+//            assayTest(cn, "/Nab Test Verify Project/nabassay");
+//            truncateAssayFailsTest(cn, "/Nab Test Verify Project/nabassay");
 
             truncateTableSuccessTest(cn, "Api Test");
             System.out.println("*** All tests completed successfully ***");
@@ -142,9 +142,9 @@ public static void crudTest(Connection cn, String folder) throws Exception
     public static void truncateTableSuccessTest(Connection cn, String folder) throws Exception
     {
         TruncateTableCommand trunc = new TruncateTableCommand("lists", "People");
-        SaveRowsResponse resp = trunc.execute(cn, folder);
+        TruncateTableResponse resp = trunc.execute(cn, folder);
 
-        assert resp.getRowsAffected().intValue() == 9;
+        assert resp.getDeletedRows().intValue() == 9;
         assert resp.getRows().size() == 0;
     }
 
@@ -298,7 +298,7 @@ public static void truncateAssayFailsTest(Connection cn, String folder) throws E
     {
         TruncateTableCommand trunc = new TruncateTableCommand("assay.NAb.TestAssayNab", "WellData");
         try{
-            SaveRowsResponse resp = trunc.execute(cn, folder);
+            TruncateTableResponse resp = trunc.execute(cn, folder);
             throw new RuntimeException("Truncate table command should not succeed for tables other than lists," +
                     "datasets, sample sets, data classes, and issues");
         }