Changing the license and trademark
[aai/sparky-be.git] / src / main / java / org / openecomp / sparky / search / VnfSearchQueryBuilder.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6  * Copyright © 2017 Amdocs
7  * ================================================================================
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  *       http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  * ============LICENSE_END=========================================================
20  *
21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22  */
23 package org.openecomp.sparky.search;
24
25 import java.util.Date;
26 import java.util.Map;
27
28 import javax.json.Json;
29 import javax.json.JsonArray;
30 import javax.json.JsonArrayBuilder;
31 import javax.json.JsonObject;
32 import javax.json.JsonObjectBuilder;
33
34 /**
35  * Build a JSON payload to send to elastic search to get vnf search data.
36  */
37
38 public class VnfSearchQueryBuilder {
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 (String key : attributes.keySet()) {
107       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
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 (String key : attributes.keySet()) {
132       mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
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
174
175   /**
176    * The main method.
177    *
178    * @param args the arguments
179    */
180   public static void main(String[] args) {
181     Date start = new Date(System.currentTimeMillis() - Integer.MAX_VALUE);
182     Date end = new Date();
183     String timezone = "-05:00";
184     // JsonObject arr = createDateHistogramQuery(start, end, timezone);
185
186     // System.out.println(arr.toString());
187
188
189     // JsonObject table = createTableQuery(start, end, timezone, 0, 25);
190     // JsonObject aggre = createAuditQuery(start, end, timezone, "entityType", null, null);
191
192     // System.out.println(arr.toString());
193     // System.out.println(table.toString());
194     // System.out.println(aggre.toString());
195
196
197   }
198 }