org.labkey.remoteapi.query.SaveRowsCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation
Show all versions of labkey-client-api Show documentation
The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.
/*
* Copyright (c) 2008-2016 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.JSONArray;
import org.json.JSONObject;
import org.labkey.remoteapi.PostCommand;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* Base class for commands that make changes to rows exposed from a given
* query in a given schema. Clients should use {@link UpdateRowsCommand},
* {@link InsertRowsCommand} or {@link DeleteRowsCommand} and not this class directly.
*
* All three of these subclasses post similar JSON to the server, so this class
* does all the common work. The client must supply three things: the schemaName,
* the queryName and an array of 'rows' (i.e. Maps). The rows are added via
* the {@link #addRow(Map)} or {@link #setRows(List)} methods.
*
* All data exposed from the LabKey Server is organized into a set of queries
* contained in a set of schemas. A schema is simply a group of queries, identified
* by a name (e.g., 'lists' or 'study'). A query is particular table or view within
* that schema (e.g., 'People' or 'Peptides'). Currently, clients may update rows in
* base tables only, and not in joined views. Therefore the query name must be the
* name of a table in the schema.
*
* To view the schemas and queries exposed in a given folder, add a Query web part
* to your portal page and choose the option "Show the list of tables in this schema"
* in the part configuration page. Alternatively, if it is exposed, click on the Query
* tab across the top of the main part of the page.
*
* Examples:
*
* // May need to add CONTEXT_PATH for dev instances
* Connection cn = new Connection("http://localhost:8080", user, password);
*
* //Insert Rows Command
* InsertRowsCommand cmd = new InsertRowsCommand("lists", "People");
*
* Map<String, Object> row = new HashMap<String, Object>();
* row.put("FirstName", "Insert");
* row.put("LastName", "Test");
*
* cmd.addRow(row); //can add multiple rows to insert many at once
* SaveRowsResponse resp = cmd.execute(cn, "PROJECT_NAME");
*
* //get the newly-assigned primary key value from the first return row
* int newKey = resp.getRows().get(0).get("Key");
*
* //Update Rows Command
* UpdateRowsCommand cmdUpd = new UpdateRowsCommand("lists", "People");
* row = new HashMap<String, Object>();
* row.put("Key", newKey);
* row.put("LastName", "Test UPDATED");
* cmdUpd.addRow(row);
* resp = cmdUpd.execute(cn, "PROJECT_NAME");
*
* //Delete Rows Command
* DeleteRowsCommand cmdDel = new DeleteRowsCommand("lists", "People");
* row = new HashMap<String, Object>();
* row.put("Key", newKey);
* cmdDel.addRow(row);
* resp = cmdDel.execute(cn, "PROJECT_NAME");
*
*/
public abstract class SaveRowsCommand extends PostCommand
{
private String _schemaName;
private String _queryName;
private Map _extraContext;
private List> _rows = new ArrayList<>();
/**
* Constructs a new SaveRowsCommand for a given schema, query and action name.
* @param schemaName The schema name.
* @param queryName The query name.
* @param actionName The action name to call (supplied by the derived class).
*/
protected SaveRowsCommand(String schemaName, String queryName, String actionName)
{
super("query", actionName);
assert null != schemaName;
assert null != queryName;
_schemaName = schemaName;
_queryName = queryName;
}
/**
* 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;
}
/**
* Gets the additional extra context.
* @return the extra context.
*/
public Map getExtraContext()
{
return _extraContext;
}
/**
* Sets the additional extra context.
* @param extraContext The extra context.
*/
public void setExtraContext(Map extraContext)
{
_extraContext = extraContext;
}
/**
* Returns the current list of 'rows' (i.e., Maps) that will
* be sent to the server.
* @return The list of rows.
*/
public List> getRows()
{
return _rows;
}
/**
* Sets the list of 'rows' (i.e., Maps) to be sent to the server.
* @param rows The rows to send
*/
public void setRows(List> rows)
{
_rows = rows;
}
/**
* Adds a row to the list of rows to be sent to the server.
* @param row The row to add
*/
public void addRow(Map row)
{
_rows.add(row);
}
/**
* Dynamically builds the JSON object to send based on the current
* schema name, query name and rows list.
* @return The JSON object to send.
*/
@Override
public JSONObject getJsonObject()
{
JSONObject json = new JSONObject();
json.put("schemaName", getSchemaName());
json.put("queryName", getQueryName());
if (getExtraContext() != null)
json.put("extraContext", getExtraContext());
//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())
{
SimpleDateFormat fmt = new SimpleDateFormat("d MMM yyyy HH:mm:ss Z");
for(Map row : getRows())
{
JSONObject jsonRow;
if(row instanceof JSONObject) //optimization
jsonRow = (JSONObject)row;
else
{
jsonRow = new JSONObject();
//row map entries must be scalar values (no embedded maps or arrays)
for(Map.Entry entry : row.entrySet())
{
Object value = entry.getValue();
if(value instanceof Date)
value = fmt.format((Date)value);
// JSONObject.wrap allows us to save 'null' values.
jsonRow.put(entry.getKey(), JSONObject.wrap(value));
}
}
jsonRows.put(jsonRow);
}
}
json.put("rows", jsonRows);
return json;
}
@Override
protected SaveRowsResponse createResponse(String text, int status, String contentType, JSONObject json)
{
return new SaveRowsResponse(text, status, contentType, json, this);
}
}