2 * ============LICENSE_START=======================================================
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.onap.aai.sparky.search.filters;
25 import java.util.ArrayList;
26 import java.util.List;
28 import javax.json.Json;
29 import javax.json.JsonArrayBuilder;
30 import javax.json.JsonObject;
31 import javax.json.JsonObjectBuilder;
33 import org.onap.aai.sparky.search.filters.config.FiltersConfig;
34 import org.onap.aai.sparky.search.filters.config.UiFilterConfig;
35 import org.onap.aai.sparky.search.filters.entity.AggregationEntity;
36 import org.onap.aai.sparky.search.filters.entity.BoolQueryBuilder;
37 import org.onap.aai.sparky.search.filters.entity.FilteredAggregationQueryBuilder;
38 import org.onap.aai.sparky.search.filters.entity.MatchFilterCriteriaEntity;
39 import org.onap.aai.sparky.search.filters.entity.SearchFilter;
42 * Used to generate queries against Elasticsearch for filter related queries.
44 public class FilterQueryBuilder {
46 private static final int EXISTING_FILTERS_LIMIT = 0;
47 private static final int SHOULD_BRANCH_LIMIT = 2;
49 public static JsonObject createFilteredBoolQueryObject(FiltersConfig filtersConfig, List<SearchFilter> searchFilters, int minShouldMatch, List<String> fields) {
51 if (searchFilters == null || searchFilters.size() == 0) {
55 int searchFilterValueSize = 0;
57 BoolQueryBuilder boolQueryBuilder = new BoolQueryBuilder();
59 for (SearchFilter searchFilter : searchFilters) {
61 searchFilterValueSize = searchFilter.getValues().size();
64 * translate the filter-id into the filter-name from the oxm data model/config file
66 UiFilterConfig filter = filtersConfig.getFilterById(searchFilter.getFilterId());
68 if (filter == null || filter.getFilterName() == null) {
69 // log error and continue
72 String fieldName = filter.getDataSource().getFieldName();
73 if(!fields.contains(fieldName)) {
74 fields.add(fieldName);
77 if (searchFilterValueSize >= SHOULD_BRANCH_LIMIT) {
78 // Add should branches
79 for (String filterValue : searchFilter.getValues()) {
80 boolQueryBuilder.addShouldFilter(new MatchFilterCriteriaEntity(fieldName, filterValue));
83 } else if (searchFilterValueSize > EXISTING_FILTERS_LIMIT) {
85 for (String filterValue : searchFilter.getValues()) {
86 boolQueryBuilder.addMustFilter(new MatchFilterCriteriaEntity(fieldName, filterValue));
92 boolQueryBuilder.setMinShouldMatch(minShouldMatch);
94 return boolQueryBuilder.getJsonObject();
97 public static JsonObject createAggregationQueryArray(FiltersConfig filtersConfig, List<SearchFilter> searchFilters) {
99 if (searchFilters == null || searchFilters.size() == 0) {
104 FilteredAggregationQueryBuilder aggQueryBuilder = new FilteredAggregationQueryBuilder();
106 for (SearchFilter searchFilter : searchFilters) {
109 * translate the filter-id into the filter-name from the oxm data model/config file
111 UiFilterConfig filter = filtersConfig.getFilterById(searchFilter.getFilterId());
113 if (filter == null || filter.getFilterName() == null) {
114 // log error and continue
116 String fieldName = filter.getDataSource().getFieldName();
117 aggQueryBuilder.addAggregationEntity(new AggregationEntity(fieldName, fieldName, 0));
122 return aggQueryBuilder.getJsonObject();
125 public static JsonObject createCombinedBoolAndAggQuery(FiltersConfig filtersConfig, List<SearchFilter> searchFilters, int minShouldMatch) {
126 JsonObjectBuilder wrappedQueryBuilder = Json.createObjectBuilder();
127 if(searchFilters != null) {
128 List<String> fields = new ArrayList<String>();
129 JsonObject boolQuery = createFilteredBoolQueryObject(filtersConfig,searchFilters, minShouldMatch, fields);
130 JsonObject aggQuery = createAggregationQueryArray(filtersConfig, searchFilters);
132 if (boolQuery != null) {
133 wrappedQueryBuilder.add("size", 0);
135 JsonArrayBuilder filedsArrayBuilder = Json.createBuilderFactory(null).createArrayBuilder(); // TODO -> Should we use a class instance factory?
136 for(String field : fields) {
137 filedsArrayBuilder.add(field);
139 wrappedQueryBuilder.add("fields", filedsArrayBuilder.build());
141 wrappedQueryBuilder.add("query", boolQuery);
144 if (aggQuery != null) {
145 wrappedQueryBuilder.add("aggs", aggQuery);
148 return wrappedQueryBuilder.build();
151 public static JsonObject createFilterValueQueryObject(String fieldValue) {
152 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
153 jsonBuilder.add("size", "0"); // avoid source data
154 buildZeroTermSummaryQuery(jsonBuilder, fieldValue);
156 return jsonBuilder.build();
159 public static JsonObject createNestedFilterValueQueryObject(String fieldValue,
160 String pathToField) {
161 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
162 jsonBuilder.add("size", "0"); // avoid source data
163 generateNestedAggregations(jsonBuilder, fieldValue, pathToField);
165 return jsonBuilder.build();
168 public static void buildZeroTermSummaryQuery(JsonObjectBuilder jsonBuilder, String fieldValue) {
169 JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
170 getSummaryAggsBlob(aggsBlobBuilder, fieldValue, 0);
171 jsonBuilder.add("aggs", aggsBlobBuilder.build());
174 public static void getSummaryAggsBlob(JsonObjectBuilder aggsBlobBuilder, String fieldValue,
176 JsonObjectBuilder fieldBuilder =
177 Json.createObjectBuilder().add("field", fieldValue).add("size", resultSize);
178 JsonObject aggsFieldBlob = fieldBuilder.build();
179 JsonObjectBuilder defaultBlobBuilder = Json.createObjectBuilder().add("terms", aggsFieldBlob);
180 JsonObject defaultBlob = defaultBlobBuilder.build();
181 aggsBlobBuilder.add("default", defaultBlob);
184 public static void addNestedSummaryAggsBlob(JsonObjectBuilder nestedAggsBuilder,
185 String containerValue, String fieldValue, int resultSize) {
186 JsonObjectBuilder fieldBuilder = Json.createObjectBuilder()
187 .add("field", containerValue + "." + fieldValue).add("size", resultSize);
188 JsonObject aggsFieldObject = fieldBuilder.build();
190 JsonObjectBuilder termBuilder = Json.createObjectBuilder().add("terms", aggsFieldObject);
191 JsonObject termObject = termBuilder.build();
193 JsonObjectBuilder namedAggsBuilder = Json.createObjectBuilder().add(fieldValue, termObject);
194 JsonObject namedAggsObject = namedAggsBuilder.build();
196 nestedAggsBuilder.add("aggs", namedAggsObject);
199 public static void generateNestedAggregations(JsonObjectBuilder jsonBuilder, String fieldValue,
200 String pathToField) {
201 JsonObjectBuilder nestedAggsBuilder = Json.createObjectBuilder();
203 JsonObjectBuilder pathObjectBuilder = Json.createObjectBuilder().add("path", pathToField);
204 JsonObject nestedPathObject = pathObjectBuilder.build();
206 JsonObjectBuilder nestedObjectBuilder =
207 Json.createObjectBuilder().add("nested", nestedPathObject);
209 addNestedSummaryAggsBlob(nestedObjectBuilder, pathToField, fieldValue, 0);
211 JsonObject nestedObject = nestedObjectBuilder.build();
212 nestedAggsBuilder.add(pathToField, nestedObject);
214 jsonBuilder.add("aggs", nestedAggsBuilder.build());