2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.aai.query.builder;
22 import java.io.UnsupportedEncodingException;
24 import java.util.List;
26 import javax.ws.rs.core.MultivaluedMap;
28 import org.apache.tinkerpop.gremlin.process.traversal.Step;
29 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal;
30 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
31 import org.apache.tinkerpop.gremlin.structure.Vertex;
32 import org.onap.aai.exceptions.AAIException;
33 import org.onap.aai.introspection.Introspector;
34 import org.onap.aai.introspection.Loader;
35 import org.onap.aai.parsers.query.QueryParser;
36 import org.onap.aai.parsers.query.TraversalStrategy;
37 import org.onap.aai.serialization.db.EdgeRules;
40 * The Class TraversalQuery.
42 public class TraversalQuery<E> extends GraphTraversalBuilder<E> {
45 * Instantiates a new traversal query.
47 * @param loader the loader
49 public TraversalQuery(Loader loader, GraphTraversalSource source) {
50 super(loader, source);
51 this.factory = new TraversalStrategy(this.loader, this);
55 * Instantiates a new traversal query.
57 * @param loader the loader
58 * @param source graph traversal source
59 * @param edgeRules the edgeRules to use
61 public TraversalQuery(Loader loader, GraphTraversalSource source, EdgeRules edgeRules) {
62 super(loader, source, edgeRules);
63 this.factory = new TraversalStrategy(this.loader, this);
68 * Instantiates a new traversal query.
70 * @param loader the loader
71 * @param start the start
73 public TraversalQuery(Loader loader, GraphTraversalSource source, Vertex start) {
74 super(loader, source, start);
75 this.factory = new TraversalStrategy(this.loader, this);
79 * Instantiates a new traversal query.
81 * @param loader the loader
82 * @param start the start
84 public TraversalQuery(Loader loader, GraphTraversalSource source, Vertex start, EdgeRules edgeRules) {
85 super(loader, source, start, edgeRules);
86 this.factory = new TraversalStrategy(this.loader, this);
89 protected TraversalQuery(GraphTraversal<Vertex, E> traversal, Loader loader, GraphTraversalSource source, GraphTraversalBuilder<E> gtb) {
90 super(loader, source);
91 this.traversal = traversal;
92 this.stepIndex = gtb.getStepIndex();
93 this.parentStepIndex = gtb.getParentStepIndex();
94 this.containerStepIndex = gtb.getContainerStepIndex();
95 this.factory = new TraversalStrategy(this.loader, this);
96 this.start = gtb.getStart();
103 public QueryParser createQueryFromURI(URI uri) throws UnsupportedEncodingException, AAIException {
104 return factory.buildURIParser(uri);
111 public QueryParser createQueryFromRelationship(Introspector relationship) throws UnsupportedEncodingException, AAIException {
112 return factory.buildRelationshipParser(relationship);
119 public QueryParser createQueryFromURI(URI uri, MultivaluedMap<String, String> queryParams)
120 throws UnsupportedEncodingException, AAIException {
121 return factory.buildURIParser(uri, queryParams);
128 public QueryParser createQueryFromObjectName(String objName) {
129 return factory.buildObjectNameParser(objName);
136 public QueryBuilder<E> newInstance(Vertex start) {
137 return new TraversalQuery<>(loader, source, start);
144 public QueryBuilder<E> newInstance() {
145 return new TraversalQuery<>(loader, source);
149 protected QueryBuilder<E> cloneQueryAtStep(int index) {
156 GraphTraversal<Vertex, E> clone = this.traversal.asAdmin().clone();
157 GraphTraversal.Admin<Vertex, E> cloneAdmin = clone.asAdmin();
158 List<Step> steps = cloneAdmin.getSteps();
160 for (int i = steps.size()-1; i >= idx; i--) {
161 cloneAdmin.removeStep(i);
163 return new TraversalQuery<>(cloneAdmin, loader, source, this);
167 protected QueryBuilder<E> removeQueryStepsBetween(int start, int end) {
168 GraphTraversal<Vertex, E> clone = this.traversal.asAdmin().clone();
169 GraphTraversal.Admin<Vertex, E> cloneAdmin = clone.asAdmin();
171 for (int i = end-2; i >= start; i--) {
172 cloneAdmin.removeStep(i);
174 return new TraversalQuery<>(cloneAdmin, loader, source, this);