Rename QueryBuilders to avoid name clash wih Elasticsearch class.

Original Pull Request #2397
Closes #2390

src/main/java/org/springframework/data/elasticsearch/client/elc/CriteriaQueryProcessor.java

@@ -15,7 +15,7 @@
  */
 package org.springframework.data.elasticsearch.client.elc;
 
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 import static org.springframework.util.StringUtils.*;
 
 import co.elastic.clients.elasticsearch._types.FieldValue;

src/main/java/org/springframework/data/elasticsearch/client/elc/Queries.java

@@ -0,0 +1,196 @@
+/*
+ * Copyright 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.client.elc;
+
+import co.elastic.clients.elasticsearch._types.FieldValue;
+import co.elastic.clients.elasticsearch._types.LatLonGeoLocation;
+import co.elastic.clients.elasticsearch._types.aggregations.Aggregation;
+import co.elastic.clients.elasticsearch._types.query_dsl.IdsQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.MatchAllQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.MatchQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.Operator;
+import co.elastic.clients.elasticsearch._types.query_dsl.Query;
+import co.elastic.clients.elasticsearch._types.query_dsl.QueryStringQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.TermQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.WildcardQuery;
+import co.elastic.clients.elasticsearch._types.query_dsl.WrapperQuery;
+import co.elastic.clients.util.ObjectBuilder;
+
+import java.nio.charset.StandardCharsets;
+import java.util.Base64;
+import java.util.List;
+import java.util.function.Function;
+
+import org.springframework.data.elasticsearch.core.geo.GeoPoint;
+import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
+import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
+
+/**
+ * Utility class simplifying the creation of some more complex queries and type.
+ *
+ * @author Peter-Josef Meisch
+ * @since 4.4
+ */
+public final class Queries {
+
+	private Queries() {}
+
+	public static IdsQuery idsQuery(List<String> ids) {
+
+		Assert.notNull(ids, "ids must not be null");
+
+		return IdsQuery.of(i -> i.values(ids));
+	}
+
+	public static Query idsQueryAsQuery(List<String> ids) {
+
+		Assert.notNull(ids, "ids must not be null");
+
+		Function<Query.Builder, ObjectBuilder<Query>> builder = b -> b.ids(idsQuery(ids));
+
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static MatchQuery matchQuery(String fieldName, String query, @Nullable Operator operator,
+			@Nullable Float boost) {
+
+		Assert.notNull(fieldName, "fieldName must not be null");
+		Assert.notNull(query, "query must not be null");
+
+		return MatchQuery.of(mb -> mb.field(fieldName).query(FieldValue.of(query)).operator(operator).boost(boost));
+	}
+
+	public static Query matchQueryAsQuery(String fieldName, String query, @Nullable Operator operator,
+			@Nullable Float boost) {
+
+		Function<Query.Builder, ObjectBuilder<Query>> builder = b -> b.match(matchQuery(fieldName, query, operator, boost));
+
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static MatchAllQuery matchAllQuery() {
+
+		return MatchAllQuery.of(b -> b);
+	}
+
+	public static Query matchAllQueryAsQuery() {
+
+		Function<Query.Builder, ObjectBuilder<Query>> builder = b -> b.matchAll(matchAllQuery());
+
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static QueryStringQuery queryStringQuery(String fieldName, String query, @Nullable Float boost) {
+		return queryStringQuery(fieldName, query, null, null, boost);
+	}
+
+	public static QueryStringQuery queryStringQuery(String fieldName, String query, Operator defaultOperator,
+			@Nullable Float boost) {
+		return queryStringQuery(fieldName, query, null, defaultOperator, boost);
+	}
+
+	public static QueryStringQuery queryStringQuery(String fieldName, String query, @Nullable Boolean analyzeWildcard,
+			@Nullable Float boost) {
+		return queryStringQuery(fieldName, query, analyzeWildcard, null, boost);
+	}
+
+	public static QueryStringQuery queryStringQuery(String fieldName, String query, @Nullable Boolean analyzeWildcard,
+			@Nullable Operator defaultOperator, @Nullable Float boost) {
+
+		Assert.notNull(fieldName, "fieldName must not be null");
+		Assert.notNull(query, "query must not be null");
+
+		return QueryStringQuery.of(qs -> qs.fields(fieldName).query(query).analyzeWildcard(analyzeWildcard)
+				.defaultOperator(defaultOperator).boost(boost));
+	}
+
+	public static TermQuery termQuery(String fieldName, String value) {
+
+		Assert.notNull(fieldName, "fieldName must not be null");
+		Assert.notNull(value, "value must not be null");
+
+		return TermQuery.of(t -> t.field(fieldName).value(FieldValue.of(value)));
+	}
+
+	public static Query termQueryAsQuery(String fieldName, String value) {
+
+		Function<Query.Builder, ObjectBuilder<Query>> builder = q -> q.term(termQuery(fieldName, value));
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static WildcardQuery wildcardQuery(String field, String value) {
+
+		Assert.notNull(field, "field must not be null");
+		Assert.notNull(value, "value must not be null");
+
+		return WildcardQuery.of(w -> w.field(field).wildcard(value));
+	}
+
+	public static Query wildcardQueryAsQuery(String field, String value) {
+		Function<Query.Builder, ObjectBuilder<Query>> builder = q -> q.wildcard(wildcardQuery(field, value));
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static Query wrapperQueryAsQuery(String query) {
+
+		Function<Query.Builder, ObjectBuilder<Query>> builder = q -> q.wrapper(wrapperQuery(query));
+
+		return builder.apply(new Query.Builder()).build();
+	}
+
+	public static WrapperQuery wrapperQuery(String query) {
+
+		Assert.notNull(query, "query must not be null");
+
+		String encodedValue = Base64.getEncoder().encodeToString(query.getBytes(StandardCharsets.UTF_8));
+
+		return WrapperQuery.of(wq -> wq.query(encodedValue));
+	}
+
+	public static LatLonGeoLocation latLon(GeoPoint geoPoint) {
+
+		Assert.notNull(geoPoint, "geoPoint must not be null");
+
+		return latLon(geoPoint.getLat(), geoPoint.getLon());
+	}
+
+	public static LatLonGeoLocation latLon(double lat, double lon) {
+		return LatLonGeoLocation.of(_0 -> _0.lat(lat).lon(lon));
+	}
+
+	public static org.springframework.data.elasticsearch.core.query.Query getTermsAggsQuery(String aggsName,
+			String aggsField) {
+		return NativeQuery.builder() //
+				.withQuery(Queries.matchAllQueryAsQuery()) //
+				.withAggregation(aggsName, Aggregation.of(a -> a //
+						.terms(ta -> ta.field(aggsField)))) //
+				.withMaxResults(0) //
+				.build();
+	}
+
+	public static org.springframework.data.elasticsearch.core.query.Query queryWithIds(String... ids) {
+		return NativeQuery.builder().withIds(ids).build();
+	}
+
+	public static BaseQueryBuilder<?, ?> getBuilderWithMatchAllQuery() {
+		return NativeQuery.builder().withQuery(matchAllQueryAsQuery());
+	}
+
+	public static BaseQueryBuilder<?, ?> getBuilderWithTermQuery(String field, String value) {
+		return NativeQuery.builder().withQuery(termQueryAsQuery(field, value));
+	}
+}

src/main/java/org/springframework/data/elasticsearch/client/elc/QueryBuilders.java

@@ -42,7 +42,9 @@ import org.springframework.util.Assert;
  *
  * @author Peter-Josef Meisch
  * @since 4.4
+ * @deprecated since 5.1, use {@link Queries} instead.
  */
+@Deprecated(forRemoval = true)
 public final class QueryBuilders {
 
 	private QueryBuilders() {}
@@ -62,6 +64,7 @@ public final class QueryBuilders {
 
 		return builder.apply(new Query.Builder()).build();
 	}
+
 	public static MatchQuery matchQuery(String fieldName, String query, @Nullable Operator operator,
 			@Nullable Float boost) {
 

src/main/java/org/springframework/data/elasticsearch/client/elc/ReactiveElasticsearchTemplate.java

@@ -571,12 +571,12 @@ public class ReactiveElasticsearchTemplate extends AbstractReactiveElasticsearch
 
 	@Override
 	public Query matchAllQuery() {
-		return NativeQuery.builder().withQuery(QueryBuilders.matchAllQueryAsQuery()).build();
+		return NativeQuery.builder().withQuery(Queries.matchAllQueryAsQuery()).build();
 	}
 
 	@Override
 	public Query idsQuery(List<String> ids) {
-		return NativeQuery.builder().withQuery(QueryBuilders.idsQueryAsQuery(ids)).build();
+		return NativeQuery.builder().withQuery(Queries.idsQueryAsQuery(ids)).build();
 	}
 
 	/**

src/main/java/org/springframework/data/elasticsearch/client/elc/RequestConverter.java

@@ -1355,7 +1355,7 @@ class RequestConverter {
 				return SortOptions.of(so -> so //
 						.geoDistance(gd -> gd //
 								.field(fieldName) //
-								.location(loc -> loc.latlon(QueryBuilders.latLon(geoDistanceOrder.getGeoPoint())))//
+								.location(loc -> loc.latlon(Queries.latLon(geoDistanceOrder.getGeoPoint())))//
 								.distanceType(TypeUtils.geoDistanceType(geoDistanceOrder.getDistanceType()))
 								.mode(TypeUtils.sortMode(finalMode)) //
 								.unit(TypeUtils.distanceUnit(geoDistanceOrder.getUnit())) //
@@ -1443,7 +1443,7 @@ class RequestConverter {
 		if (query instanceof CriteriaQuery) {
 			esQuery = CriteriaQueryProcessor.createQuery(((CriteriaQuery) query).getCriteria());
 		} else if (query instanceof StringQuery) {
-			esQuery = QueryBuilders.wrapperQueryAsQuery(((StringQuery) query).getSource());
+			esQuery = Queries.wrapperQueryAsQuery(((StringQuery) query).getSource());
 		} else if (query instanceof NativeQuery nativeQuery) {
 
 			if (nativeQuery.getQuery() != null) {

src/test/java/org/springframework/data/elasticsearch/ELCQueries.java

@@ -15,12 +15,12 @@
  */
 package org.springframework.data.elasticsearch;
 
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 
 import co.elastic.clients.elasticsearch._types.aggregations.Aggregation;
 
 import org.springframework.data.elasticsearch.client.elc.NativeQuery;
-import org.springframework.data.elasticsearch.client.elc.QueryBuilders;
+import org.springframework.data.elasticsearch.client.elc.Queries;
 import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.Query;
 
@@ -29,14 +29,16 @@ import org.springframework.data.elasticsearch.core.query.Query;
  *
  * @author Peter-Josef Meisch
  * @since 4.4
+ * @deprecated since 5.1, use the corresponding methods from {@link Queries}.
  */
+@Deprecated(forRemoval = true)
 public final class ELCQueries {
 
 	private ELCQueries() {}
 
-	public static Query getTermsAggsQuery(String aggsName, String aggsField){
+	public static Query getTermsAggsQuery(String aggsName, String aggsField) {
 		return NativeQuery.builder() //
-				.withQuery(QueryBuilders.matchAllQueryAsQuery()) //
+				.withQuery(Queries.matchAllQueryAsQuery()) //
 				.withAggregation(aggsName, Aggregation.of(a -> a //
 						.terms(ta -> ta.field(aggsField)))) //
 				.withMaxResults(0) //

src/test/java/org/springframework/data/elasticsearch/NestedObjectELCIntegrationTests.java

@@ -16,7 +16,7 @@
 package org.springframework.data.elasticsearch;
 
 import static co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders.*;
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 
 import co.elastic.clients.elasticsearch._types.query_dsl.ChildScoreMode;
 

src/test/java/org/springframework/data/elasticsearch/core/ElasticsearchELCIntegrationTests.java

@@ -16,7 +16,7 @@
 package org.springframework.data.elasticsearch.core;
 
 import static org.assertj.core.api.Assertions.*;
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 import static org.springframework.data.elasticsearch.utils.IndexBuilder.*;
 
 import co.elastic.clients.elasticsearch._types.SortOrder;
@@ -35,9 +35,9 @@ import org.junit.jupiter.api.Test;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.data.elasticsearch.ELCQueries;
 import org.springframework.data.elasticsearch.client.elc.NativeQuery;
 import org.springframework.data.elasticsearch.client.elc.NativeQueryBuilder;
+import org.springframework.data.elasticsearch.client.elc.Queries;
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
 import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.FetchSourceFilterBuilder;
@@ -93,7 +93,7 @@ public class ElasticsearchELCIntegrationTests extends ElasticsearchIntegrationTe
 
 	@Override
 	protected Query queryWithIds(String... ids) {
-		return ELCQueries.queryWithIds(ids);
+		return Queries.queryWithIds(ids);
 	}
 
 	@Override
@@ -103,7 +103,7 @@ public class ElasticsearchELCIntegrationTests extends ElasticsearchIntegrationTe
 
 	@Override
 	protected BaseQueryBuilder<?, ?> getBuilderWithMatchAllQuery() {
-		return ELCQueries.getBuilderWithMatchAllQuery();
+		return Queries.getBuilderWithMatchAllQuery();
 	}
 
 	@Override

src/test/java/org/springframework/data/elasticsearch/core/ReactiveElasticsearchELCIntegrationTests.java

@@ -16,7 +16,7 @@
 package org.springframework.data.elasticsearch.core;
 
 import static org.assertj.core.api.Assertions.*;
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 
 import co.elastic.clients.elasticsearch._types.aggregations.Aggregate;
 import co.elastic.clients.elasticsearch._types.aggregations.Buckets;
@@ -30,10 +30,10 @@ import java.util.concurrent.atomic.AtomicInteger;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.data.elasticsearch.ELCQueries;
 import org.springframework.data.elasticsearch.client.elc.Aggregation;
 import org.springframework.data.elasticsearch.client.elc.ElasticsearchAggregation;
 import org.springframework.data.elasticsearch.client.elc.NativeQuery;
+import org.springframework.data.elasticsearch.client.elc.Queries;
 import org.springframework.data.elasticsearch.core.query.BaseQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.junit.jupiter.ReactiveElasticsearchTemplateConfiguration;
@@ -59,17 +59,17 @@ public class ReactiveElasticsearchELCIntegrationTests extends ReactiveElasticsea
 
 	@Override
 	protected Query getTermsAggsQuery(String aggsName, String aggsField) {
-		return ELCQueries.getTermsAggsQuery(aggsName, aggsField);
+		return Queries.getTermsAggsQuery(aggsName, aggsField);
 	}
 
 	@Override
 	protected BaseQueryBuilder<?, ?> getBuilderWithMatchAllQuery() {
-		return ELCQueries.getBuilderWithMatchAllQuery();
+		return Queries.getBuilderWithMatchAllQuery();
 	}
 
 	@Override
 	protected BaseQueryBuilder<?, ?> getBuilderWithTermQuery(String field, String value) {
-		return ELCQueries.getBuilderWithTermQuery(field, value);
+		return Queries.getBuilderWithTermQuery(field, value);
 	}
 
 	@Override
@@ -88,7 +88,7 @@ public class ReactiveElasticsearchELCIntegrationTests extends ReactiveElasticsea
 
 	@Override
 	protected Query queryWithIds(String... ids) {
-		return ELCQueries.queryWithIds(ids);
+		return Queries.queryWithIds(ids);
 	}
 
 	@Override

src/test/java/org/springframework/data/elasticsearch/core/ReindexELCIntegrationTests.java

@@ -15,7 +15,7 @@
  */
 package org.springframework.data.elasticsearch.core;
 
-import static org.springframework.data.elasticsearch.client.elc.QueryBuilders.*;
+import static org.springframework.data.elasticsearch.client.elc.Queries.*;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

src/test/java/org/springframework/data/elasticsearch/core/aggregation/AggregationELCIntegrationTests.java

@@ -28,11 +28,10 @@ import java.util.stream.Collectors;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.data.elasticsearch.ELCQueries;
 import org.springframework.data.elasticsearch.client.elc.ElasticsearchAggregation;
 import org.springframework.data.elasticsearch.client.elc.ElasticsearchAggregations;
 import org.springframework.data.elasticsearch.client.elc.NativeQuery;
-import org.springframework.data.elasticsearch.client.elc.QueryBuilders;
+import org.springframework.data.elasticsearch.client.elc.Queries;
 import org.springframework.data.elasticsearch.core.AggregationsContainer;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.junit.jupiter.ElasticsearchTemplateConfiguration;
@@ -59,7 +58,7 @@ public class AggregationELCIntegrationTests extends AggregationIntegrationTests
 
 	@Override
 	protected Query getTermsAggsQuery(String aggsName, String aggsField) {
-		return ELCQueries.getTermsAggsQuery(aggsName, aggsField);
+		return Queries.getTermsAggsQuery(aggsName, aggsField);
 	}
 
 	@Override
@@ -75,7 +74,7 @@ public class AggregationELCIntegrationTests extends AggregationIntegrationTests
 	@Override
 	protected Query getPipelineAggsQuery(String aggsName, String aggsField, String aggsNamePipeline, String bucketsPath) {
 		return NativeQuery.builder() //
-				.withQuery(QueryBuilders.matchAllQueryAsQuery()) //
+				.withQuery(Queries.matchAllQueryAsQuery()) //
 				.withAggregation(aggsName, Aggregation.of(a -> a //
 						.terms(ta -> ta.field(aggsField)))) //
 				.withAggregation(aggsNamePipeline, Aggregation.of(a -> a //

src/test/java/org/springframework/data/elasticsearch/core/geo/GeoELCIntegrationTests.java

@@ -19,7 +19,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.data.elasticsearch.client.elc.NativeQuery;
-import org.springframework.data.elasticsearch.client.elc.QueryBuilders;
+import org.springframework.data.elasticsearch.client.elc.Queries;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.junit.jupiter.ElasticsearchTemplateConfiguration;
 import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
@@ -59,9 +59,9 @@ public class GeoELCIntegrationTests extends GeoIntegrationTests {
 								.boundingBox(gb -> gb //
 										.tlbr(tlbr -> tlbr //
 												.topLeft(tl -> tl //
-														.latlon(QueryBuilders.latLon(top, left)))
+														.latlon(Queries.latLon(top, left)))
 												.bottomRight(br -> br //
-														.latlon(QueryBuilders.latLon(bottom, right)))))))
+														.latlon(Queries.latLon(bottom, right)))))))
 				.build();
 	}