Enhancements for the aai-common library
[aai/aai-common.git] / aai-core / src / main / java / org / onap / aai / query / builder / GremlinTraversal.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
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
10  *
11  *    http://www.apache.org/licenses/LICENSE-2.0
12  *
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=========================================================
19  */
20
21 package org.onap.aai.query.builder;
22
23 import java.io.UnsupportedEncodingException;
24 import java.net.URI;
25 import java.util.ArrayList;
26 import java.util.List;
27
28 import javax.ws.rs.core.MultivaluedMap;
29
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
38 /**
39  * The Class GremlinTraversal.
40  */
41 public class GremlinTraversal<E> extends GremlinQueryBuilder<E> {
42
43     /**
44      * Instantiates a new gremlin traversal.
45      *
46      * @param loader the loader
47      */
48     public GremlinTraversal(Loader loader, GraphTraversalSource source) {
49         super(loader, source);
50         this.factory = new TraversalStrategy(this.loader, this);
51     }
52
53     /**
54      * Instantiates a new gremlin traversal.
55      *
56      * @param loader the loader
57      * @param start the start
58      */
59     public GremlinTraversal(Loader loader, GraphTraversalSource source, Vertex start) {
60         super(loader, source, start);
61         this.factory = new TraversalStrategy(this.loader, this);
62     }
63
64
65     protected GremlinTraversal(List<String> traversal, Loader loader, GraphTraversalSource source,
66             GremlinQueryBuilder<E> gtb) {
67         super(loader, source);
68         this.list = traversal;
69         this.stepIndex = gtb.getStepIndex();
70         this.parentStepIndex = gtb.getParentStepIndex();
71         this.containerStepIndex = gtb.getContainerStepIndex();
72         this.factory = new TraversalStrategy(this.loader, this);
73         this.start = gtb.getStart();
74     }
75
76     /**
77      * @{inheritDoc}
78      */
79     @Override
80     public QueryParser createQueryFromURI(URI uri) throws UnsupportedEncodingException, AAIException {
81         return factory.buildURIParser(uri);
82     }
83
84     /**
85      * @{inheritDoc}
86      */
87     @Override
88     public QueryParser createQueryFromRelationship(Introspector relationship)
89             throws UnsupportedEncodingException, AAIException {
90         return factory.buildRelationshipParser(relationship);
91     }
92
93     /**
94      * @{inheritDoc}
95      */
96     @Override
97     public QueryParser createQueryFromURI(URI uri, MultivaluedMap<String, String> queryParams)
98             throws UnsupportedEncodingException, AAIException {
99         return factory.buildURIParser(uri, queryParams);
100     }
101
102     /**
103      * @{inheritDoc}
104      */
105     @Override
106     public QueryParser createQueryFromObjectName(String objName) {
107         return factory.buildObjectNameParser(objName);
108     }
109
110     /**
111      * @{inheritDoc}
112      */
113     @Override
114     public QueryBuilder<E> newInstance(Vertex start) {
115         return new GremlinTraversal<>(loader, source, start);
116     }
117
118     /**
119      * @{inheritDoc}
120      */
121     @Override
122     public QueryBuilder<E> newInstance() {
123         return new GremlinTraversal<>(loader, source);
124     }
125
126     @Override
127     protected QueryBuilder<E> cloneQueryAtStep(int index) {
128
129         int idx = index;
130
131         if (idx == 0) {
132             idx = stepIndex;
133         }
134
135         List<String> newList = new ArrayList<>();
136         for (int i = 0; i < idx; i++) {
137             newList.add(this.list.get(i));
138         }
139
140         return new GremlinTraversal<>(newList, loader, source, this);
141     }
142 }