Blame view

src/main/java/eu/omp/irap/vespa/epntapclient/RequestCtrl.java 5.19 KB
70b98e7e   Nathanael Jourdane   Add listeners.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
 * 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;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
70b98e7e   Nathanael Jourdane   Add listeners.
23
24
25
26
27
28
29
30
31
32
33
34
35

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;

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

/**
 * @author N. Jourdane
 */
public class RequestCtrl {

70b98e7e   Nathanael Jourdane   Add listeners.
36
37
38
	/** The URL of the resolver used for the `target name` field. */
	private static final String RESOLVER_URL = "http://voparis-registry.obspm.fr/ssodnet/1/autocomplete";

419a23a7   Nathanael Jourdane   Add the possibili...
39
40
41
	/** The text in the query to replaced by the actual table name. */
	protected static final String TABLE_NAME_KEYWORD = "#tablename#";

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
42
	/** The query template to get granules. */
419a23a7   Nathanael Jourdane   Add the possibili...
43
44
	private static final String QUERY = "SELECT DISTINCT TOP %s %s FROM " + TABLE_NAME_KEYWORD
			+ "%s";
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
45

0d36b4b0   Nathanael Jourdane   Use RequestPanelC...
46
	/** The parameters fields for the request. */
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
47
48
49
50
	protected Map<String, Object> parameters = new HashMap<>();

	/** The maximum number of rows returned by the query. */
	private int nbMaxResult;
70b98e7e   Nathanael Jourdane   Add listeners.
51

70b98e7e   Nathanael Jourdane   Add listeners.
52

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
53
	/** Constructor of RequestCtrl. */
70b98e7e   Nathanael Jourdane   Add listeners.
54
	public RequestCtrl() {
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
55
		nbMaxResult = 20;
70b98e7e   Nathanael Jourdane   Add listeners.
56
57
58
	}

	/**
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
59
60
61
	 * Constructor of RequestCtrl.
	 *
	 * @param nbMaxResult The maximum number of rows returned by the query.
70b98e7e   Nathanael Jourdane   Add listeners.
62
	 */
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
63
64
65
66
67
68
69
	public RequestCtrl(int nbMaxResult) {
		this.nbMaxResult = nbMaxResult;
	}

	/**
	 * Build an ADQL from the table name, the parameter values and the max results.
	 *
419a23a7   Nathanael Jourdane   Add the possibili...
70
	 * @param tableName The names of the tables, to put in the FROM keyword.
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
71
72
	 * @return The query.
	 */
419a23a7   Nathanael Jourdane   Add the possibili...
73
	public String buildQuery(List<String> columnNames) {
70b98e7e   Nathanael Jourdane   Add listeners.
74
		StringJoiner addJoin = new StringJoiner(" AND ");
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
75
		for (Map.Entry<String, Object> param : parameters.entrySet()) {
70b98e7e   Nathanael Jourdane   Add listeners.
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
			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;
419a23a7   Nathanael Jourdane   Add the possibili...
91
		return String.format(QUERY, nbMaxResult, StringJoiner.join(columnNames), where);
70b98e7e   Nathanael Jourdane   Add listeners.
92
93
94
95
96
97
98
	}

	/**
	 * The method used to get target names propositions by asking to the resolver.
	 *
	 * @param begining The beginning of the target_name.
	 * @return An array of Strings corresponding to the target names got.
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
99
	 * @throws CantSendQueryException Can not read the JSON file.
70b98e7e   Nathanael Jourdane   Add listeners.
100
101
102
103
104
	 */
	public static String[] getTargetNames(String begining) throws CantSendQueryException {
		Map<String, String> params = new HashMap<>();
		params.put("q", "\"" + begining + "\"");

6b128e20   Nathanael Jourdane   Add lasts Javadoc...
105
		String query = Network.buildGetRequest(RESOLVER_URL, params);
70b98e7e   Nathanael Jourdane   Add listeners.
106
107
108
109
110
111
112
113
114
115
116
		JsonObject root = Network.readJson(query);
		int count = Integer.parseInt(root.get("count").toString());
		String[] targetNames = new String[count];
		JsonArray hits = root.getAsJsonArray("hits");
		for (int i = 0; i < count; i++) {
			JsonObject elmt = hits.get(i).getAsJsonObject();
			targetNames[i] = elmt.get("name").toString().replace("\"", "");
		}
		return targetNames;
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
117
118
119
120
121
122
	/**
	 * Update a parameter in the query. If the parameter do not exists yet, create it.
	 *
	 * @param paramName The name of the parameter.
	 * @param paramValue The value of the parameter.
	 */
70b98e7e   Nathanael Jourdane   Add listeners.
123
	public void updateParameter(String paramName, Object paramValue) {
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
124
		parameters.put(paramName, paramValue);
70b98e7e   Nathanael Jourdane   Add listeners.
125
126
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
127
128
129
130
131
	/**
	 * Remove a parameter from the query.
	 *
	 * @param paramName The name of the parameter to remove.
	 */
70b98e7e   Nathanael Jourdane   Add listeners.
132
	public void removeParameter(String paramName) {
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
133
134
135
136
137
		parameters.remove(paramName);
	}

	/**
	 * Get the parameters.
419a23a7   Nathanael Jourdane   Add the possibili...
138
	 *
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
139
140
141
142
143
144
145
146
147
148
149
	 * @return A map of couple <parameter name, parameter value>.
	 */
	public Map<String, Object> getParameters() {
		return parameters;
	}

	/**
	 * @return The maximum number of rows returned by the query.
	 */
	public int getNbMaxResult() {
		return nbMaxResult;
70b98e7e   Nathanael Jourdane   Add listeners.
150
151
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
152
153
154
155
156
157
158
	/**
	 * Set the maximum number of rows returned by the query.
	 *
	 * @param nbRows The number of rows.
	 */
	public void setNbMaxResult(int nbRows) {
		nbMaxResult = nbRows;
70b98e7e   Nathanael Jourdane   Add listeners.
159
160
161
	}

}