org.labkey.remoteapi.sas.SASSelectRowsResponse 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) 2009-2011 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.sas;
import org.json.simple.JSONObject;
import org.labkey.remoteapi.CommandException;
import org.labkey.remoteapi.query.SelectRowsResponse;
import java.io.IOException;
import java.util.*;
import java.util.regex.Pattern;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
/**
* User: adam
* Date: Jan 10, 2009
* Time: 11:09:53 PM
*/
public class SASSelectRowsResponse
{
private final SelectRowsResponse _resp;
private final Iterator> _rowIterator;
private Map _sasToApiNames;
private Map _apiToSasNames;
private Map _currentRow;
// We need one constructor per command class because of SAS's method-calling limitations (object parameters must match expected class exactly).
public SASSelectRowsResponse(SASConnection cn, SASSelectRowsCommand command, String folderPath) throws CommandException, IOException
{
this(cn, (SASBaseSelectCommand)command, folderPath);
}
public SASSelectRowsResponse(SASConnection cn, SASExecuteSqlCommand command, String folderPath) throws CommandException, IOException
{
this(cn, (SASBaseSelectCommand)command, folderPath);
}
private SASSelectRowsResponse(SASConnection cn, SASBaseSelectCommand command, String folderPath) throws CommandException, IOException
{
_resp = command.execute(cn, folderPath);
_rowIterator = _resp.getRows().iterator();
createNameMapping(getFields());
}
private List> getFields()
{
return (List>)_resp.getMetaData().get("fields");
}
// Translate all api fields names into legal SAS identifiers. We'll report these names to SAS and lookup through
// these maps when we retrieve data or meta data via name.
private void createNameMapping(List> fields)
{
_sasToApiNames = new HashMap(fields.size());
_apiToSasNames = new HashMap(fields.size());
for (Map field : fields)
{
String apiName = field.get("name");
String sasName = makeLegal(apiName, _sasToApiNames.keySet());
_apiToSasNames.put(apiName, sasName);
_sasToApiNames.put(sasName, apiName);
}
}
private static final Pattern SAS_IDENTIFIER = Pattern.compile("[a-zA-Z_][\\w]{0,31}");
private static final String LEGAL_FIRST_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_";
private static final String LEGAL_CHARS = LEGAL_FIRST_CHARS + "0123456789";
public static void testMakeLegal()
{
List testNames = new ArrayList(120);
testNames.addAll(Arrays.asList("Foo", "Foo", "1Foo", "_Foo", "$56TS", "this/that", "howdeedoo_", "howdeedoo#"));
for (int i = 0; i < 102; i++)
testNames.add("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghi");
Set identifiers = new HashSet(testNames.size());
for (String apiName : testNames)
{
String sasName = makeLegal(apiName, identifiers);
if (!isLegal(sasName))
throw new IllegalStateException(apiName + " translated to " + sasName + ", which is not a legal SAS identifier");
System.out.println(apiName + " " + sasName);
identifiers.add(sasName);
}
int testCount = 100000;
identifiers = new HashSet(testCount);
Random random = new Random();
for (int i = 0; i < testCount; i++)
{
StringBuilder sb = new StringBuilder();
int length = 1 + random.nextInt(40);
for (int j = 0; j < length; j++)
sb.append((char)(32 + random.nextInt(95)));
String sasName = makeLegal(sb.toString(), identifiers);
if (!isLegal(sasName))
throw new IllegalStateException("\"" + sb.toString() + "\" translated to \"" + sasName + "\", which is not a legal SAS identifier");
if (!identifiers.add(sasName))
throw new IllegalStateException("\"" + sasName + "\"" + " already exists");
}
}
private static String makeLegal(String apiName, Set currentNames)
{
String legalName = apiName;
if (!isLegal(apiName))
{
// Max length is 32 characters
StringBuilder sasName = new StringBuilder(apiName.substring(0, Math.min(32, apiName.length())));
// Can't start with a number
String chars = LEGAL_FIRST_CHARS;
for (int i = 0; i < sasName.length(); i++)
{
// Replace each illegal character with an underscore
if (-1 == chars.indexOf(sasName.charAt(i)))
sasName.setCharAt(i, '_');
chars = LEGAL_CHARS;
}
legalName = sasName.toString();
}
// It's legal, but we may have a clash with an earlier identifier
int i = 1;
String candidateName = legalName;
// Append (or replace last chars if 32 chars) with 2, 3, 4, 5, etc. until we have a unique identifier
while (currentNames.contains(candidateName))
{
i++;
String suffix = String.valueOf(i);
if (legalName.length() + suffix.length() > 32)
candidateName = legalName.substring(0, 32 - suffix.length()) + suffix;
else
candidateName = legalName + suffix;
}
return candidateName;
}
private static boolean isLegal(String identifier)
{
return identifier.length() <= 32 && SAS_IDENTIFIER.matcher(identifier).matches();
}
private String getSasName(String apiName)
{
return _apiToSasNames.get(apiName);
}
private String getApiName(String apiName)
{
return _sasToApiNames.get(apiName.trim());
}
public int getColumnCount()
{
return getFields().size();
}
public String getColumnName(double index)
{
int i = (int)Math.round(index);
String apiName = getFields().get(i).get("name");
return getSasName(apiName);
}
public String getType(String sasName)
{
String apiName = getApiName(sasName);
SelectRowsResponse.ColumnDataType type = _resp.getColumnDataType(apiName);
return type.toString();
}
private Object getColumnModelProperty(double index, String propName)
{
int i = (int)Math.round(index);
Map columnModel = _resp.getColumnModel().get(i);
return columnModel.get(propName);
}
public boolean isHidden(double index)
{
return (Boolean)getColumnModelProperty(index, "hidden");
}
public int getScale(double index)
{
int scale = ((Number)getColumnModelProperty(index, "scale")).intValue();
return 0 == scale ? 100 : scale; // TODO: Temp hack -- 8.3 servers return different scale values than 9.1 -- for strings, scale == 0 at times
}
public String getLabel(double index)
{
return (String)getColumnModelProperty(index, "header");
}
public boolean allowsMissingValues(String sasName)
{
String apiName = getApiName(sasName);
Boolean mvEnabled = (Boolean)_resp.getMetaData(apiName).get("mvEnabled");
return (null != mvEnabled && mvEnabled);
}
public String getMissingValuesCode()
{
Map qcInfo = (Map)_resp.getParsedData().get("qcInfo");
StringBuilder values = new StringBuilder();
StringBuilder footnotes = new StringBuilder();
if (null != qcInfo)
{
int count = 1;
for (Map.Entry missing : qcInfo.entrySet())
{
values.append(" ").append(missing.getKey());
if (count <= 10)
footnotes.append("footnote").append(count++).append(" \"").append(missing.getKey()).append(" - ").append(missing.getValue()).append("\";\n");
}
}
if (values.length() > 0)
return "missing" + values + ";\n" + footnotes;
else
return "footnote;";
}
public boolean getRow()
{
boolean hasNext = _rowIterator.hasNext();
if (hasNext)
_currentRow = _rowIterator.next();
return hasNext;
}
/* TODO: Move the following methods to SASRow and return (new up) a SASRow instead of using getRow()? */
// Detect and handle both LabKey 8.3 and 9.1 formats
private Object getValue(String sasName)
{
String apiName = getApiName(sasName);
Object o = _currentRow.get(apiName);
if (_resp.getRequiredVersion() < 9.1)
return o;
else
return ((JSONObject)o).get("value");
}
public boolean isNull(String sasName)
{
return null == getValue(sasName);
}
public String getCharacter(String sasName)
{
return (String)getValue(sasName);
}
public double getNumeric(String sasName)
{
return ((Number)getValue(sasName)).doubleValue();
}
public boolean getBoolean(String sasName)
{
return (Boolean)getValue(sasName);
}
private DateFormat _df = new SimpleDateFormat("yyyy-MM-dd");
public String getDate(String sasName)
{
Date d = (Date)getValue(sasName);
return _df.format(d);
}
public String getMissingValue(String sasName)
{
if (_resp.getRequiredVersion() < 9.1)
throw new IllegalStateException("Missing values are only available when requiring LabKey 9.1 or later version");
String apiName = getApiName(sasName);
Object o = _currentRow.get(apiName);
return (String)((JSONObject)o).get("mvValue");
}
}