org.labkey.remoteapi.sas.SASSelectRowsCommand 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

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.

There is a newer version: 6.2.0

Show newest version

/*
 * Copyright (c) 2009-2014 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.labkey.remoteapi.query.Filter;
import org.labkey.remoteapi.query.SelectRowsCommand;
import org.labkey.remoteapi.query.Sort;

import java.util.ArrayList;
import java.util.List;

/**
 * User: adam
 * Date: Dec 20, 2008
 * Time: 1:10:52 PM
 */

/*
    The SAS JavaObj interface can't invoke all methods.  For example, parameters can only be double, String, or JavaObj.
    Return types must be void, primitives, or String.  This class is a wrapper around SelectRowsCommand that provides an
    interface that can be used from SAS.
 */
public class SASSelectRowsCommand extends SASBaseSelectCommand
{
    public SASSelectRowsCommand(String schema, String query)
    {
        super(new SelectRowsCommand(schema, query));
    }

    private SelectRowsCommand getCommand()
    {
        return (SelectRowsCommand)_command;
    }

    public void setViewName(String viewName)
    {
        getCommand().setViewName(viewName);
    }

    public void setColumns(String columns)
    {
        String[] array = columns.split(",");
        List list = new ArrayList(array.length);

        for (String name : array)
            list.add(name.trim());

        getCommand().setColumns(list);
    }

    @SuppressWarnings({"UnusedDeclaration"})  // Called from SAS macros
    public void addFilter(String columnName, String operator)
    {
        addFilter(columnName, operator, null);
    }

    // TODO: Convert date values for DATE_EQUALS / DATE_NOT_EQUALS.  Create addDateFilter?  What about ><, etc.?

    // Values must always come in as Strings.  If we accepted numeric values they'd all arrive as doubles (that's
    // all SAS supports) and the server chokes on int columns filtered on double values.
    public void addFilter(String columnName, String operator, String value)
    {
        Filter.Operator op = Filter.Operator.getOperator(operator);

        if (null == op)
            throw new RuntimeException("Unknown operator");

        if (op.isDataValueRequired())
        {
            if (null == value)
                throw new RuntimeException("A value is required for operator " + op.getProgrammaticName());
        }
        else
        {
            if (null != value)
                throw new RuntimeException("A value must not be specified for operator " + op.getProgrammaticName());
        }

        getCommand().addFilter(columnName, value, op);
    }

    public void setSorts(String columns)
    {
        String[] array = columns.split(",");
        List list = new ArrayList(array.length);

        for (String name : array)
        {
            String trimmed = name.trim();
            Sort sort = trimmed.startsWith("-") ? new Sort(trimmed.substring(1), Sort.Direction.DESCENDING) : new Sort(trimmed);
            list.add(sort);
        }

        getCommand().setSorts(list);
    }
}