Queries.java 4.59 KB
/*
 * This file is a part of EpnTAPClient.
 * This program aims to provide EPN-TAP support for software clients, like CASSIS spectrum analyzer.
 * See draft specifications: https://voparis-confluence.obspm.fr/pages/viewpage.action?pageId=559861
 * Copyright (C) 2016 Institut de Recherche en Astrophysique et Planétologie.
 *
 * This program is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at your option) any later
 * version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details. You should have received a copy of
 * the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */

package eu.omp.irap.vespa.epntapclient.service;

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

import eu.omp.irap.vespa.votable.utils.StringJoiner;

/**
 * Defines the queries and the query patterns usually used in the application.
 *
 * @author N. Jourdane
 */
public final class Queries {
	
	public static  String RETURN_PARAMETERS = "target_name, target_class";

	private static final String SELECT = "SELECT DISTINCT short_name, res_title, "
			+ "table_name, schema_name, ivoid, access_url ";

	private static final String FROM = "FROM rr.resource "
			+ "NATURAL JOIN rr.res_schema "
			+ "NATURAL JOIN rr.res_table "
			+ "NATURAL JOIN rr.interface "
			+ "NATURAL JOIN rr.res_detail "
			+ "NATURAL JOIN rr.capability ";

	private static final String ORDER_BY = "ORDER BY short_name, table_name";

	private static final String WHERE_TAP = "WHERE "
			+ "standard_id='ivo://ivoa.net/std/tap' AND "
			+ "intf_type='vs:paramhttp' AND "
			+ "detail_xpath='/capability/dataModel/@ivo-id' ";

	//@noformat

	/** Query to get all TAP services. */
	public static final String SELECT_ALL_TAP_SERVICES =
			Queries.SELECT + Queries.FROM + Queries.WHERE_TAP + Queries.ORDER_BY;

	/** Query to get TAP services which implement the specified core. */
	public static final String SELECT_ALL_TAP_SERVICES_WHERE_CORE =
			Queries.SELECT + Queries.FROM + Queries.WHERE_TAP
			+ "AND 1=ivo_nocasematch(detail_value, 'ivo://vopdc.obspm/std/%s%%') "
			+ Queries.ORDER_BY;

	/** Query to get the TAP service with the specified ivoid. */
	public static final String SELECT_ALL_TAP_SERVICES_WHERE_IVOID =
			Queries.SELECT + Queries.FROM + Queries.WHERE_TAP
			+ "AND ivoid = '%s'";

	public static final String SELECT_TAP_SERVICES_WHERE_IVOID =
			"SELECT DISTINCT %s " + Queries.FROM + Queries.WHERE_TAP
			+ "AND ivoid = '%s'";

	public static final String SELECT_TAP_SERVICES =
			"SELECT DISTINCT %s " + Queries.FROM + Queries.WHERE_TAP;

	public static final String SELECT_TAP_SERVICES_WHERE_SUBJECT =
			"SELECT DISTINCT %s " + Queries.FROM + "NATURAL JOIN rr.res_subject "
			+ Queries.WHERE_TAP + "AND (%s)";

	public static final String SELECT_FROM =
			"SELECT DISTINCT %s FROM %s";

	public static final String SELECT_ALL =
			"SELECT DISTINCT * FROM %s";
	//@format


	/** Constructor to hide the implicit public one. */
	private Queries() {
	}

	/**
	 * The default query, with these parameters, respectively: max_rows, target_name, time_min,
	 * time_max, dataproduct_type, spectral_range_min, spectral_range_max.
	 *
	 * @param nbRow The maximum number of rows returned.
	 * @param tableName The name of the target table for the query.
	 * @param params A map of parameters, for the `WHERE` keywords.
	 * @return The literal string of the query.
	 */
	public static String getQuery(String tableName, Map<String, Object> params, int nbRow) {
		StringJoiner addJoin = new StringJoiner(" AND ");
		for (Map.Entry<String, Object> param : params.entrySet()) {
			if (param.getValue() instanceof ArrayList) {
				StringJoiner orJoin = new StringJoiner(" OR ");
				@SuppressWarnings("unchecked")
				List<String> possibleValues = (List<String>) param.getValue();
				for (String possibleValue : possibleValues) {
					orJoin.add(param.getKey() + " LIKE '" + possibleValue + "'");
				}
				addJoin.add("(" + orJoin + ")");
			} else if (param.getValue() instanceof String) {
				addJoin.add(param.getKey() + " LIKE '" + param.getValue() + "'");
			} else {
				addJoin.add(param.getKey() + " = " + param.getValue().toString());
			}
		}
		String where = addJoin.isEmpty() ? "" : " WHERE " + addJoin;
		
		return "SELECT TOP " + nbRow + " "
				+ RETURN_PARAMETERS
				+ " "
				+ "FROM " + tableName + where;
	}

}