sparkybe-onap-service/src/main/java/org/onap/aai/sparky/aggregatevnf/search/VnfSearchQueryBuilder.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 Amdocs
   7  * Copyright © 2019 IBM
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *       http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22 package org.onap.aai.sparky.aggregatevnf.search;
  23
  24 import java.util.Map;
  25
  26 import javax.json.Json;
  27 import javax.json.JsonArray;
  28 import javax.json.JsonArrayBuilder;
  29 import javax.json.JsonObject;
  30 import javax.json.JsonObjectBuilder;
  31
  32
  33 /**
  34  * Build a JSON payload to send to elastic search to get vnf search data.
  35  */
  36
  37 public class VnfSearchQueryBuilder {
  38
  39
  40   /**
  41    * Creates the suggestions query.
  42    *
  43    * @param maxResults maximum number of suggestions to fetch
  44    * @param queryStr query string
  45    * @return the json object
  46    */
  47
  48   /*
  49    * { "vnfs" : { "text" : "VNFs", "completion" : { "field" : "entity_suggest", "size": 1 } } }
  50    */
  51   public static JsonObject createSuggestionsQuery(String maxResults, String queryStr) {
  52     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
  53
  54     JsonObjectBuilder completionBlob = Json.createObjectBuilder();
  55     completionBlob.add("field", "entity_suggest");
  56     completionBlob.add("size", maxResults);
  57
  58     JsonObjectBuilder jsonAllBuilder = Json.createObjectBuilder();
  59     jsonAllBuilder.add("text", queryStr);
  60     jsonAllBuilder.add("completion", completionBlob);
  61
  62     jsonBuilder.add("vnfs", jsonAllBuilder.build());
  63     return jsonBuilder.build();
  64   }
  65
  66   public static JsonObject getTermBlob(String key, String value) {
  67     JsonObjectBuilder termBlobBuilder = Json.createObjectBuilder();
  68     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder().add(key, value);
  69     return termBlobBuilder.add("term", jsonBuilder.build()).build();
  70   }
  71
  72   public static void getSummaryAggsBlob(JsonObjectBuilder aggsBlobBuilder, String aggsKey,
  73       int resultSize) {
  74     JsonObjectBuilder fieldBuilder =
  75         Json.createObjectBuilder().add("field", aggsKey).add("size", resultSize);
  76     JsonObject aggsFieldBlob = fieldBuilder.build();
  77     JsonObjectBuilder defaultBlobBuilder = Json.createObjectBuilder().add("terms", aggsFieldBlob);
  78     JsonObject defaultBlob = defaultBlobBuilder.build();
  79     aggsBlobBuilder.add("default", defaultBlob);
  80   }
  81
  82   public static void buildSingleTermCountQuery(JsonObjectBuilder jsonBuilder, String key,
  83       String value) {
  84     jsonBuilder.add("query", getTermBlob(key, value));
  85   }
  86
  87   public static void buildSingleTermSummaryQuery(JsonObjectBuilder jsonBuilder, String key,
  88       String value, String groupByKey) {
  89     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
  90     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
  91
  92     queryBlobBuilder.add("constant_score",
  93         Json.createObjectBuilder().add("filter", getTermBlob(key, value)));
  94
  95     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
  96
  97     jsonBuilder.add("query", queryBlobBuilder.build());
  98     jsonBuilder.add("aggs", aggsBlobBuilder.build());
  99   }
 100
 101   public static void buildMultiTermSummaryQuery(JsonObjectBuilder jsonBuilder,
 102       Map<String, String> attributes, String groupByKey) {
 103     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
 104     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 105     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 106     for (Map.Entry<String, String> entry : attributes.entrySet()) {
 107       mustBlobBuilder.add(getTermBlob(entry.getKey(), entry.getValue()));
 108     }
 109     JsonArray mustBlob = mustBlobBuilder.build();
 110
 111     queryBlobBuilder.add("constant_score", Json.createObjectBuilder().add("filter",
 112         Json.createObjectBuilder().add("bool", Json.createObjectBuilder().add("must", mustBlob))));
 113
 114     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 115
 116     jsonBuilder.add("query", queryBlobBuilder.build());
 117     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 118   }
 119
 120   public static void buildZeroTermSummaryQuery(JsonObjectBuilder jsonBuilder, String groupByKey) {
 121     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 122
 123     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 124
 125     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 126   }
 127
 128   public static void buildMultiTermCountQuery(JsonObjectBuilder jsonBuilder,
 129       Map<String, String> attributes) {
 130     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 131     for (Map.Entry<String, String> entry : attributes.entrySet()) {
 132       mustBlobBuilder.add(getTermBlob(entry.getKey(), entry.getValue()));
 133     }
 134     jsonBuilder.add("query", Json.createObjectBuilder().add("bool",
 135         Json.createObjectBuilder().add("must", mustBlobBuilder)));
 136   }
 137
 138
 139
 140   public static JsonObject createSummaryByEntityTypeQuery(Map<String, String> attributes,
 141       String groupByKey) {
 142     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 143     jsonBuilder.add("size", "0"); // avoid source data
 144     if (attributes.size() == 0) {
 145       buildZeroTermSummaryQuery(jsonBuilder, groupByKey);
 146     } else if (attributes.size() == 1) {
 147       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 148       buildSingleTermSummaryQuery(jsonBuilder, entry.getKey(), entry.getValue(), groupByKey);
 149     } else {
 150       buildMultiTermSummaryQuery(jsonBuilder, attributes, groupByKey);
 151     }
 152     return jsonBuilder.build();
 153   }
 154
 155   public static JsonObject createEntityCountsQuery(Map<String, String> attributes) {
 156     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 157     if (attributes.size() == 1) {
 158       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 159       buildSingleTermCountQuery(jsonBuilder, entry.getKey(), entry.getValue());
 160     } else {
 161       buildMultiTermCountQuery(jsonBuilder, attributes);
 162     }
 163     return jsonBuilder.build();
 164   }
 165
 166   public static JsonArray getSortCriteria(String sortFieldName, String sortOrder) {
 167     JsonArrayBuilder jsonBuilder = Json.createArrayBuilder();
 168     jsonBuilder.add(Json.createObjectBuilder().add(sortFieldName,
 169         Json.createObjectBuilder().add("order", sortOrder)));
 170
 171     return jsonBuilder.build();
 172   }
 173 }