Blame view

src/main/java/eu/omp/irap/vespa/epntapclient/RequestCtrl.java 6.98 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;
285505be   Nathanael Jourdane   Remove complex co...
23
import java.util.logging.Logger;
70b98e7e   Nathanael Jourdane   Add listeners.
24
25
26
27
28
29
30
31
32
33
34
35
36

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 {

285505be   Nathanael Jourdane   Remove complex co...
37
	/** The text in the query to replaced by the actual table name. */
987f00a7   Nathanael Jourdane   Use ServicesList ...
38
	private static final String KEYWORD_TABLE_NAME = "#tablename#";
285505be   Nathanael Jourdane   Remove complex co...
39
40
41
42
43
44

	/** The logger for the class RequestCtrl. */
	private static final Logger LOGGER = Logger.getLogger(RequestCtrl.class.getName());

	/** The query template to get granules. */
	private static final String QUERY_TEMPLATE = "SELECT DISTINCT TOP %s %s FROM "
987f00a7   Nathanael Jourdane   Use ServicesList ...
45
			+ KEYWORD_TABLE_NAME + "%s";
285505be   Nathanael Jourdane   Remove complex co...
46

70b98e7e   Nathanael Jourdane   Add listeners.
47
48
49
	/** 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";

285505be   Nathanael Jourdane   Remove complex co...
50
	/** The names of the columns used in the SELECT keyword in the query. */
3288883d   Nathanael Jourdane   Get the actual qu...
51
	private List<String> columnNames;
419a23a7   Nathanael Jourdane   Add the possibili...
52

285505be   Nathanael Jourdane   Remove complex co...
53
	/** The maximum number of rows returned by the query. */
3288883d   Nathanael Jourdane   Get the actual qu...
54
	private int nbMaxResult;
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
55

0d36b4b0   Nathanael Jourdane   Use RequestPanelC...
56
	/** The parameters fields for the request. */
3288883d   Nathanael Jourdane   Get the actual qu...
57
	private Map<String, Object> parameters = new HashMap<>();
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
58

285505be   Nathanael Jourdane   Remove complex co...
59
	/**
c60d0aec   Nathanael Jourdane   Add Javadoc.
60
61
	 * The query to send, containing {@link #KEYWORD_TABLE_NAME} which will be replaced by the
	 * actual name of each table.
285505be   Nathanael Jourdane   Remove complex co...
62
	 */
3288883d   Nathanael Jourdane   Get the actual qu...
63
	private String query;
70b98e7e   Nathanael Jourdane   Add listeners.
64

70b98e7e   Nathanael Jourdane   Add listeners.
65

285505be   Nathanael Jourdane   Remove complex co...
66
	/** Default constructor of RequestCtrl. */
70b98e7e   Nathanael Jourdane   Add listeners.
67
	public RequestCtrl() {
285505be   Nathanael Jourdane   Remove complex co...
68
69
70
71
		List<String> newColumnNames = new ArrayList<>();
		newColumnNames.add("target_name");
		newColumnNames.add("target_class");
		columnNames = newColumnNames;
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
72
		nbMaxResult = 20;
70b98e7e   Nathanael Jourdane   Add listeners.
73
74
75
	}

	/**
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
76
77
78
	 * Constructor of RequestCtrl.
	 *
	 * @param nbMaxResult The maximum number of rows returned by the query.
c60d0aec   Nathanael Jourdane   Add Javadoc.
79
	 * @param columnNames The names of the columns used in the SELECT keyword in the query.
70b98e7e   Nathanael Jourdane   Add listeners.
80
	 */
285505be   Nathanael Jourdane   Remove complex co...
81
	public RequestCtrl(int nbMaxResult, List<String> columnNames) {
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
82
		this.nbMaxResult = nbMaxResult;
285505be   Nathanael Jourdane   Remove complex co...
83
		this.columnNames = columnNames;
70b98e7e   Nathanael Jourdane   Add listeners.
84
85
86
87
88
89
90
	}

	/**
	 * 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...
91
	 * @throws CantSendQueryException Can not read the JSON file.
70b98e7e   Nathanael Jourdane   Add listeners.
92
93
94
95
96
	 */
	public static String[] getTargetNames(String begining) throws CantSendQueryException {
		Map<String, String> params = new HashMap<>();
		params.put("q", "\"" + begining + "\"");

6b128e20   Nathanael Jourdane   Add lasts Javadoc...
97
		String query = Network.buildGetRequest(RESOLVER_URL, params);
70b98e7e   Nathanael Jourdane   Add listeners.
98
99
100
101
102
103
104
105
106
107
108
		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;
	}

c60d0aec   Nathanael Jourdane   Add Javadoc.
109
110
111
	/**
	 * @return The names of the columns used in the SELECT keyword in the query.
	 */
285505be   Nathanael Jourdane   Remove complex co...
112
113
	public List<String> getColumnNames() {
		return columnNames;
70b98e7e   Nathanael Jourdane   Add listeners.
114
115
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
116
	/**
285505be   Nathanael Jourdane   Remove complex co...
117
	 * @return The maximum number of rows returned by the query.
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
118
	 */
285505be   Nathanael Jourdane   Remove complex co...
119
120
	public int getNbMaxResult() {
		return nbMaxResult;
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
121
122
123
124
	}

	/**
	 * Get the parameters.
419a23a7   Nathanael Jourdane   Add the possibili...
125
	 *
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
126
127
128
129
130
131
	 * @return A map of couple <parameter name, parameter value>.
	 */
	public Map<String, Object> getParameters() {
		return parameters;
	}

c60d0aec   Nathanael Jourdane   Add Javadoc.
132
133
134
135
	/**
	 * @return The query to send, with the name of the table is replaced by
	 *         {@link #KEYWORD_TABLE_NAME}.
	 */
3288883d   Nathanael Jourdane   Get the actual qu...
136
137
138
139
	public String getQuery() {
		return query;
	}

c60d0aec   Nathanael Jourdane   Add Javadoc.
140
141
142
143
144
145
	/**
	 * Get the query and replace the {@link #KEYWORD_TABLE_NAME} by the specified tableName.
	 *
	 * @param tableName The name of the table, to put in the FROM ADQL keyword.
	 * @return The ADQL query, containing the specified table name.
	 */
285505be   Nathanael Jourdane   Remove complex co...
146
	public String getQuery(String tableName) {
987f00a7   Nathanael Jourdane   Use ServicesList ...
147
		return query.replace(KEYWORD_TABLE_NAME, tableName);
285505be   Nathanael Jourdane   Remove complex co...
148
149
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
150
	/**
285505be   Nathanael Jourdane   Remove complex co...
151
152
153
	 * Remove a parameter from the query.
	 *
	 * @param paramName The name of the parameter to remove.
fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
154
	 */
285505be   Nathanael Jourdane   Remove complex co...
155
156
157
158
159
	public void removeParameter(String paramName) {
		parameters.remove(paramName);
		LOGGER.info("removed " + paramName);
	}

c60d0aec   Nathanael Jourdane   Add Javadoc.
160
161
162
163
164
	/**
	 * Set the names of the columns used in the SELECT keyword in the query.
	 *
	 * @param columnNames The columns names.
	 */
285505be   Nathanael Jourdane   Remove complex co...
165
166
	public void setColumnNames(List<String> columnNames) {
		this.columnNames = columnNames;
70b98e7e   Nathanael Jourdane   Add listeners.
167
168
	}

fd93317f   Nathanael Jourdane   Solve Sonar/Eclip...
169
170
171
172
173
174
175
	/**
	 * 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.
176
177
	}

c60d0aec   Nathanael Jourdane   Add Javadoc.
178
179
180
181
182
	/**
	 * Set the query, containing {@link #KEYWORD_TABLE_NAME}.
	 * 
	 * @param query The query.
	 */
285505be   Nathanael Jourdane   Remove complex co...
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
	public void setQuery(String query) {
		this.query = query;
	}

	/**
	 * 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.
	 */
	public void updateParameter(String paramName, Object paramValue) {
		parameters.put(paramName, paramValue);
		LOGGER.info("updated " + paramName + ": " + paramValue);

	}

	/**
	 * Update the ADQL query, from the column names, the table name, the parameter values and the
	 * max results.
	 */
	public void updateQuery() {
		StringJoiner addJoin = new StringJoiner(" AND ");
		for (Map.Entry<String, Object> param : parameters.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;
		query = String.format(QUERY_TEMPLATE, nbMaxResult, StringJoiner.join(columnNames), where);

	}

70b98e7e   Nathanael Jourdane   Add listeners.
225
}