org.labkey.remoteapi.query.RowsResponse 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.apache.commons.logging.LogFactory;
import org.labkey.remoteapi.CommandResponse;
import org.labkey.remoteapi.Command;
import org.labkey.remoteapi.collections.CaseInsensitiveHashMap;
import org.json.simple.JSONObject;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
/*
* User: Dave
* Date: Jul 14, 2008
* Time: 11:57:17 AM
*/
/**
* Base class for command responses that contain an array of rows
* and meta-data about those rows. Primarily, this class converts
* date values in the rows array to real Java Date objects.
*/
abstract class RowsResponse extends CommandResponse
{
/**
* Constructs a new RowsResponse given the specified 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 The source command object
*/
RowsResponse(String text, int statusCode, String contentType, JSONObject json, Command sourceCommand)
{
super(text, statusCode, contentType, json, sourceCommand);
fixupParsedData();
caseInsensitizeRowMaps();
}
/**
* Returns the list of rows from the parsed response data.
* Note that numbers in the map values will be either of type
* Double or type Long depedning on the prescence of a decimal point.
* The most reliable way to work with them is to use the Number class.
* For example:
*
* for (Map<String,Object> row : response.getRows())
* {
* Number key = (Number)row.get("Key");
* // use Number.intValue(), doubleValue(), longValue(), etc to get various primitive types
* }
*
* @return The list of rows (each row is a Map), or null if
* the rows list was not included in the response.
*/
public List> getRows()
{
return getProperty("rows");
}
/**
* Fixes up the parsed data. Currently, this converts string-based
* date literals into real Java Date objects.
*/
private void fixupParsedData()
{
if(null == getParsedData())
return;
//because JSON does not have a literal representation for dates
//we need to fixup date values in the response rows for columns
//of type date.
//we also should convert numeric values to their proper Java types
//based on the meta-data type name (int vs float)
//build up the list of date fields
List dateFields = new ArrayList<>();
List intFields = new ArrayList<>();
List floatFields = new ArrayList<>();
List> fields = getProperty("metaData.fields");
if(null == fields)
return;
for(Map field : fields)
{
String type = (String)field.get("type");
if("date".equalsIgnoreCase(type))
dateFields.add((String)field.get("name"));
else if ("float".equalsIgnoreCase(type))
floatFields.add((String)field.get("name"));
else if ("int".equalsIgnoreCase(type))
intFields.add((String)field.get("name"));
}
//if no fields to fixup, just return
if(dateFields.size() == 0 && floatFields.size() == 0 && intFields.size() == 0)
return;
//run the rows array and fixup date fields
List> rows = getRows();
if(null == rows || rows.size() == 0)
return;
//The selectRows.api returns dates in a very particular format so that
//JavaScript can parse them into actual date classes. If this format ever
//changes, we'll need to change the format string used here.
//CONSIDER: use a library like ConvertUtils to avoid this dependency?
DateParser dateFormat = new DateParser();
boolean expandedFormat = getRequiredVersion() == 9.1;
for (Map row : rows)
{
for(String field : dateFields)
{
//in expanded format, the value is another JSONObject with several
//possible properties, including "value" which is the column's value
Object dateString = expandedFormat ? ((JSONObject)row.get(field)).get("value") : row.get(field);
if(null != dateString && dateString instanceof String)
{
//parse the string into a Java Date and
//reset the association
try
{
Date date = dateFormat.parse((String)dateString);
if(null != date)
{
if(expandedFormat)
((JSONObject)row.get(field)).put("value", date);
else
row.put(field, date);
}
}
catch(ParseException e)
{
//just log it--if it doesn't parse, we can't fix it up
LogFactory.getLog(SelectRowsResponse.class).warn("Failed to parse date '"
+ dateString + "': " + e);
}
} //if the value is present and a string
} //for each date field
//floats
for (String field : floatFields)
{
Object value = expandedFormat ? ((JSONObject)row.get(field)).get("value") : row.get(field);
if (value instanceof Number)
{
Double number = ((Number) value).doubleValue();
if(expandedFormat)
((JSONObject)row.get(field)).put("value", number);
else
row.put(field, number);
}
}
//ints
for (String field : intFields)
{
Object value = expandedFormat ? ((JSONObject)row.get(field)).get("value") : row.get(field);
if (value instanceof Number)
{
Integer number = ((Number) value).intValue();
if(expandedFormat)
((JSONObject)row.get(field)).put("value", number);
else
row.put(field, number);
}
}
} //for each row
} //fixupParsedData()
private void caseInsensitizeRowMaps()
{
//copy the row maps into case-insensitive hash maps
List> ciRows = new ArrayList<>();
for(Map row : getRows())
{
//copy the row map into a case-insensitive hash map
ciRows.add(new CaseInsensitiveHashMap<>(row));
}
//reset the rows array
getParsedData().put("rows", ciRows);
}
}