RequestCtrl.java
6.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
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
225
/*
* 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;
import java.util.logging.Logger;
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 {
/** The text in the query to replaced by the actual table name. */
private static final String KEYWORD_TABLE_NAME = "#tablename#";
/** 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 "
+ KEYWORD_TABLE_NAME + "%s";
/** 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";
/** The names of the columns used in the SELECT keyword in the query. */
private List<String> columnNames;
/** The maximum number of rows returned by the query. */
private int nbMaxResult;
/** The parameters fields for the request. */
private Map<String, Object> parameters = new HashMap<>();
/**
* The query to send, containing {@link #KEYWORD_TABLE_NAME} which will be replaced by the
* actual name of each table.
*/
private String query;
/** Default constructor of RequestCtrl. */
public RequestCtrl() {
List<String> newColumnNames = new ArrayList<>();
newColumnNames.add("target_name");
newColumnNames.add("target_class");
columnNames = newColumnNames;
nbMaxResult = 20;
}
/**
* Constructor of RequestCtrl.
*
* @param nbMaxResult The maximum number of rows returned by the query.
* @param columnNames The names of the columns used in the SELECT keyword in the query.
*/
public RequestCtrl(int nbMaxResult, List<String> columnNames) {
this.nbMaxResult = nbMaxResult;
this.columnNames = columnNames;
}
/**
* 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.
* @throws CantSendQueryException Can not read the JSON file.
*/
public static String[] getTargetNames(String begining) throws CantSendQueryException {
Map<String, String> params = new HashMap<>();
params.put("q", "\"" + begining + "\"");
String query = Network.buildGetRequest(RESOLVER_URL, params);
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;
}
/**
* @return The names of the columns used in the SELECT keyword in the query.
*/
public List<String> getColumnNames() {
return columnNames;
}
/**
* @return The maximum number of rows returned by the query.
*/
public int getNbMaxResult() {
return nbMaxResult;
}
/**
* Get the parameters.
*
* @return A map of couple <parameter name, parameter value>.
*/
public Map<String, Object> getParameters() {
return parameters;
}
/**
* @return The query to send, with the name of the table is replaced by
* {@link #KEYWORD_TABLE_NAME}.
*/
public String getQuery() {
return query;
}
/**
* 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.
*/
public String getQuery(String tableName) {
return query.replace(KEYWORD_TABLE_NAME, tableName);
}
/**
* Remove a parameter from the query.
*
* @param paramName The name of the parameter to remove.
*/
public void removeParameter(String paramName) {
parameters.remove(paramName);
LOGGER.info("removed " + paramName);
}
/**
* Set the names of the columns used in the SELECT keyword in the query.
*
* @param columnNames The columns names.
*/
public void setColumnNames(List<String> columnNames) {
this.columnNames = columnNames;
}
/**
* Set the maximum number of rows returned by the query.
*
* @param nbRows The number of rows.
*/
public void setNbMaxResult(int nbRows) {
nbMaxResult = nbRows;
}
/**
* Set the query, containing {@link #KEYWORD_TABLE_NAME}.
*
* @param query The query.
*/
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);
}
}