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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.aai.query.builder;
import org.apache.tinkerpop.gremlin.process.traversal.Path;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.onap.aai.config.SpringContextAware;
import org.onap.aai.db.props.AAIProperties;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.introspection.Introspector;
import org.onap.aai.introspection.Loader;
import org.onap.aai.introspection.exceptions.AAIUnknownObjectException;
import org.onap.aai.parsers.query.QueryParser;
import org.onap.aai.parsers.query.QueryParserStrategy;
import org.springframework.context.ApplicationContext;
import org.onap.aai.edges.EdgeIngestor;
import org.onap.aai.edges.enums.AAIDirection;
import org.onap.aai.edges.enums.EdgeProperty;
import org.onap.aai.edges.enums.EdgeType;
import javax.ws.rs.core.MultivaluedMap;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* The Class QueryBuilder.
*/
public abstract class QueryBuilder<E> implements Iterator<E> {
protected final GraphTraversalSource source;
protected QueryParserStrategy factory = null;
protected Loader loader = null;
protected EdgeIngestor edgeRules;
protected boolean optimize = false;
protected Vertex start = null;
protected int parentStepIndex = 0;
protected int containerStepIndex = 0;
protected int stepIndex = 0;
/**
* Instantiates a new query builder.
*
* @param loader the loader
*/
public QueryBuilder(Loader loader, GraphTraversalSource source) {
this.loader = loader;
this.source = source;
initEdgeIngestor();
}
/**
* Instantiates a new query builder.
*
* @param loader the loader
* @param start the start
*/
public QueryBuilder(Loader loader, GraphTraversalSource source, Vertex start) {
this.loader = loader;
this.start = start;
this.source = source;
initEdgeIngestor();
}
public void changeLoader(Loader loader) {
this.loader = loader;
}
protected abstract QueryBuilder<E> cloneQueryAtStep(int index);
/**
* Gets the vertices by indexed property.
*
* @param key the key
* @param value the value
* @return the vertices by indexed property
*/
public QueryBuilder<Vertex> getVerticesByIndexedProperty(String key, Object value) {
return this.getVerticesByProperty(key, value);
}
/**
* Gets the vertices by property.
*
* @param key the key
* @param value the value
* @return the vertices by property
*/
public abstract QueryBuilder<Vertex> getVerticesByProperty(String key, Object value);
/**
* filters by all the values for this property
* @param key
* @param values
* @return vertices that match these values
*/
public QueryBuilder<Vertex> getVerticesByIndexedProperty(String key, List<?> values) {
return this.getVerticesByProperty(key, values);
}
/**
* filters by all the values for this property
* @param key
* @param values
* @return vertices that match these values
*/
public abstract QueryBuilder<Vertex> getVerticesByProperty(String key, List<?> values);
/**
* Gets the vertices that have this property key.
*
* @param key the key
* @param value the value
* @return the vertices by property
*/
public abstract QueryBuilder<Vertex> getVerticesByProperty(String key);
/**
* Gets the vertices that do not have this property key.
*
* @param key the key
* @param value the value
* @return the vertices by property
*/
public abstract QueryBuilder<Vertex> getVerticesExcludeByProperty(String key);
/**
* filters by elements that start with the value for this property
* @param key
* @param value
* @return vertices that match these values
*/
public abstract QueryBuilder<Vertex> getVerticesStartsWithProperty(String key, Object value);
/**
* Gets the vertices that are excluded by property.
*
* @param key the key
* @param value the value
* @return the vertices by property
*/
public abstract QueryBuilder<Vertex> getVerticesExcludeByProperty(String key, Object value);
/**
* filters by all the values for this property and excludes the vertices
* @param key
* @param values
* @return vertices that match these values
*/
public QueryBuilder<Vertex> getVerticesExcludeByIndexedProperty(String key, List<?> values) {
return this.getVerticesExcludeByProperty(key, values);
}
/**
* filters by all the values for this property and excludes the vertices
* @param key
* @param values
* @return vertices that match these values
*/
public abstract QueryBuilder<Vertex> getVerticesExcludeByProperty(String key, List<?> values);
/**
* filters by all the values greater than for this property
* @param key
* @param values
* @return vertices that match these values
*/
public abstract QueryBuilder<Vertex> getVerticesGreaterThanProperty(String key, Object value) ;
/**
* filters by all the values less than for this property
* @param key
* @param values
* @return vertices that match these values
*/
public abstract QueryBuilder<Vertex> getVerticesLessThanProperty(String key, Object value) ;
/**
* Gets the child vertices from parent.
*
* @param parentKey the parent key
* @param parentValue the parent value
* @param childType the child type
* @return the child vertices from parent
*/
public abstract QueryBuilder<Vertex> getChildVerticesFromParent(String parentKey, String parentValue, String childType);
/**
* Gets the typed vertices by map.
*
* @param type the type
* @param map the map
* @return the typed vertices by map
*/
public abstract QueryBuilder<Vertex> getTypedVerticesByMap(String type, Map<String, String> map);
/**
* Creates the DB query.
*
* @param obj the obj
* @return the query builder
*/
public QueryBuilder<Vertex> createDBQuery(Introspector obj) {
this.createKeyQuery(obj);
this.createContainerQuery(obj);
return (QueryBuilder<Vertex>) this;
}
/**
* Creates the key query.
*
* @param obj the obj
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createKeyQuery(Introspector obj);
/**
* Creates the container query.
*
* @param obj the obj
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createContainerQuery(Introspector obj);
/**
* Creates the edge traversal.
*
* @param parent the parent
* @param child the child
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createEdgeTraversal(EdgeType type, Introspector parent, Introspector child) throws AAIException;
public abstract QueryBuilder<Vertex> getVerticesByBooleanProperty(String key, Object value);
public QueryBuilder<Vertex> getVerticesByBooleanProperty(String key, MissingOptionalParameter value) {
return (QueryBuilder<Vertex>) this;
}
/**
* Creates the private edge traversal.
*
* @param parent the parent
* @param child the child
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createPrivateEdgeTraversal(EdgeType type, Introspector parent, Introspector child) throws AAIException;
/**
* Creates the edge traversal.
*
* @param parent the parent
* @param child the child
* @return the query builder
*/
public QueryBuilder<Vertex> createEdgeTraversal(EdgeType type, Vertex parent, Introspector child) throws AAIException {
String nodeType = parent.<String>property(AAIProperties.NODE_TYPE).orElse(null);
this.createEdgeTraversal(type, nodeType, child.getDbName());
return (QueryBuilder<Vertex>) this;
}
/**
*
* @param type
* @param outNodeType
* @param inNodeType
* @return
* @throws AAIException
*/
public QueryBuilder<Vertex> createEdgeTraversal(EdgeType type, String outNodeType, String inNodeType) throws AAIException {
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
return createEdgeTraversal(type, out, in);
}
/**
*
* @param edgeType
* @param outNodeType
* @param inNodeType
* @return
* @throws AAIException
*/
public QueryBuilder<Vertex> createEdgeTraversal(String edgeType, String outNodeType, String inNodeType) throws AAIException {
/*
* When the optional parameter edgetype is sent it is a string that needs to be converted to Enum
*/
EdgeType type = EdgeType.valueOf(edgeType);
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
return createEdgeTraversal(type, out, in);
}
/**
*
* @param MissingOptionalParameter
* @param outNodeType
* @param inNodeType
* @return
* @throws AAIException
*/
public QueryBuilder<Vertex> createEdgeTraversal(MissingOptionalParameter edgeType, String outNodeType, String inNodeType) throws AAIException {
/*
* When no optional parameter edgetype is sent get all edges between the 2 nodetypes
*/
return this.createEdgeTraversal(outNodeType, inNodeType);
}
public QueryBuilder<Vertex> createEdgeTraversal(String outNodeType, String inNodeType) throws AAIException {
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
QueryBuilder<Vertex> cousinBuilder = null;
QueryBuilder<Vertex> treeBuilder = null;
QueryBuilder<Vertex> queryBuilder = null;
try {
cousinBuilder = this.newInstance().createEdgeTraversal(EdgeType.COUSIN, out, in);
} catch (AAIException e) {
}
if(cousinBuilder != null){
try {
treeBuilder = this.newInstance().createEdgeTraversal(EdgeType.TREE, out, in);
} catch (AAIException e) {
}
if(treeBuilder != null){
queryBuilder = this.union(new QueryBuilder[]{cousinBuilder, treeBuilder});
} else {
queryBuilder = this.union(new QueryBuilder[]{cousinBuilder});
}
} else {
treeBuilder = this.newInstance().createEdgeTraversal(EdgeType.TREE, out, in);
queryBuilder = this.union(new QueryBuilder[]{treeBuilder});
}
return queryBuilder;
}
public QueryBuilder<Vertex> createPrivateEdgeTraversal(EdgeType type, String outNodeType, String inNodeType) throws AAIException {
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
return createPrivateEdgeTraversal(type, out, in);
}
/**
*
* @param type
* @param outNodeType
* @param inNodeType
* @param labels
* @return
* @throws AAIException
*/
public QueryBuilder<Vertex> createEdgeTraversalWithLabels(EdgeType type, String outNodeType, String inNodeType, List<String> labels) throws AAIException {
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
return createEdgeTraversalWithLabels(type, out, in, labels);
}
/**
*
* @param type
* @param out
* @param in
* @param labels
* @return
*/
public abstract QueryBuilder<Vertex> createEdgeTraversalWithLabels(EdgeType type, Introspector out, Introspector in, List<String> labels) throws AAIException;
/**
*
* @param type
* @param outNodeType
* @param inNodeType
* @return
* @throws AAIException
*/
public QueryBuilder<Edge> getEdgesBetween(EdgeType type, String outNodeType, String inNodeType) throws AAIException {
this.getEdgesBetweenWithLabels(type, outNodeType, inNodeType, null);
return (QueryBuilder<Edge>)this;
}
/**
*
* @param type
* @param outNodeType
* @param inNodeType
* @param labels
* @return
* @throws AAIException
*/
public abstract QueryBuilder<Edge> getEdgesBetweenWithLabels(EdgeType type, String outNodeType, String inNodeType, List<String> labels) throws AAIException;
/**
* Creates the query from URI.
*
* @param uri the uri
* @return the query parser
* @throws UnsupportedEncodingException the unsupported encoding exception
* @throws AAIException the AAI exception
*/
public abstract QueryParser createQueryFromURI(URI uri) throws UnsupportedEncodingException, AAIException;
/**
* Creates the query from URI.
*
* @param uri the uri
* @param queryParams the query params
* @return the query parser
* @throws UnsupportedEncodingException the unsupported encoding exception
* @throws AAIException the AAI exception
*/
public abstract QueryParser createQueryFromURI(URI uri, MultivaluedMap<String, String> queryParams) throws UnsupportedEncodingException, AAIException;
/**
* Creates a queryparser from a given object name.
*
* @param objName - name of the object type as it appears in the database
* @return
*/
public abstract QueryParser createQueryFromObjectName(String objName);
/**
* Creates the query from relationship.
*
* @param relationship the relationship
* @return the query parser
* @throws UnsupportedEncodingException the unsupported encoding exception
* @throws AAIException the AAI exception
*/
public abstract QueryParser createQueryFromRelationship(Introspector relationship) throws UnsupportedEncodingException, AAIException;
/**
* Gets the parent query.
*
* @return the parent query
*/
public abstract QueryBuilder<E> getParentQuery();
/**
* Gets the query.
*
* @return the query
*/
public abstract <E2> E2 getQuery();
/**
* Form boundary.
*/
public abstract void markParentBoundary();
public abstract QueryBuilder<E> limit(long amount);
/**
* New instance.
*
* @param start the start
* @return the query builder
*/
public abstract QueryBuilder<E> newInstance(Vertex start);
/**
* New instance.
*
* @return the query builder
*/
public abstract QueryBuilder<E> newInstance();
/**
* Gets the start.
*
* @return the start
*/
public abstract Vertex getStart();
protected Object correctObjectType(Object obj) {
if (obj != null && obj.getClass().equals(Long.class)) {
return new Integer(obj.toString());
}
return obj;
}
/**
* uses all fields in the introspector to create a query
*
* @param obj
* @return
*/
public abstract QueryBuilder<Vertex> exactMatchQuery(Introspector obj);
/**
* lets you join any number of QueryBuilders
* <b>be careful about starting with a union it will not use indexes</b>
* @param builder
* @return
*/
public abstract QueryBuilder<E> union(QueryBuilder<E>... builder);
public abstract QueryBuilder<E> where(QueryBuilder<E>... builder);
public abstract QueryBuilder<E> or(QueryBuilder<E>... builder);
public abstract QueryBuilder<E> store(String name);
public abstract QueryBuilder<E> cap(String name);
public abstract QueryBuilder<E> unfold();
public abstract QueryBuilder<E> dedup();
public abstract QueryBuilder<E> emit();
public abstract QueryBuilder<E> repeat(QueryBuilder<E> builder);
public abstract QueryBuilder<Edge> outE();
public abstract QueryBuilder<Edge> inE();
public abstract QueryBuilder<Vertex> inV();
public abstract QueryBuilder<Vertex> outV();
public abstract QueryBuilder<E> not(QueryBuilder<E> builder);
public abstract QueryBuilder<E> as(String name);
public abstract QueryBuilder<E> select(String name);
public abstract QueryBuilder<E> select(String... names);
public abstract QueryBuilder<E> until(QueryBuilder<E> builder);
public abstract QueryBuilder<E> groupCount();
public abstract QueryBuilder<E> by(String name);
public abstract QueryBuilder<E> both();
public abstract QueryBuilder<Tree> tree();
/**
* Used to prevent the traversal from repeating its path through the graph.
* See http://tinkerpop.apache.org/docs/3.0.1-incubating/#simplepath-step for more info.
*
* @return a QueryBuilder with the simplePath step appended to its traversal
*/
public abstract QueryBuilder<E> simplePath();
/**
*
* @return QueryBuilder with the path step appended to its traversal
*/
public abstract QueryBuilder<Path> path();
public abstract void markContainer();
public abstract QueryBuilder<E> getContainerQuery();
public abstract List<E> toList();
/**
* Used to skip step if there is an optional property missing.
* @param key
* @param value
* @return
*/
public QueryBuilder<Vertex> getVerticesByProperty(String key, MissingOptionalParameter value) {
return (QueryBuilder<Vertex>) this;
}
/**
* TODO the edge direction is hardcoded here, make it more generic
* Returns the parent edge of the vertex
* @return
*/
public QueryBuilder<Edge> getParentEdge() {
this.outE().has(EdgeProperty.CONTAINS.toString(), AAIDirection.IN.toString());
return (QueryBuilder<Edge>)this;
}
/**
* TODO the edge direction is hardcoded here, make it more generic
* Returns the parent vertex of the vertex
* @return
*/
public QueryBuilder<Vertex> getParentVertex() {
this.getParentEdge().inV();
return (QueryBuilder<Vertex>)this;
}
protected abstract QueryBuilder<Edge> has(String key, String value);
protected void initEdgeIngestor() {
//TODO proper spring wiring, but that requires a lot of refactoring so for now we have this
ApplicationContext ctx = SpringContextAware.getApplicationContext();
EdgeIngestor ei = ctx.getBean(EdgeIngestor.class);
setEdgeIngestor(ei);
}
protected void setEdgeIngestor(EdgeIngestor ei) {
this.edgeRules = ei;
}
public QueryBuilder<Vertex> getVerticesByNumberProperty(String key, Object value) {
return getVerticesByProperty(key, value);
}
public QueryBuilder<Vertex> getVerticesByNumberProperty(String key) {
return getVerticesByProperty(key);
}
public QueryBuilder<Vertex> getVerticesByNumberProperty(String key, MissingOptionalParameter value) {
return getVerticesByProperty(key, value);
}
}
|