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
|
/*-
* ============LICENSE_START=======================================================
* org.openecomp.aai
* ================================================================================
* Copyright (C) 2017 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.openecomp.aai.query.builder;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import javax.ws.rs.core.MultivaluedMap;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.openecomp.aai.exceptions.AAIException;
import org.openecomp.aai.introspection.Introspector;
import org.openecomp.aai.introspection.Loader;
import org.openecomp.aai.parsers.query.QueryParser;
import org.openecomp.aai.parsers.query.QueryParserStrategy;
import org.openecomp.aai.serialization.db.EdgeType;
import org.openecomp.aai.serialization.db.exceptions.NoEdgeRuleFoundException;
/**
* The Class QueryBuilder.
*/
public abstract class QueryBuilder<E> implements Iterator<E> {
protected QueryParserStrategy factory = null;
protected Loader loader = null;
protected boolean optimize = false;
protected Vertex start = null;
protected final GraphTraversalSource source;
/**
* Instantiates a new query builder.
*
* @param loader the loader
*/
public QueryBuilder(Loader loader, GraphTraversalSource source) {
this.loader = loader;
this.source = source;
}
/**
* 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;
}
/**
* Gets the vertices by indexed property.
*
* @param key the key
* @param value the value
* @return the vertices by indexed property
*/
public abstract QueryBuilder<Vertex> getVerticesByIndexedProperty(String key, Object 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 abstract QueryBuilder<Vertex> getVerticesByIndexedProperty(String key, List<?> 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 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, LinkedHashMap<String, String> map);
/**
* Creates the DB query.
*
* @param obj the obj
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createDBQuery(Introspector obj);
/**
* 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;
/**
* Creates the edge traversal.
*
* @param parent the parent
* @param child the child
* @return the query builder
*/
public abstract QueryBuilder<Vertex> createEdgeTraversal(EdgeType type, Vertex parent, Introspector child) throws AAIException;
public QueryBuilder<Vertex> createEdgeTraversal(EdgeType type, String outNodeType, String inNodeType) throws NoEdgeRuleFoundException, AAIException {
Introspector out = loader.introspectorFromName(outNodeType);
Introspector in = loader.introspectorFromName(inNodeType);
return createEdgeTraversal(type, out, in);
}
public abstract QueryBuilder<Edge> getEdgesBetween(EdgeType type, String outNodeType, String inNodeType) 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 void markContainer();
public abstract QueryBuilder<E> getContainerQuery();
public abstract List<E> toList();
}
|