org.labkey.remoteapi.query.GetQueriesResponse Maven / Gradle / Ivy

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.
The newest version!
/*
 * Copyright (c) 2008-2017 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.JSONObject;
import org.labkey.remoteapi.CommandResponse;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 * Represents the response from a GetQueriesCommand.
 */
public class GetQueriesResponse extends CommandResponse
{
    public GetQueriesResponse(String text, int statusCode, String contentType, JSONObject json)
    {
        super(text, statusCode, contentType, json);
    }

    /**
     * Returns the schema name the queries in this response belong to.
     * @return The schema name.
     */
    public String getSchemaName()
    {
        return getProperty("schemaName");
    }

    /**
     * Returns the list of available query names in the given schema.
     * @return List of query names.
     */
    public List getQueryNames()
    {
        List> queries = getProperty("queries");
        if(null == queries)
            return Collections.emptyList();

        ArrayList queryNames = new ArrayList<>();
        for(Map query : queries)
        {
            if(query.containsKey("name"))
                queryNames.add((String)query.get("name"));
        }
        
        return queryNames;
    }

    /**
     * @param queryName The query name to find.
     * @return true if the query of interest is known to be a custom LabKey SQL query, false otherwise.
     */
    public boolean isUserDefined(String queryName)
    {
        Map query = getQuery(queryName);
        return query != null && query.containsKey("isUserDefined") && ((Boolean)query.get("isUserDefined")).booleanValue();
    }

    private Map getQuery(String queryName)
    {
        List> queries = getProperty("queries");
        if(null == queries)
            return null;

        for(Map query : queries)
        {
            if(queryName.equals(query.get("name")))
            {
                return query;
            }
        }
        return null;
    }

    /**
     * Returns the list of column names available in the given query name. Note
     * that if the command was set to not include column information, this will return
     * an empty list.
     * @param queryName The query name to find.
     * @return The list of columns available within that query, or an empty list if not found.
     */
    @SuppressWarnings("unchecked")
    public List getColumnNames(String queryName)
    {
        if(null == queryName)
            throw new IllegalArgumentException("queryName parameter was null!");

        Map query = getQuery(queryName);
        if (query != null && query.containsKey("columns"))
        {
            List colNames = new ArrayList<>();
            List> cols = (List>)query.get("columns");
            if(null != cols)
            {
                for(Map col : cols)
                    colNames.add((String)col.get("name"));
            }

            return colNames;
        }
        return Collections.emptyList();
    }
}