src/main/java/org/openecomp/sparky/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.openecomp.sparky.search;
  26
  27 import java.util.Date;
  28 import java.util.Map;
  29
  30 import javax.json.Json;
  31 import javax.json.JsonArray;
  32 import javax.json.JsonArrayBuilder;
  33 import javax.json.JsonObject;
  34 import javax.json.JsonObjectBuilder;
  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    * Creates the suggestions query.
  44    *
  45    * @param maxResults maximum number of suggestions to fetch
  46    * @param queryStr query string
  47    * @return the json object
  48    */
  49
  50   /*
  51    * { "vnfs" : { "text" : "VNFs", "completion" : { "field" : "entity_suggest", "size": 1 } } }
  52    */
  53   public static JsonObject createSuggestionsQuery(String maxResults, String queryStr) {
  54     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
  55
  56     JsonObjectBuilder completionBlob = Json.createObjectBuilder();
  57     completionBlob.add("field", "entity_suggest");
  58     completionBlob.add("size", maxResults);
  59
  60     JsonObjectBuilder jsonAllBuilder = Json.createObjectBuilder();
  61     jsonAllBuilder.add("text", queryStr);
  62     jsonAllBuilder.add("completion", completionBlob);
  63
  64     jsonBuilder.add("vnfs", jsonAllBuilder.build());
  65     return jsonBuilder.build();
  66   }
  67
  68   public static JsonObject getTermBlob(String key, String value) {
  69     JsonObjectBuilder termBlobBuilder = Json.createObjectBuilder();
  70     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder().add(key, value);
  71     return termBlobBuilder.add("term", jsonBuilder.build()).build();
  72   }
  73
  74   public static void getSummaryAggsBlob(JsonObjectBuilder aggsBlobBuilder, String aggsKey,
  75       int resultSize) {
  76     JsonObjectBuilder fieldBuilder =
  77         Json.createObjectBuilder().add("field", aggsKey).add("size", resultSize);
  78     JsonObject aggsFieldBlob = fieldBuilder.build();
  79     JsonObjectBuilder defaultBlobBuilder = Json.createObjectBuilder().add("terms", aggsFieldBlob);
  80     JsonObject defaultBlob = defaultBlobBuilder.build();
  81     aggsBlobBuilder.add("default", defaultBlob);
  82   }
  83
  84   public static void buildSingleTermCountQuery(JsonObjectBuilder jsonBuilder, String key,
  85       String value) {
  86     jsonBuilder.add("query", getTermBlob(key, value));
  87   }
  88
  89   public static void buildSingleTermSummaryQuery(JsonObjectBuilder jsonBuilder, String key,
  90       String value, String groupByKey) {
  91     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
  92     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
  93
  94     queryBlobBuilder.add("constant_score",
  95         Json.createObjectBuilder().add("filter", getTermBlob(key, value)));
  96
  97     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
  98
  99     jsonBuilder.add("query", queryBlobBuilder.build());
 100     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 101   }
 102
 103   public static void buildMultiTermSummaryQuery(JsonObjectBuilder jsonBuilder,
 104       Map<String, String> attributes, String groupByKey) {
 105     JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
 106     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 107     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 108     for (String key : attributes.keySet()) {
 109       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
 110     }
 111     JsonArray mustBlob = mustBlobBuilder.build();
 112
 113     queryBlobBuilder.add("constant_score", Json.createObjectBuilder().add("filter",
 114         Json.createObjectBuilder().add("bool", Json.createObjectBuilder().add("must", mustBlob))));
 115
 116     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 117
 118     jsonBuilder.add("query", queryBlobBuilder.build());
 119     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 120   }
 121
 122   public static void buildZeroTermSummaryQuery(JsonObjectBuilder jsonBuilder, String groupByKey) {
 123     JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
 124
 125     getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
 126
 127     jsonBuilder.add("aggs", aggsBlobBuilder.build());
 128   }
 129
 130   public static void buildMultiTermCountQuery(JsonObjectBuilder jsonBuilder,
 131       Map<String, String> attributes) {
 132     JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
 133     for (String key : attributes.keySet()) {
 134       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
 135     }
 136     jsonBuilder.add("query", Json.createObjectBuilder().add("bool",
 137         Json.createObjectBuilder().add("must", mustBlobBuilder)));
 138   }
 139
 140
 141
 142   public static JsonObject createSummaryByEntityTypeQuery(Map<String, String> attributes,
 143       String groupByKey) {
 144     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 145     jsonBuilder.add("size", "0"); // avoid source data
 146     if (attributes.size() == 0) {
 147       buildZeroTermSummaryQuery(jsonBuilder, groupByKey);
 148     } else if (attributes.size() == 1) {
 149       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 150       buildSingleTermSummaryQuery(jsonBuilder, entry.getKey(), entry.getValue(), groupByKey);
 151     } else {
 152       buildMultiTermSummaryQuery(jsonBuilder, attributes, groupByKey);
 153     }
 154     return jsonBuilder.build();
 155   }
 156
 157   public static JsonObject createEntityCountsQuery(Map<String, String> attributes) {
 158     JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
 159     if (attributes.size() == 1) {
 160       Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
 161       buildSingleTermCountQuery(jsonBuilder, entry.getKey(), entry.getValue());
 162     } else {
 163       buildMultiTermCountQuery(jsonBuilder, attributes);
 164     }
 165     return jsonBuilder.build();
 166   }
 167
 168   public static JsonArray getSortCriteria(String sortFieldName, String sortOrder) {
 169     JsonArrayBuilder jsonBuilder = Json.createArrayBuilder();
 170     jsonBuilder.add(Json.createObjectBuilder().add(sortFieldName,
 171         Json.createObjectBuilder().add("order", sortOrder)));
 172
 173     return jsonBuilder.build();
 174   }
 175
 176
 177   /**
 178    * The main method.
 179    *
 180    * @param args the arguments
 181    */
 182   public static void main(String[] args) {
 183     Date start = new Date(System.currentTimeMillis() - Integer.MAX_VALUE);
 184     Date end = new Date();
 185     String timezone = "-05:00";
 186     // JsonObject arr = createDateHistogramQuery(start, end, timezone);
 187
 188     // System.out.println(arr.toString());
 189
 190
 191     // JsonObject table = createTableQuery(start, end, timezone, 0, 25);
 192     // JsonObject aggre = createAuditQuery(start, end, timezone, "entityType", null, null);
 193
 194     // System.out.println(arr.toString());
 195     // System.out.println(table.toString());
 196     // System.out.println(aggre.toString());
 197
 198
 199   }
 200 }