aboutsummaryrefslogtreecommitdiffstats
path: root/aai-core/src/main/java/org/onap/aai/query/builder/TraversalURIOptimizedQuery.java
blob: 0e2a9cad873417469cc18f81da1a2b10935996f8 (plain)
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
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 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.onap.aai.query.builder;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

import org.apache.tinkerpop.gremlin.process.traversal.Step;
import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.process.traversal.util.TraversalHelper;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.onap.aai.db.props.AAIProperties;
import org.onap.aai.introspection.Introspector;
import org.onap.aai.introspection.Loader;
import org.onap.aai.schema.enums.ObjectMetadata;

public class TraversalURIOptimizedQuery<E> extends TraversalQuery {

    protected Map<Integer, String> stepToAaiUri = new HashMap<>();

    public TraversalURIOptimizedQuery(Loader loader, GraphTraversalSource source) {
        super(loader, source);
        optimize = true;
    }

    public TraversalURIOptimizedQuery(Loader loader, GraphTraversalSource source, Vertex start) {
        super(loader, source, start);
        optimize = true;
    }

    protected TraversalURIOptimizedQuery(GraphTraversal traversal, Loader loader, GraphTraversalSource source,
            GraphTraversalBuilder gtb) {
        super(traversal, loader, source, gtb);
        optimize = true;
    }

    protected TraversalURIOptimizedQuery(GraphTraversal traversal, Loader loader, GraphTraversalSource source,
            GraphTraversalBuilder gtb, Map<Integer, String> stepToAaiUri) {
        super(traversal, loader, source, gtb);
        optimize = gtb.optimize;
        this.stepToAaiUri = stepToAaiUri;
    }

    @Override
    protected void executeQuery() {

        this.completeTraversal = this.traversal.asAdmin().clone();

        if (this.optimize) {
            this.completeTraversal = this.pivotTraversal(this.completeTraversal);
        }

        if (start == null) {
            Traversal.Admin admin = source.V().asAdmin();
            TraversalHelper.insertTraversal(admin.getEndStep(), completeTraversal, admin);

            this.completeTraversal = (Traversal.Admin<Vertex, E>) admin;

        }

    }

    private Traversal.Admin<Vertex, E> pivotTraversal(Traversal.Admin<Vertex, E> traversalAdmin) {

        List<Step> steps = traversalAdmin.getSteps();

        Traversal.Admin<Vertex, E> traversalAdminStart = traversalAdmin.clone();

        // if we do not have an index or other conditions do no optimization
        if (stepToAaiUri.isEmpty()) {
            return traversalAdmin;
        }

        int lastURIStepKey = getLastURIStepKey();

        // clean up traversal steps
        for (int i = 0; i < steps.size(); i++) {
            traversalAdminStart.removeStep(0);
        }

        ((GraphTraversal<Vertex, E>) traversalAdminStart).has(AAIProperties.AAI_URI, stepToAaiUri.get(lastURIStepKey));
        for (int i = lastURIStepKey; i < steps.size(); i++) {
            traversalAdminStart.addStep(steps.get(i));
        }

        return traversalAdminStart;
    }

    @Override
    public QueryBuilder<Vertex> createKeyQuery(Introspector obj) {
        super.createKeyQuery(obj);

        if (shouldAddStepUri(obj)) {
            Optional<String> uri = getStepUriFromIntrospector(obj);
            if (uri.isPresent()) {
                if (stepToAaiUri.isEmpty()) {
                    stepToAaiUri.put(stepIndex + 1, uri.get());
                } else {
                    stepToAaiUri.put(stepIndex, uri.get());
                }
            }
        } else {
            optimize = false;
            stepToAaiUri = new HashMap<>();
        }
        return (QueryBuilder<Vertex>) this;
    }

    private boolean shouldAddStepUri(Introspector obj) {
        boolean shouldOptimize = optimize;

        if (shouldOptimize && start != null) {
            shouldOptimize = false;
        }

        if (shouldOptimize && stepToAaiUri.isEmpty() && !obj.isTopLevel()) {
            shouldOptimize = false;
        }

        if (shouldOptimize && obj.getMetadata(ObjectMetadata.ABSTRACT) != null) {
            shouldOptimize = false;
        }

        return shouldOptimize;
    }

    private Optional<String> getStepUriFromIntrospector(Introspector obj) {
        String uri = "";
        try {
            uri = obj.getURI();
        } catch (Exception e) {
        }

        if ("".equals(uri)) {
            return Optional.empty();
        }

        if (!stepToAaiUri.isEmpty()) {
            uri = stepToAaiUri.get(getLastURIStepKey()) + uri;
        }

        return Optional.of(uri);
    }

    protected int getLastURIStepKey() {
        return stepToAaiUri.keySet().stream().mapToInt(Integer::intValue).max().getAsInt();
    }

    private Map<Integer, String> getStepToAaiUriWithoutStepGreaterThan(final int index) {
        return stepToAaiUri.entrySet().stream().filter(kv -> kv.getKey() <= index)
                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
    }

    @Override
    protected QueryBuilder<E> cloneQueryAtStep(int index) {
        GraphTraversal.Admin<Vertex, E> cloneAdmin = getCloneAdmin(index);
        return new TraversalURIOptimizedQuery<>(cloneAdmin, loader, source, this,
                getStepToAaiUriWithoutStepGreaterThan(index));
    }

}