DATAES-631 - Consolidate query objects.

Author: sothawo

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

@@ -1,15 +1,23 @@
 package org.springframework.data.elasticsearch.core;
 
+import org.elasticsearch.index.query.QueryBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.data.elasticsearch.ElasticsearchException;
+import org.springframework.data.elasticsearch.annotations.Document;
 import org.springframework.data.elasticsearch.annotations.Mapping;
 import org.springframework.data.elasticsearch.core.convert.ElasticsearchConverter;
 import org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter;
 import org.springframework.data.elasticsearch.core.index.MappingBuilder;
+import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
 import org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchMappingContext;
+import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
+import org.springframework.data.elasticsearch.core.query.DeleteQuery;
+import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
+import static org.springframework.util.StringUtils.*;
+
 /**
  * AbstractElasticsearchTemplate
  *
@@ -21,6 +29,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(
@@ -57,4 +76,20 @@ protected String buildMapping(Class<?> clazz) {
 	public ElasticsearchConverter getElasticsearchConverter() {
 		return elasticsearchConverter;
 	}
+
+	@Override
+	public ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz) {
+		Assert.isTrue(clazz.isAnnotationPresent(Document.class), "Unable to identify index name. " + clazz.getSimpleName()
+				+ " is not a Document. Make sure the document class is annotated with @Document(indexName=\"foo\")");
+		return elasticsearchConverter.getMappingContext().getRequiredPersistentEntity(clazz);
+	}
+
+	@Override
+	public void delete(CriteriaQuery criteriaQuery, IndexCoordinates index) {
+		QueryBuilder elasticsearchQuery = new CriteriaQueryProcessor().createQueryFromCriteria(criteriaQuery.getCriteria());
+		Assert.notNull(elasticsearchQuery, "Query can not be null.");
+		DeleteQuery deleteQuery = new DeleteQuery();
+		deleteQuery.setQuery(elasticsearchQuery);
+		delete(deleteQuery, index);
+	}
 }

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

@@ -44,17 +44,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
@@ -126,17 +128,17 @@ public interface ElasticsearchOperations {
 	 * Get mapping for a class
 	 *
 	 * @param clazz
-	 * @param <T>
 	 */
-	<T> Map<String, Object> getMapping(Class<T> clazz);
+	default Map<String, Object> getMapping(Class<?> clazz) {
+		return getMapping(getIndexCoordinatesFor(clazz));
+	}
 
 	/**
-	 * Get mapping for a given indexName and type
+	 * Get mapping for a given index coordinates
 	 *
-	 * @param indexName
-	 * @param type
+	 * @param index
 	 */
-	Map<String, Object> getMapping(String indexName, String type);
+	Map<String, Object> getMapping(IndexCoordinates index);
 
 	/**
 	 * Get settings for a given indexName
@@ -163,13 +165,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 +181,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 +193,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 +335,23 @@ default List<List<?>> queryForList(List<NativeSearchQuery> queries, List<Class<?
 	/**
 	 * 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(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
-	 */
-	<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
@@ -372,23 +368,23 @@ default List<List<?>> queryForList(List<NativeSearchQuery> queries, List<Class<?
 	 * @param query
 	 * @return returns the document id
 	 */
-	String index(IndexQuery query);
+	String index(IndexQuery query, IndexCoordinates index);
 
 	/**
 	 * Partial update of the document
 	 *
 	 * @param updateQuery
 	 * @return
 	 */
-	UpdateResponse update(UpdateQuery updateQuery);
+	UpdateResponse update(UpdateQuery updateQuery, IndexCoordinates index);
 
 	/**
 	 * Bulk index all objects. Will do save or update.
 	 *
 	 * @param queries the queries to execute in bulk
 	 */
-	default void bulkIndex(List<IndexQuery> queries) {
-		bulkIndex(queries, BulkOptions.defaultOptions());
+	default void bulkIndex(List<IndexQuery> queries, IndexCoordinates index) {
+		bulkIndex(queries, BulkOptions.defaultOptions(), index);
 	}
 
 	/**
@@ -398,15 +394,15 @@ default void bulkIndex(List<IndexQuery> queries) {
 	 * @param bulkOptions options to be added to the bulk request
 	 * @since 3.2
 	 */
-	void bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions);
+	void bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, IndexCoordinates index);
 
 	/**
 	 * Bulk update all objects. Will do update
 	 *
 	 * @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,58 +412,42 @@ 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
+	 * Delete the one object with provided id.
 	 *
-	 * @param indexName
-	 * @param type
-	 * @param id
+	 * @param id the document ot delete
+	 * @param index the index from which to delete
 	 * @return documentId of the document deleted
 	 */
-	String delete(String indexName, String type, String id);
+	String delete(String id, IndexCoordinates index);
 
 	/**
 	 * Delete all records matching the criteria
 	 *
-	 * @param clazz
 	 * @param criteriaQuery
+	 * @param index
 	 */
-	<T> void delete(CriteriaQuery criteriaQuery, Class<T> clazz);
-
-	/**
-	 * Delete the one object with provided id
-	 *
-	 * @param clazz
-	 * @param id
-	 * @return documentId of the document deleted
-	 */
-	<T> String delete(Class<T> clazz, String id);
-
-	/**
-	 * Delete all records matching the query
-	 *
-	 * @param clazz
-	 * @param query
-	 */
-	<T> void delete(DeleteQuery query, Class<T> clazz);
+	void delete(CriteriaQuery criteriaQuery, IndexCoordinates index);
 
 	/**
 	 * Delete all records matching the query
 	 *
 	 * @param query
+	 * @param index the index where to delete the records
 	 */
-	void delete(DeleteQuery query);
+	void delete(DeleteQuery query, IndexCoordinates index);
 
 	/**
 	 * Deletes an index for given entity
 	 *
 	 * @param clazz
-	 * @param <T>
 	 * @return
 	 */
-	<T> boolean deleteIndex(Class<T> clazz);
+	default boolean deleteIndex(Class<?> clazz) {
+		return deleteIndex(getPersistentEntityFor(clazz).getIndexName());
+	}
 
 	/**
 	 * Deletes an index for given indexName
@@ -481,10 +461,11 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	 * check if index is exists
 	 *
 	 * @param clazz
-	 * @param <T>
 	 * @return
 	 */
-	<T> boolean indexExists(Class<T> clazz);
+	default boolean indexExists(Class<?> clazz) {
+		return indexExists(getIndexCoordinatesFor(clazz).getIndexName());
+	}
 
 	/**
 	 * check if index is exists for given IndexName
@@ -495,27 +476,20 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	boolean indexExists(String indexName);
 
 	/**
-	 * check if type is exists in an index
+	 * refresh the index(es)
 	 *
-	 * @param index
-	 * @param type
-	 * @return
+	 * @param indexNames
 	 */
-	boolean typeExists(String index, String type);
-
-	/**
-	 * refresh the index
-	 *
-	 * @param indexName
-	 */
-	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 +538,20 @@ default void bulkUpdate(List<UpdateQuery> queries) {
 	 * @return Converter in use
 	 */
 	ElasticsearchConverter getElasticsearchConverter();
+
+	/**
+	 * @since 4.0
+	 */
+	RequestFactory getRequestFactory();
+
+	/**
+	 * @param clazz
+	 * @return the IndexCoordinates defined on the entity.
+	 * @since 4.0
+	 */
+	default IndexCoordinates getIndexCoordinatesFor(Class<?> clazz) {
+		ElasticsearchPersistentEntity entity = getPersistentEntityFor(clazz);
+		return IndexCoordinates.of(entity.getIndexName(), entity.getIndexType());
+	}
+
 }