aai-core/src/main/java/org/onap/aai/query/builder/TraversalQuery.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 package org.onap.aai.query.builder;
  21
  22 import java.io.UnsupportedEncodingException;
  23 import java.net.URI;
  24 import java.util.List;
  25
  26 import javax.ws.rs.core.MultivaluedMap;
  27
  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;
  38
  39 /**
  40  * The Class TraversalQuery.
  41  */
  42 public class TraversalQuery<E> extends GraphTraversalBuilder<E> {
  43
  44         /**
  45          * Instantiates a new traversal query.
  46          *
  47          * @param loader the loader
  48          */
  49         public TraversalQuery(Loader loader, GraphTraversalSource source) {
  50                 super(loader, source);
  51                 this.factory = new TraversalStrategy(this.loader, this);
  52         }
  53
  54         /**
  55          * Instantiates a new traversal query.
  56          *
  57          * @param loader the loader
  58          * @param source graph traversal source
  59          * @param edgeRules the edgeRules to use
  60          */
  61         public TraversalQuery(Loader loader, GraphTraversalSource source, EdgeRules edgeRules) {
  62                 super(loader, source, edgeRules);
  63                 this.factory = new TraversalStrategy(this.loader, this);
  64
  65         }
  66
  67         /**
  68          * Instantiates a new traversal query.
  69          *
  70          * @param loader the loader
  71          * @param start the start
  72          */
  73         public TraversalQuery(Loader loader, GraphTraversalSource source, Vertex start) {
  74                 super(loader, source, start);
  75                 this.factory = new TraversalStrategy(this.loader, this);
  76         }
  77
  78         /**
  79          * Instantiates a new traversal query.
  80          *
  81          * @param loader the loader
  82          * @param start the start
  83          */
  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);
  87         }
  88
  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();
  97         }
  98
  99         /**
 100          * @{inheritDoc}
 101          */
 102         @Override
 103         public QueryParser createQueryFromURI(URI uri) throws UnsupportedEncodingException, AAIException {
 104                 return factory.buildURIParser(uri);
 105         }
 106
 107         /**
 108          * @{inheritDoc}
 109          */
 110         @Override
 111         public QueryParser createQueryFromRelationship(Introspector relationship) throws UnsupportedEncodingException, AAIException {
 112                 return factory.buildRelationshipParser(relationship);
 113         }
 114
 115         /**
 116          * @{inheritDoc}
 117          */
 118         @Override
 119         public QueryParser createQueryFromURI(URI uri, MultivaluedMap<String, String> queryParams)
 120                         throws UnsupportedEncodingException, AAIException {
 121                 return factory.buildURIParser(uri, queryParams);
 122         }
 123
 124         /**
 125          * @{inheritDoc}
 126          */
 127         @Override
 128         public QueryParser createQueryFromObjectName(String objName) {
 129                 return factory.buildObjectNameParser(objName);
 130         }
 131
 132         /**
 133          * @{inheritDoc}
 134          */
 135         @Override
 136         public QueryBuilder<E> newInstance(Vertex start) {
 137                 return new TraversalQuery<>(loader, source, start);
 138         }
 139
 140         /**
 141          * @{inheritDoc}
 142          */
 143         @Override
 144         public QueryBuilder<E> newInstance() {
 145                 return new TraversalQuery<>(loader, source);
 146         }
 147
 148         @Override
 149         protected QueryBuilder<E> cloneQueryAtStep(int index) {
 150                 int idx = index;
 151
 152                 if (idx == 0) {
 153                         idx = stepIndex;
 154                 }
 155
 156                 GraphTraversal<Vertex, E> clone = this.traversal.asAdmin().clone();
 157                 GraphTraversal.Admin<Vertex, E> cloneAdmin = clone.asAdmin();
 158                 List<Step> steps = cloneAdmin.getSteps();
 159
 160                 for (int i = steps.size()-1; i >= idx; i--) {
 161                         cloneAdmin.removeStep(i);
 162                 }
 163                 return new TraversalQuery<>(cloneAdmin, loader, source, this);
 164         }
 165
 166         @Override
 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();
 170
 171                 for (int i = end-2; i >= start; i--) {
 172                         cloneAdmin.removeStep(i);
 173                 }
 174                 return new TraversalQuery<>(cloneAdmin, loader, source, this);
 175         }
 176 }