DATAES-631 - Consolidate query objects.

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/core/AbstractElasticsearchTemplate.java

@@ -8,6 +8,7 @@
 import org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter;
 import org.springframework.data.elasticsearch.core.index.MappingBuilder;
 import org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchMappingContext;
+import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
@@ -21,6 +22,17 @@ public abstract class AbstractElasticsearchTemplate implements ElasticsearchOper
 	private static final Logger LOGGER = LoggerFactory.getLogger(AbstractElasticsearchTemplate.class);
 
 	protected ElasticsearchConverter elasticsearchConverter;
+	protected RequestFactory requestFactory;
+
+	public RequestFactory getRequestFactory() {
+		return requestFactory;
+	}
+
+	protected void initialize(ElasticsearchConverter elasticsearchConverter) {
+		Assert.notNull(elasticsearchConverter, "elasticsearchConverter must not be null.");
+		this.elasticsearchConverter = elasticsearchConverter;
+		this.requestFactory = new RequestFactory(elasticsearchConverter);
+	}
 
 	protected ElasticsearchConverter createElasticsearchConverter() {
 		MappingElasticsearchConverter mappingElasticsearchConverter = new MappingElasticsearchConverter(

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchOperations.java

@@ -27,6 +27,7 @@
 import org.springframework.data.elasticsearch.core.query.*;
 import org.springframework.data.util.CloseableIterator;
 import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
 
 /**
  * ElasticsearchOperations
@@ -44,17 +45,19 @@ public interface ElasticsearchOperations {
 	 * adding new alias
 	 *
 	 * @param query
+	 * @param index
 	 * @return
 	 */
-	boolean addAlias(AliasQuery query);
+	boolean addAlias(AliasQuery query, IndexCoordinates index);
 
 	/**
 	 * removing previously created alias
 	 *
 	 * @param query
+	 * @param index
 	 * @return
 	 */
-	boolean removeAlias(AliasQuery query);
+	boolean removeAlias(AliasQuery query, IndexCoordinates index);
 
 	/**
 	 * Create an index for a class
@@ -163,13 +166,14 @@ public interface ElasticsearchOperations {
 	<T> T query(NativeSearchQuery query, ResultsExtractor<T> resultsExtractor);
 
 	/**
-	 * Execute the query against elasticsearch and return the first returned object
+	 * Retrieves an object from an index
 	 *
-	 * @param query
-	 * @param clazz
-	 * @return the first matching object
+	 * @param query the query defining the id of the object to get
+	 * @param clazz the type of the object to be returned
+	 * @param index the index from which the object is read.
+	 * @return the found object
 	 */
-	<T> T queryForObject(GetQuery query, Class<T> clazz);
+	<T> T get(GetQuery query, Class<T> clazz, IndexCoordinates index);
 
 	/**
 	 * Execute the query against elasticsearch and return the first returned object
@@ -178,7 +182,10 @@ public interface ElasticsearchOperations {
 	 * @param clazz
 	 * @return the first matching object
 	 */
-	<T> T queryForObject(CriteriaQuery query, Class<T> clazz);
+	default <T> T queryForObject(CriteriaQuery query, Class<T> clazz){
+		List<T> content = queryForPage(query, clazz).getContent();
+		return content.isEmpty() ? null : content.get(0);
+	}
 
 	/**
 	 * Execute the query against elasticsearch and return the first returned object
@@ -187,7 +194,10 @@ public interface ElasticsearchOperations {
 	 * @param clazz
 	 * @return the first matching object
 	 */
-	<T> T queryForObject(StringQuery query, Class<T> clazz);
+	default <T> T queryForObject(StringQuery query, Class<T> clazz) {
+		List<T> content = queryForPage(query, clazz).getContent();
+		return content.isEmpty() ? null : content.get(0);
+	}
 
 	/**
 	 * Execute the query against elasticsearch and return result as {@link Page}
@@ -326,36 +336,23 @@ default List<List<?>> queryForList(List<NativeSearchQuery> queries, List<Class<?
 	/**
 	 * return number of elements found by given query
 	 *
-	 * @param query
-	 * @param clazz
-	 * @return
-	 */
-	<T> long count(CriteriaQuery query, Class<T> clazz);
-
-	/**
-	 * return number of elements found by given query
-	 *
-	 * @param query
-	 * @return
-	 */
-	<T> long count(CriteriaQuery query);
-
-	/**
-	 * return number of elements found by given query
-	 *
-	 * @param query
-	 * @param clazz
-	 * @return
+	 * @param query the query to execute
+	 * @param index the index to run the query against
+	 * @return count
 	 */
-	<T> long count(NativeSearchQuery query, Class<T> clazz);
+	default <T> long count(Query query, IndexCoordinates index) {
+		return count(query, null, index);
+	}
 
 	/**
 	 * return number of elements found by given query
 	 *
-	 * @param query
-	 * @return
+	 * @param query the query to execute
+	 * @param clazz the entity clazz used for property mapping
+	 * @param index the index to run the query against
+	 * @return count
 	 */
-	<T> long count(NativeSearchQuery query);
+	long count(Query query, @Nullable Class<?> clazz, IndexCoordinates index);
 
 	/**
 	 * Execute a multiGet against elasticsearch for the given ids
@@ -380,7 +377,7 @@ default List<List<?>> queryForList(List<NativeSearchQuery> queries, List<Class<?
 	 * @param updateQuery
 	 * @return
 	 */
-	UpdateResponse update(UpdateQuery updateQuery);
+	UpdateResponse update(UpdateQuery updateQuery, IndexCoordinates index);
 
 	/**
 	 * Bulk index all objects. Will do save or update.
@@ -405,8 +402,8 @@ default void bulkIndex(List<IndexQuery> queries) {
 	 *
 	 * @param queries the queries to execute in bulk
 	 */
-	default void bulkUpdate(List<UpdateQuery> queries) {
-		bulkUpdate(queries, BulkOptions.defaultOptions());
+	default void bulkUpdate(List<UpdateQuery> queries, IndexCoordinates index) {
+		bulkUpdate(queries, BulkOptions.defaultOptions(), index);
 	}
 
 	/**
@@ -416,7 +413,7 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	 * @param bulkOptions options to be added to the bulk request
 	 * @since 3.2
 	 */
-	void bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions);
+	void bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index);
 
 	/**
 	 * Delete the one object with provided id
@@ -504,18 +501,20 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	boolean typeExists(String index, String type);
 
 	/**
-	 * refresh the index
+	 * refresh the index(es)
 	 *
-	 * @param indexName
+	 * @param indexNames
 	 */
-	void refresh(String indexName);
+	void refresh(String... indexNames);
 
 	/**
 	 * refresh the index
 	 *
 	 * @param clazz
 	 */
-	<T> void refresh(Class<T> clazz);
+	default <T> void refresh(Class<T> clazz) {
+		refresh(getIndexCoordinatesFor(clazz).getIndexNames());
+	}
 
 	/**
 	 * Returns scrolled page for given query
@@ -564,4 +563,15 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	 * @return Converter in use
 	 */
 	ElasticsearchConverter getElasticsearchConverter();
+
+	/**
+	 * @since 4.0
+	 */
+	RequestFactory getRequestFactory();
+
+	default IndexCoordinates getIndexCoordinatesFor(Class<?> clazz) {
+		ElasticsearchPersistentEntity entity = getPersistentEntityFor(clazz);
+		return IndexCoordinates.of(entity.getIndexName(), entity.getIndexType());
+	}
+
 }