ParamField.java
13.7 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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/*
* 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.view;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.BoxLayout;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import eu.omp.irap.vespa.epntapclient.votable.controller.VOTableConnection;
import eu.omp.irap.vespa.epntapclient.votable.controller.VOTableException.SendQueryException;
/**
* A field used to set a service parameter to build the query (in the parameter panel).
*
* @author N. Jourdane
*/
public abstract class ParamField extends JPanel {
/** */
private static final long serialVersionUID = 6025994164004985362L;
/** The logger for the class ParamField. */
static final Logger logger = Logger.getLogger(ParamField.class.getName());
/** The minimum width of the field. */
private static final int MIN_FIELD_WIDTH = 30;
/** The preferred field height. */
private static final int FIELD_HEIGHT = 20;
/** The maximum width of the field. */
private static final int MAX_FIELD_WIDTH = 400;
/** The preferred label width. */
private static final int LABEL_WIDTH = 140;
/** 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 date format used in the DateRange field */
private static final String DATE_FORMAT = "dd/MM/yyyy";
/** The regex used to validate the Date fields */
private static final String DATE_REGEX = "(^(((0[1-9]|1[0-9]|2[0-8])[\\/](0[1-9]|1[012]))|((29|30|31)[\\/](0[13578]|1[02]))|((29|30)[\\/](0[4,6,9]|11)))[\\/](19|[2-9][0-9])\\d\\d$)|(^29[\\/]02[\\/](19|[2-9][0-9])(00|04|08|12|16|20|24|28|32|36|40|44|48|52|56|60|64|68|72|76|80|84|88|92|96)$)";
/** The suffix used in REG-TAP parameters names, indicating that it's a beginning of a range. */
private static final String MIN_SUFFIX = "min";
/** The suffix used in REG-TAP parameters names, indicating that it is a end of a range. */
private static final String MAX_SUFFIX = "max";
/** The main view of the application. */
protected EpnTapMainView mainView;
/** The parameter name of the field */
protected String paramName;
public ParamField(EpnTapMainView mainView, String paramName) {
super();
this.mainView = mainView;
this.paramName = paramName;
this.setLayout(new BoxLayout(this, BoxLayout.X_AXIS));
this.setMaximumSize(new Dimension(MAX_FIELD_WIDTH, FIELD_HEIGHT));
String strLabel = paramName.replaceAll("_", " ").trim();
JLabel label = new JLabel(strLabel.substring(0, 1).toUpperCase() + strLabel.substring(1));
label.setPreferredSize(new Dimension(LABEL_WIDTH, FIELD_HEIGHT));
this.add(label);
// TODO: Add tooltip text based on rr.table_column.column_description
}
public static class StringField extends ParamField implements TextFieldListener {
/** */
private static final long serialVersionUID = 24219488975302068L;
JTextField field;
public StringField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
field = new JTextField();
addChangeListener(this, field);
this.add(field);
}
@Override
public void update(JTextField textField) {
if ("".equals(textField.getText())) {
mainView.event(Event.paramChanged, paramName, null);
} else {
mainView.event(Event.paramChanged, paramName, textField.getText());
}
}
}
public static class FloatField extends ParamField implements TextFieldListener {
/** */
private static final long serialVersionUID = -1880193152285564590L;
JTextField field;
public FloatField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
field = new JTextField();
addChangeListener(this, field);
this.add(field);
}
@Override
public void update(JTextField textField) {
if ("".equals(textField.getText())) {
textField.setBackground(Color.WHITE);
mainView.event(Event.paramRemoved, paramName);
} else {
try {
float value = Float.parseFloat(textField.getText());
mainView.event(Event.paramChanged, paramName, value);
textField.setBackground(Color.WHITE);
} catch (@SuppressWarnings("unused") NumberFormatException e) {
textField.setBackground(Color.PINK);
}
}
}
}
public static class DateRangeField extends ParamField implements TextFieldListener {
/** */
private static final long serialVersionUID = -7781309003911514777L;
JTextField fieldMin;
JTextField fieldMax;
public DateRangeField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
this.add(new JLabel("min "));
fieldMin = new JTextField();
fieldMin.setName(MIN_SUFFIX);
fieldMin.setPreferredSize(new Dimension(MIN_FIELD_WIDTH, FIELD_HEIGHT));
addChangeListener(this, fieldMin);
this.add(fieldMin);
this.add(new JLabel("max "));
fieldMax = new JTextField();
fieldMax.setName(MAX_SUFFIX);
fieldMax.setPreferredSize(new Dimension(MIN_FIELD_WIDTH, FIELD_HEIGHT));
addChangeListener(this, fieldMin);
this.add(fieldMax);
}
@Override
public void update(JTextField field) {
DateFormat df = new SimpleDateFormat(DATE_FORMAT, Locale.ENGLISH);
if ("".equals(field.getText())) {
field.setBackground(Color.WHITE);
mainView.event(Event.paramRemoved, paramName + field.getName());
} else if (field.getText().matches(DATE_REGEX)) {
try {
long date = df.parse(field.getText()).getTime();
date = Math.round((date / 86400000.0) + 2440587.5); // to JD
mainView.event(Event.paramChanged, paramName + field.getName(), date);
field.setBackground(Color.WHITE);
} catch (@SuppressWarnings("unused") ParseException e) {
field.setBackground(Color.PINK);
}
// TODO: check if date min < date max
} else {
field.setBackground(Color.PINK);
}
}
}
public static class FloatRangeField extends ParamField implements TextFieldListener {
/** */
private static final long serialVersionUID = 7923358142882329015L;
JTextField fieldMin;
JTextField fieldMax;
public FloatRangeField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
fieldMin = new JTextField();
fieldMin.setName(MIN_SUFFIX);
addChangeListener(this, fieldMin);
this.add(fieldMin);
fieldMax = new JTextField();
fieldMax.setName(MAX_SUFFIX);
addChangeListener(this, fieldMax);
this.add(fieldMax);
}
@Override
public void update(JTextField field) {
if ("".equals(field.getText())) {
field.setBackground(Color.WHITE);
mainView.event(Event.paramRemoved, paramName + field.getName());
} else {
try {
mainView.event(Event.paramChanged, paramName + field.getName(),
Float.parseFloat(field.getText()));
field.setBackground(Color.WHITE);
} catch (@SuppressWarnings("unused") NumberFormatException e) {
field.setBackground(Color.PINK);
}
}
}
}
public static class TargetNameField extends ParamField implements TextFieldListener {
/** */
private static final long serialVersionUID = 5136431108894677113L;
JComboBox<String> comboBox;
JTextField field;
String lastContent;
public TargetNameField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
comboBox = new JComboBox<>();
comboBox.setPreferredSize(new Dimension(MIN_FIELD_WIDTH, FIELD_HEIGHT));
comboBox.setEditable(true);
field = (JTextField) comboBox.getEditor().getEditorComponent();
addChangeListener(this, field);
this.add(comboBox);
}
static String[] getItems(String begining) throws SendQueryException {
StringBuilder resolverResult = null;
resolverResult = VOTableConnection.sendGet(RESOLVER_URL, "q=\"" + begining + "\"");
JsonObject root = new JsonParser().parse(resolverResult.toString()).getAsJsonObject();
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("\"", "");
// TODO: Display "[name] ([type])" on the JComboBox, but only "[name]" on the query.
}
return targetNames;
}
Runnable updateComboBox = new Runnable() {
@Override
public void run() {
String content = field.getText();
if (!content.equals(lastContent)) {
if (content.length() >= 2) {
lastContent = content;
comboBox.removeAllItems();
try {
for (String s : getItems(content)) {
comboBox.addItem(s);
}
} catch (SendQueryException e) {
logger.log(Level.WARNING, "Can't get table names for the resolver", e);
}
comboBox.getEditor().setItem(content);
}
if ("".equals(content)) {
mainView.event(Event.paramRemoved, paramName);
} else {
mainView.event(Event.paramChanged, paramName, content);
}
}
}
};
@Override
public void update(JTextField textField) {
SwingUtilities.invokeLater(updateComboBox);
}
}
public static class DataProductTypeField extends ParamField {
/** */
private static final long serialVersionUID = -6362359909898369750L;
JComboBox<DataProductType> comboBox;
enum DataProductType {
// @noformat
ALL("All", "all"),
IM("Image", "im"),
SP("Spectrum", "sp"),
DS("Dynamic spectrum", "ds"),
SC("Spectral cube", "sc"),
PR("Profile", "pr"),
VO("Volume", "vo"),
MO("Movie", "mo"),
CU("Cube", "cu"),
TS("Time series", "ts"),
CA("Catalog", "ca"),
SV("Spatial vector", "sv");
// @format
private String name = "";
private String id = "";
DataProductType(String name, String editor) {
this.name = name;
this.id = editor;
}
public List<String> query() {
List<String> item = new ArrayList<>();
item.add(name.replace(" ", "-").toLowerCase());
item.add(id);
return item;
}
@Override
public String toString() {
return name;
}
}
public DataProductTypeField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
comboBox = new JComboBox<>(DataProductType.values());
comboBox.setSelectedItem(DataProductType.ALL);
comboBox.setPreferredSize(new Dimension(MIN_FIELD_WIDTH, FIELD_HEIGHT));
comboBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
onUpdate();
}
});
this.add(comboBox);
}
void onUpdate() {
DataProductType item = (DataProductType) comboBox.getSelectedItem();
if (DataProductType.ALL.equals(item)) {
mainView.event(Event.paramRemoved, paramName);
} else {
mainView.event(Event.paramChanged, paramName, item.query());
}
}
}
public static class TargetClassField extends ParamField {
/** */
private static final long serialVersionUID = 6439475087727685080L;
JComboBox<TargetClass> comboBox;
enum TargetClass {
// @noformat
ALL("All"),
COMET("Comet"),
EXOPLANET("Exoplanet"),
INTERPLANETARY_MEDIUM("Interplanetary medium"),
RING("Ring"), SAMPLE("Sample"),
SKY("Sky"),
SPACECRAFT("Spacecraft"),
SPACEJUNK("Spacejunk"),
STAR("Star");
// @format
String name;
TargetClass(String name) {
this.name = name;
}
String query() {
return name.replace(" ", "_").toLowerCase();
}
}
public TargetClassField(EpnTapMainView mainView, String paramName) {
super(mainView, paramName);
comboBox = new JComboBox<>(TargetClass.values());
comboBox.setPreferredSize(new Dimension(MIN_FIELD_WIDTH, FIELD_HEIGHT));
comboBox.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
onUpdate();
}
});
this.add(comboBox);
}
void onUpdate() {
TargetClass value = (TargetClass) comboBox.getSelectedItem();
if (TargetClass.ALL.equals(value)) {
mainView.event(Event.paramRemoved, paramName);
} else {
mainView.event(Event.paramChanged, paramName, value.query());
}
}
}
interface TextFieldListener {
void update(JTextField field);
}
static void addChangeListener(final TextFieldListener changeListener, final JTextField field) {
field.getDocument().addDocumentListener(new DocumentListener() {
@Override
public void removeUpdate(DocumentEvent de) {
changeListener.update(field);
}
@Override
public void insertUpdate(DocumentEvent de) {
changeListener.update(field);
}
@Override
public void changedUpdate(DocumentEvent de) {
changeListener.update(field);
}
});
}
}