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

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   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  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25 package org.onap.aai.sparky.aggregatevnf.search;
  26
  27 import java.util.Map;
  28
  29 import javax.json.Json;
  30 import javax.json.JsonArray;
  31 import javax.json.JsonArrayBuilder;
  32 import javax.json.JsonObject;
  33 import javax.json.JsonObjectBuilder;
  34
  35
  36 /**
  37  * Build a JSON payload to send to elastic search to get vnf search data.
  38  */
  39
  40 public class VnfSearchQueryBuilder {
  41
  42
  43   /**
  44    * Creates the suggestions query.
  45    *
  46    * @param maxResults maximum number of suggestions to fetch
  47    * @param queryStr query string
  48    * @return the json object
  49    */
  50
  51   /*
  52    * { "vnfs" : { "text" : "VNFs", "completion" : { "field" : "entity_suggest", "size": 1 } } }
  53    */
  54   public static JsonObject createSuggestionsQuery(String maxResults, String queryStr) {
  55     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
  56
  57     JsonObjectBuilder completionBlob = Json.createObjectBuilder();
  58     completionBlob.add("field", "entity_suggest");
  59     completionBlob.add("size", maxResults);
  60
  61     JsonObjectBuilder jsonAllBuilder = Json.createObjectBuilder();
  62     jsonAllBuilder.add("text", queryStr);
  63     jsonAllBuilder.add("completion", completionBlob);
  64
  65     jsonBuilder.add("vnfs", jsonAllBuilder.build());
  66     return jsonBuilder.build();
  67   }
  68
  69   public static JsonObject getTermBlob(String key, String value) {
  70     JsonObjectBuilder termBlobBuilder = Json.createObjectBuilder();
  71     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder().add(key, value);
  72     return termBlobBuilder.add("term", jsonBuilder.build()).build();
  73   }
  74
  75   public static void getSummaryAggsBlob(JsonObjectBuilder aggsBlobBuilder, String aggsKey,
  76       int resultSize) {
  77     JsonObjectBuilder fieldBuilder =
  78         Json.createObjectBuilder().add("field", aggsKey).add("size", resultSize);
  79     JsonObject aggsFieldBlob = fieldBuilder.build();
  80     JsonObjectBuilder defaultBlobBuilder = Json.createObjectBuilder().add("terms", aggsFieldBlob);
  81     JsonObject defaultBlob = defaultBlobBuilder.build();
  82     aggsBlobBuilder.add("default", defaultBlob);
  83   }
  84
  85   public static void buildSingleTermCountQuery(JsonObjectBuilder jsonBuilder, String key,
  86       String value) {
  87     jsonBuilder.add("query", getTermBlob(key, value));
  88   }
  89
  90   public static void buildSingleTermSummaryQuery(JsonObjectBuilder jsonBuilder, String key,
  91       String value, String groupByKey) {
  92     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
  93     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
  94
  95     queryBlobBuilder.add("constant_score",
  96         Json.createObjectBuilder().add("filter", getTermBlob(key, value)));
  97
  98     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
  99
 100     jsonBuilder.add("query", queryBlobBuilder.build());
 101     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 102   }
 103
 104   public static void buildMultiTermSummaryQuery(JsonObjectBuilder jsonBuilder,
 105       Map<String, String> attributes, String groupByKey) {
 106     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
 107     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 108     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 109     for (String key : attributes.keySet()) {
 110       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
 111     }
 112     JsonArray mustBlob = mustBlobBuilder.build();
 113
 114     queryBlobBuilder.add("constant_score", Json.createObjectBuilder().add("filter",
 115         Json.createObjectBuilder().add("bool", Json.createObjectBuilder().add("must", mustBlob))));
 116
 117     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 118
 119     jsonBuilder.add("query", queryBlobBuilder.build());
 120     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 121   }
 122
 123   public static void buildZeroTermSummaryQuery(JsonObjectBuilder jsonBuilder, String groupByKey) {
 124     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 125
 126     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 127
 128     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 129   }
 130
 131   public static void buildMultiTermCountQuery(JsonObjectBuilder jsonBuilder,
 132       Map<String, String> attributes) {
 133     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 134     for (String key : attributes.keySet()) {
 135       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
 136     }
 137     jsonBuilder.add("query", Json.createObjectBuilder().add("bool",
 138         Json.createObjectBuilder().add("must", mustBlobBuilder)));
 139   }
 140
 141
 142
 143   public static JsonObject createSummaryByEntityTypeQuery(Map<String, String> attributes,
 144       String groupByKey) {
 145     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 146     jsonBuilder.add("size", "0"); // avoid source data
 147     if (attributes.size() == 0) {
 148       buildZeroTermSummaryQuery(jsonBuilder, groupByKey);
 149     } else if (attributes.size() == 1) {
 150       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 151       buildSingleTermSummaryQuery(jsonBuilder, entry.getKey(), entry.getValue(), groupByKey);
 152     } else {
 153       buildMultiTermSummaryQuery(jsonBuilder, attributes, groupByKey);
 154     }
 155     return jsonBuilder.build();
 156   }
 157
 158   public static JsonObject createEntityCountsQuery(Map<String, String> attributes) {
 159     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 160     if (attributes.size() == 1) {
 161       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 162       buildSingleTermCountQuery(jsonBuilder, entry.getKey(), entry.getValue());
 163     } else {
 164       buildMultiTermCountQuery(jsonBuilder, attributes);
 165     }
 166     return jsonBuilder.build();
 167   }
 168
 169   public static JsonArray getSortCriteria(String sortFieldName, String sortOrder) {
 170     JsonArrayBuilder jsonBuilder = Json.createArrayBuilder();
 171     jsonBuilder.add(Json.createObjectBuilder().add(sortFieldName,
 172         Json.createObjectBuilder().add("order", sortOrder)));
 173
 174     return jsonBuilder.build();
 175   }
 176 }