/
ADAMproSelector.java
602 lines (495 loc) · 20.6 KB
/
ADAMproSelector.java
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
package org.vitrivr.cineast.core.db;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.vitrivr.adampro.grpc.AdamGrpc;
import org.vitrivr.adampro.grpc.AdamGrpc.AckMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.AckMessage.Code;
import org.vitrivr.adampro.grpc.AdamGrpc.BooleanQueryMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.BooleanQueryMessage.WhereMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.DataMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.DenseVectorMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.DistanceMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.DistanceMessage.DistanceType;
import org.vitrivr.adampro.grpc.AdamGrpc.EntityPropertiesMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.ExistsMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.ExternalHandlerQueryMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.FeatureVectorMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.FromMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.NearestNeighbourQueryMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.PreviewMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.ProjectionMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.PropertiesMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.QueryMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.QueryResultInfoMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.QueryResultTupleMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.QueryResultsMessage;
import org.vitrivr.adampro.grpc.AdamGrpc.SubExpressionQueryMessage;
import org.vitrivr.cineast.core.config.QueryConfig;
import org.vitrivr.cineast.core.config.QueryConfig.Distance;
import org.vitrivr.cineast.core.data.StringDoublePair;
import org.vitrivr.cineast.core.data.providers.primitive.PrimitiveTypeProvider;
import org.vitrivr.cineast.core.util.LogHelper;
import com.google.common.util.concurrent.ListenableFuture;
public class ADAMproSelector implements DBSelector {
/**
* flag to choose if every selector should have its own connection to ADAMpro or if they should
* share one
*/
private static boolean useGlobalWrapper = true;
private static final ADAMproWrapper GLOBAL_ADAMPRO_WRAPPER = useGlobalWrapper
? new ADAMproWrapper() : null;
private ADAMproWrapper adampro = useGlobalWrapper ? GLOBAL_ADAMPRO_WRAPPER : new ADAMproWrapper();
private FromMessage.Builder fromBuilder = FromMessage.newBuilder();
private final QueryMessage.Builder qmBuilder = QueryMessage.newBuilder();
private final NearestNeighbourQueryMessage.Builder nnqmBuilder = NearestNeighbourQueryMessage
.newBuilder();
private final BooleanQueryMessage.Builder bqmBuilder = BooleanQueryMessage.newBuilder();
private final WhereMessage.Builder wmBuilder = WhereMessage.newBuilder();
private final DistanceMessage.Builder dmBuilder = DistanceMessage.newBuilder();
private static final Logger LOGGER = LogManager.getLogger();
private static ArrayList<String> hints = new ArrayList<>(1);
private static ProjectionMessage projectionMessage;
private String entityName;
private static final DistanceMessage chisquared, correlation, cosine, hamming, jaccard,
kullbackleibler, chebyshev, euclidean, squaredeuclidean, manhattan, spannorm;
static {
hints.add("exact");
projectionMessage = AdamGrpc.ProjectionMessage.newBuilder()
.setAttributes(AdamGrpc.ProjectionMessage.AttributeNameMessage.newBuilder()
.addAttribute("ap_distance").addAttribute("id"))
.build();
DistanceMessage.Builder dmBuilder = DistanceMessage.newBuilder();
chisquared = dmBuilder.clear().setDistancetype(DistanceType.chisquared).build();
correlation = dmBuilder.clear().setDistancetype(DistanceType.correlation).build();
cosine = dmBuilder.clear().setDistancetype(DistanceType.cosine).build();
hamming = dmBuilder.clear().setDistancetype(DistanceType.hamming).build();
jaccard = dmBuilder.clear().setDistancetype(DistanceType.jaccard).build();
kullbackleibler = dmBuilder.clear().setDistancetype(DistanceType.kullbackleibler).build();
chebyshev = dmBuilder.clear().setDistancetype(DistanceType.chebyshev).build();
euclidean = dmBuilder.clear().setDistancetype(DistanceType.euclidean).build();
squaredeuclidean = dmBuilder.clear().setDistancetype(DistanceType.squaredeuclidean).build();
manhattan = dmBuilder.clear().setDistancetype(DistanceType.manhattan).build();
spannorm = dmBuilder.clear().setDistancetype(DistanceType.spannorm).build();
}
@Override
public boolean open(String name) {
this.fromBuilder.setEntity(name);
this.entityName = name;
return true;
}
@Override
public boolean close() {
if (useGlobalWrapper) {
return false;
}
this.adampro.close();
return true;
}
private QueryMessage buildQueryMessage(ArrayList<String> hints, FromMessage.Builder fb,
BooleanQueryMessage bqMessage, ProjectionMessage pMessage,
NearestNeighbourQueryMessage nnqMessage) {
synchronized (qmBuilder) {
qmBuilder.clear();
qmBuilder.setFrom(fb);
if (hints != null && !hints.isEmpty()) {
qmBuilder.addAllHints(hints);
}
if (bqMessage != null) {
qmBuilder.setBq(bqMessage);
}
if (pMessage != null) {
qmBuilder.setProjection(pMessage);
}
if (nnqMessage != null) {
qmBuilder.setNnq(nnqMessage);
}
return qmBuilder.build();
}
}
private QueryMessage buildQueryMessage(ArrayList<String> hints, BooleanQueryMessage bqMessage,
ProjectionMessage pMessage, NearestNeighbourQueryMessage nnqMessage) {
return buildQueryMessage(hints, fromBuilder, bqMessage, pMessage, nnqMessage);
}
private BooleanQueryMessage buildBooleanQueryMessage(WhereMessage where,
WhereMessage... whereMessages) {
ArrayList<WhereMessage> tmp = new ArrayList<>(
1 + (whereMessages == null ? 0 : whereMessages.length));
tmp.add(where);
if (whereMessages != null) {
Collections.addAll(tmp, whereMessages);
}
synchronized (bqmBuilder) {
bqmBuilder.clear();
return bqmBuilder.addAllWhere(tmp).build();
}
}
private WhereMessage buildWhereMessage(String key, String value) {
synchronized (wmBuilder) {
wmBuilder.clear();
return wmBuilder.setAttribute(key).addValues(DataMessage.newBuilder().setStringData(value))
.build();
}
}
private WhereMessage buildWhereMessage(String key, String... values) {
synchronized (wmBuilder) {
wmBuilder.clear();
DataMessage.Builder damBuilder = DataMessage.newBuilder();
wmBuilder.setAttribute(key);
for (String value : values) {
wmBuilder.addValues(damBuilder.setStringData(value).build());
}
return wmBuilder.build();
}
}
private WhereMessage buildWhereMessage(String key, Iterable<String> values) {
synchronized (wmBuilder) {
wmBuilder.clear();
DataMessage.Builder damBuilder = DataMessage.newBuilder();
wmBuilder.setAttribute(key);
for (String value : values) {
wmBuilder.addValues(damBuilder.setStringData(value).build());
}
return wmBuilder.build();
}
}
private NearestNeighbourQueryMessage buildNearestNeighbourQueryMessage(String column,
FeatureVectorMessage fvm, int k, QueryConfig qc) {
synchronized (nnqmBuilder) {
this.nnqmBuilder.clear();
nnqmBuilder.setAttribute(column).setQuery(fvm).setK(k);
nnqmBuilder.setDistance(buildDistanceMessage(qc));
if (qc != null) {
Optional<float[]> weights = qc.getDistanceWeights();
if (weights.isPresent()) {
nnqmBuilder.setWeights(DataMessageConverter.convertFeatureVectorMessage(weights.get()));
}
}
return nnqmBuilder.build();
}
}
private DistanceMessage buildDistanceMessage(QueryConfig qc) {
if (qc == null) {
return manhattan;
}
Optional<Distance> distance = qc.getDistance();
if (!distance.isPresent()) {
return manhattan;
}
switch (distance.get()) {
case chebyshev:
return chebyshev;
case chisquared:
return chisquared;
case correlation:
return correlation;
case cosine:
return cosine;
case euclidean:
return euclidean;
case hamming:
return hamming;
case jaccard:
return jaccard;
case kullbackleibler:
return kullbackleibler;
case manhattan:
return manhattan;
case minkowski: {
float norm = qc.getNorm().orElse(1f);
if (Math.abs(norm - 1f) < 1e6f) {
return manhattan;
}
if (Math.abs(norm - 2f) < 1e6f) {
return euclidean;
}
HashMap<String, String> tmp = new HashMap<>();
tmp.put("norm", Float.toString(norm));
synchronized (dmBuilder) {
return dmBuilder.clear().setDistancetype(DistanceType.minkowski).putAllOptions(tmp).build();
}
}
case spannorm:
return spannorm;
case squaredeuclidean:
return squaredeuclidean;
default:
return manhattan;
}
}
public List<float[]> getFeatureVectors(String fieldName, String value, String vectorName) {
QueryMessage qbqm = buildQueryMessage(hints,
buildBooleanQueryMessage(buildWhereMessage(fieldName, value)), null, null);
ListenableFuture<QueryResultsMessage> f = this.adampro.booleanQuery(qbqm);
ArrayList<float[]> _return = new ArrayList<>();
QueryResultsMessage r;
try {
r = f.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error(LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
if (r.getResponsesCount() == 0) {
return new ArrayList<>(0);
}
QueryResultInfoMessage response = r.getResponses(0); // only head (end-result) is important
AckMessage ack = response.getAck();
if (ack.getCode() != Code.OK) {
LOGGER.error("error in getFeatureVectors ({}) : {}", ack.getCode(), ack.getMessage());
return _return;
}
for (QueryResultTupleMessage result : response.getResultsList()) {
Map<String, DataMessage> data = result.getDataMap();
if (!data.containsKey(vectorName)) {
continue;
}
DataMessage dm = data.get(vectorName);
if (dm.getDatatypeCase() != DataMessage.DatatypeCase.FEATUREDATA) {
continue;
}
FeatureVectorMessage featureData = dm.getFeatureData();
if (featureData.getFeatureCase() != FeatureVectorMessage.FeatureCase.DENSEVECTOR) {
continue; // TODO add correct handling for sparse and int vectors
}
DenseVectorMessage dense = featureData.getDenseVector();
List<Float> list = dense.getVectorList();
if (list.isEmpty()) {
continue;
}
float[] vector = new float[list.size()];
int i = 0;
for (float x : list) {
vector[i++] = x;
}
_return.add(vector);
}
return _return;
}
@Override
public List<StringDoublePair> getNearestNeighbours(int k, float[] vector, String column,
QueryConfig config) {
NearestNeighbourQueryMessage nnqMessage = buildNearestNeighbourQueryMessage(column,
DataMessageConverter.convertFeatureVectorMessage(vector), k, config);
QueryMessage sqMessage = buildQueryMessage(hints, null, projectionMessage, nnqMessage);
ListenableFuture<QueryResultsMessage> future = this.adampro.standardQuery(sqMessage);
QueryResultsMessage result;
try {
result = future.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error(LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
AckMessage ack = result.getAck();
if (ack.getCode() != AckMessage.Code.OK) {
LOGGER.error("error in getNearestNeighbours ({}) : {}", ack.getCode(), ack.getMessage());
return new ArrayList<>(0);
}
if (result.getResponsesCount() == 0) {
return new ArrayList<>(0);
}
QueryResultInfoMessage response = result.getResponses(0); // only head (end-result) is important
ArrayList<StringDoublePair> _return = new ArrayList<>(k);
for (QueryResultTupleMessage msg : response.getResultsList()) {
String id = msg.getDataMap().get("id").getStringData();
if (id == null) {
continue;
}
_return.add(new StringDoublePair(id, msg.getDataMap().get("ap_distance").getFloatData()));
}
return _return;
}
@Override
public List<Map<String, PrimitiveTypeProvider>> getRows(String fieldName, String... values) {
if (values == null || values.length == 0) {
LOGGER.error("Cannot query empty value list in ADAMproSelector.getRows()");
return new ArrayList<>(0);
}
if (values.length == 1) {
return getRows(fieldName, values[0]);
}
WhereMessage where = buildWhereMessage(fieldName, values);
BooleanQueryMessage bqMessage = buildBooleanQueryMessage(where);
return executeBooleanQuery(bqMessage);
}
@Override
public List<Map<String, PrimitiveTypeProvider>> getRows(String fieldName,
Iterable<String> values) {
if (values == null) {
LOGGER.error("Cannot query empty value list in ADAMproSelector.getRows()");
return new ArrayList<>(0);
}
WhereMessage where = buildWhereMessage(fieldName, values);
BooleanQueryMessage bqMessage = buildBooleanQueryMessage(where);
return executeBooleanQuery(bqMessage);
}
@Override
public List<Map<String, PrimitiveTypeProvider>> getRows(String fieldName, String value) {
WhereMessage where = buildWhereMessage(fieldName, value);
BooleanQueryMessage bqMessage = buildBooleanQueryMessage(where);
return executeBooleanQuery(bqMessage);
}
/**
* SELECT label FROM ... Be careful with the size of the resulting List :)
*/
@Override
public List<PrimitiveTypeProvider> getAll(String label) {
List<Map<String, PrimitiveTypeProvider>> resultList = getAll();
return resultList.stream().map(row -> row.get(label)).collect(Collectors.toList());
}
/**
* TODO This is currently an ugly hack where we abuse the preview-function with LIMIT = COUNT()
* using the getProperties ADAMpro-method. Once ADAMpro supports SELECT * FROM $ENTITY, this
* method should be rewritten
*/
@Override
public List<Map<String, PrimitiveTypeProvider>> getAll() {
ListenableFuture<PropertiesMessage> future = this.adampro.getProperties(
EntityPropertiesMessage.newBuilder().setEntity(fromBuilder.getEntity()).build());
int count = 1_000;
PropertiesMessage propertiesMessage;
try {
propertiesMessage = future.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error("error in getAll: {}", LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
try {
count = Integer.parseInt(propertiesMessage.getPropertiesMap().get("count"));
} catch (Exception e) {
LOGGER.error("error in getAll: {}", LogHelper.getStackTrace(e));
}
return preview(count);
}
@Override
public boolean existsEntity(String eName) {
ListenableFuture<ExistsMessage> future = this.adampro.existsEntity(eName);
try {
return future.get().getExists();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error("error in existsEntity: {}", LogHelper.getStackTrace(e));
return false;
}
}
@Override
public List<Map<String, PrimitiveTypeProvider>> preview(int k) {
PreviewMessage msg = PreviewMessage.newBuilder().setEntity(this.fromBuilder.getEntity()).setN(k)
.build();
ListenableFuture<QueryResultsMessage> f = this.adampro.previewEntity(msg);
QueryResultsMessage result;
try {
result = f.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error(LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
if (result.getResponsesCount() == 0) {
return new ArrayList<>(0);
}
QueryResultInfoMessage response = result.getResponses(0); // only head (end-result) is important
List<QueryResultTupleMessage> resultList = response.getResultsList();
return resultsToMap(resultList);
}
/**
* @param resultList
* can be empty
* @return an ArrayList of length one if the resultList is empty, else the transformed
* QueryResultTupleMessage
*/
private List<Map<String, PrimitiveTypeProvider>> resultsToMap(
List<QueryResultTupleMessage> resultList) {
if (resultList.isEmpty()) {
return new ArrayList<>(0);
}
ArrayList<Map<String, PrimitiveTypeProvider>> _return = new ArrayList<>(resultList.size());
for (QueryResultTupleMessage resultMessage : resultList) {
Map<String, DataMessage> data = resultMessage.getDataMap();
Set<String> keys = data.keySet();
HashMap<String, PrimitiveTypeProvider> map = new HashMap<>();
for (String key : keys) {
map.put(key, DataMessageConverter.convert(data.get(key)));
}
_return.add(map);
}
return _return;
}
/**
* Executes a QueryMessage and returns the resulting tuples
*
* @return an empty ArrayList if an error happens. Else just the list of rows
*/
private List<Map<String, PrimitiveTypeProvider>> executeQuery(QueryMessage qm) {
ListenableFuture<QueryResultsMessage> f = this.adampro.standardQuery(qm);
QueryResultsMessage result;
try {
result = f.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error(LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
if (result.getAck().getCode() != AckMessage.Code.OK) {
LOGGER.error(result.getAck().getMessage());
}
if (result.getResponsesCount() == 0) {
return new ArrayList<>(0);
}
QueryResultInfoMessage response = result.getResponses(0); // only head (end-result) is important
List<QueryResultTupleMessage> resultList = response.getResultsList();
return resultsToMap(resultList);
}
private List<Map<String, PrimitiveTypeProvider>> executeBooleanQuery(BooleanQueryMessage bqm) {
QueryMessage qbqm = buildQueryMessage(hints, bqm, null, null);
return executeQuery(qbqm);
}
@Override
protected void finalize() throws Throwable {
this.close();
super.finalize();
}
@Override
public List<Map<String, PrimitiveTypeProvider>> getNearestNeighbourRows(int k, float[] vector,
String column, QueryConfig config) {
NearestNeighbourQueryMessage nnqMessage = buildNearestNeighbourQueryMessage(column,
DataMessageConverter.convertFeatureVectorMessage(vector), k, config);
QueryMessage sqMessage = buildQueryMessage(hints, null, null, nnqMessage);
ListenableFuture<QueryResultsMessage> future = this.adampro.standardQuery(sqMessage);
QueryResultsMessage result;
try {
result = future.get();
} catch (InterruptedException | ExecutionException e) {
LOGGER.error(LogHelper.getStackTrace(e));
return new ArrayList<>(0);
}
if (result.getResponsesCount() == 0) {
return new ArrayList<>(0);
}
QueryResultInfoMessage response = result.getResponses(0); // only head (end-result) is important
ArrayList<Map<String, PrimitiveTypeProvider>> _return = new ArrayList<>(k);
AckMessage ack = response.getAck();
if (ack.getCode() != Code.OK) {
LOGGER.error("error in getNearestNeighbourRows ({}) : {}", ack.getCode(), ack.getMessage());
return _return;
}
return resultsToMap(response.getResultsList());
}
public List<Map<String, PrimitiveTypeProvider>> getFromExternal(String externalHandlerName,
Map<String, String> parameters) {
ExternalHandlerQueryMessage.Builder ehqmBuilder = ExternalHandlerQueryMessage.newBuilder();
ehqmBuilder.setEntity(this.entityName);
ehqmBuilder.setHandler(externalHandlerName);
ehqmBuilder.putAllParams(parameters);
SubExpressionQueryMessage.Builder seqmBuilder = SubExpressionQueryMessage.newBuilder();
seqmBuilder.setEhqm(ehqmBuilder);
FromMessage.Builder fmBuilder = FromMessage.newBuilder();
fmBuilder.setExpression(seqmBuilder);
QueryMessage qm = buildQueryMessage(hints, fmBuilder, null, null, null);
return executeQuery(qm);
}
}