aai-core/src/main/java/org/onap/aai/query/builder/TraversalQuery.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22 package org.onap.aai.query.builder;
  23
  24 import java.io.UnsupportedEncodingException;
  25 import java.net.URI;
  26 import java.util.List;
  27
  28 import javax.ws.rs.core.MultivaluedMap;
  29
  30 import org.apache.tinkerpop.gremlin.process.traversal.Step;
  31 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal;
  32 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
  33 import org.apache.tinkerpop.gremlin.structure.Vertex;
  34 import org.onap.aai.exceptions.AAIException;
  35 import org.onap.aai.introspection.Introspector;
  36 import org.onap.aai.introspection.Loader;
  37 import org.onap.aai.parsers.query.QueryParser;
  38 import org.onap.aai.parsers.query.TraversalStrategy;
  39 import org.onap.aai.serialization.db.EdgeRules;
  40
  41 /**
  42  * The Class TraversalQuery.
  43  */
  44 public class TraversalQuery<E> extends GraphTraversalBuilder<E> {
  45
  46         /**
  47          * Instantiates a new traversal query.
  48          *
  49          * @param loader the loader
  50          */
  51         public TraversalQuery(Loader loader, GraphTraversalSource source) {
  52                 super(loader, source);
  53                 this.factory = new TraversalStrategy(this.loader, this);
  54         }
  55
  56         /**
  57          * Instantiates a new traversal query.
  58          *
  59          * @param loader the loader
  60          * @param source graph traversal source
  61          * @param edgeRules the edgeRules to use
  62          */
  63         public TraversalQuery(Loader loader, GraphTraversalSource source, EdgeRules edgeRules) {
  64                 super(loader, source, edgeRules);
  65                 this.factory = new TraversalStrategy(this.loader, this);
  66
  67         }
  68
  69         /**
  70          * Instantiates a new traversal query.
  71          *
  72          * @param loader the loader
  73          * @param start the start
  74          */
  75         public TraversalQuery(Loader loader, GraphTraversalSource source, Vertex start) {
  76                 super(loader, source, start);
  77                 this.factory = new TraversalStrategy(this.loader, this);
  78         }
  79
  80         /**
  81          * Instantiates a new traversal query.
  82          *
  83          * @param loader the loader
  84          * @param start the start
  85          */
  86         public TraversalQuery(Loader loader, GraphTraversalSource source, Vertex start, EdgeRules edgeRules) {
  87                 super(loader, source, start, edgeRules);
  88                 this.factory = new TraversalStrategy(this.loader, this);
  89         }
  90
  91         protected TraversalQuery(GraphTraversal<Vertex, E> traversal, Loader loader, GraphTraversalSource source, GraphTraversalBuilder<E> gtb) {
  92                 super(loader, source);
  93                 this.traversal = traversal;
  94                 this.stepIndex = gtb.getStepIndex();
  95                 this.parentStepIndex = gtb.getParentStepIndex();
  96                 this.containerStepIndex = gtb.getContainerStepIndex();
  97                 this.factory = new TraversalStrategy(this.loader, this);
  98                 this.start = gtb.getStart();
  99         }
 100
 101         /**
 102          * @{inheritDoc}
 103          */
 104         @Override
 105         public QueryParser createQueryFromURI(URI uri) throws UnsupportedEncodingException, AAIException {
 106                 return factory.buildURIParser(uri);
 107         }
 108
 109         /**
 110          * @{inheritDoc}
 111          */
 112         @Override
 113         public QueryParser createQueryFromRelationship(Introspector relationship) throws UnsupportedEncodingException, AAIException {
 114                 return factory.buildRelationshipParser(relationship);
 115         }
 116
 117         /**
 118          * @{inheritDoc}
 119          */
 120         @Override
 121         public QueryParser createQueryFromURI(URI uri, MultivaluedMap<String, String> queryParams)
 122                         throws UnsupportedEncodingException, AAIException {
 123                 return factory.buildURIParser(uri, queryParams);
 124         }
 125
 126         /**
 127          * @{inheritDoc}
 128          */
 129         @Override
 130         public QueryParser createQueryFromObjectName(String objName) {
 131                 return factory.buildObjectNameParser(objName);
 132         }
 133
 134         /**
 135          * @{inheritDoc}
 136          */
 137         @Override
 138         public QueryBuilder<E> newInstance(Vertex start) {
 139                 return new TraversalQuery<>(loader, source, start);
 140         }
 141
 142         /**
 143          * @{inheritDoc}
 144          */
 145         @Override
 146         public QueryBuilder<E> newInstance() {
 147                 return new TraversalQuery<>(loader, source);
 148         }
 149
 150         @Override
 151         protected QueryBuilder<E> cloneQueryAtStep(int index) {
 152                 int idx = index;
 153
 154                 if (idx == 0) {
 155                         idx = stepIndex;
 156                 }
 157
 158                 GraphTraversal<Vertex, E> clone = this.traversal.asAdmin().clone();
 159                 GraphTraversal.Admin<Vertex, E> cloneAdmin = clone.asAdmin();
 160                 List<Step> steps = cloneAdmin.getSteps();
 161
 162                 for (int i = steps.size()-1; i >= idx; i--) {
 163                         cloneAdmin.removeStep(i);
 164                 }
 165                 return new TraversalQuery<>(cloneAdmin, loader, source, this);
 166         }
 167
 168         @Override
 169         protected QueryBuilder<E> removeQueryStepsBetween(int start, int end) {
 170                 GraphTraversal<Vertex, E> clone = this.traversal.asAdmin().clone();
 171                 GraphTraversal.Admin<Vertex, E> cloneAdmin = clone.asAdmin();
 172
 173                 for (int i = end-2; i >= start; i--) {
 174                         cloneAdmin.removeStep(i);
 175                 }
 176                 return new TraversalQuery<>(cloneAdmin, loader, source, this);
 177         }
 178 }