DATAES-840 - Introduce IndexCoordinateResolver.

Original PR: spring-projects#467

Author: sothawo

src/main/asciidoc/reference/elasticsearch-migration-guide-4.0-4.1.adoc

@@ -3,8 +3,16 @@
 
 This section describes breaking changes from version 4.0.x to 4.1.x and how removed features can be replaced by new introduced features.
 
+== Deprecations
+
+.Definition of the id property
+It is possible to define a property of en entity as the id property by naming it either `id` or  `document`. This behaviour is now deprecated and  will produce a warning. PLease us the `@Id` annotation to mark a property as being the id property.
+
 [[elasticsearch-migration-guide-4.0-4.1.removal]]
 == Removals
 
+.Type mappings
 The _type mappings_ parameters of the `@Document` annotation and the `IndexCoordinates` object were removed. They had been deprecated in Spring Data Elasticsearch 4.0 and their values weren't used anymore.
 
+=== Breaking changes
+

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

@@ -38,6 +38,7 @@
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
 import org.springframework.data.elasticsearch.core.query.AliasQuery;
 import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
@@ -55,20 +56,24 @@ abstract class AbstractDefaultIndexOperations implements IndexOperations {
 	protected final RequestFactory requestFactory;
 
 	@Nullable protected final Class<?> boundClass;
-	private final IndexCoordinates boundIndex;
+	@Nullable private final IndexCoordinates boundIndex;
 
 	public AbstractDefaultIndexOperations(ElasticsearchConverter elasticsearchConverter, Class<?> boundClass) {
+
+		Assert.notNull(boundClass, "boundClass may not be null");
+
 		this.elasticsearchConverter = elasticsearchConverter;
 		requestFactory = new RequestFactory(elasticsearchConverter);
-
 		this.boundClass = boundClass;
-		this.boundIndex = getIndexCoordinatesFor(boundClass);
+		this.boundIndex = null;
 	}
 
 	public AbstractDefaultIndexOperations(ElasticsearchConverter elasticsearchConverter, IndexCoordinates boundIndex) {
+
+		Assert.notNull(boundIndex, "boundIndex may not be null");
+
 		this.elasticsearchConverter = elasticsearchConverter;
 		requestFactory = new RequestFactory(elasticsearchConverter);
-
 		this.boundClass = null;
 		this.boundIndex = boundIndex;
 	}
@@ -85,48 +90,59 @@ protected Class<?> checkForBoundClass() {
 	@Override
 	public boolean create() {
 
+		IndexCoordinates index;
+		Document settings = null;
+
 		if (boundClass != null) {
 			Class<?> clazz = boundClass;
-			String indexName = getIndexCoordinates().getIndexName();
+			ElasticsearchPersistentEntity<?> persistentEntity = getRequiredPersistentEntity(clazz);
+			index = persistentEntity.getIndexCoordinates();
 
 			if (clazz.isAnnotationPresent(Setting.class)) {
 				String settingPath = clazz.getAnnotation(Setting.class).settingPath();
 
 				if (hasText(settingPath)) {
-					String settings = ResourceUtil.readFileFromClasspath(settingPath);
+					String fileSettings = ResourceUtil.readFileFromClasspath(settingPath);
 
-					if (hasText(settings)) {
-						return doCreate(indexName, Document.parse(settings));
+					if (hasText(fileSettings)) {
+						settings = Document.parse(fileSettings);
 					}
 				} else {
 					LOGGER.info("settingPath in @Setting has to be defined. Using default instead.");
 				}
 			}
-			return doCreate(indexName, getDefaultSettings(getRequiredPersistentEntity(clazz)));
+
+			if (settings == null) {
+				settings = getDefaultSettings(persistentEntity);
+			}
+		} else {
+			index = boundIndex;
 		}
-		return doCreate(getIndexCoordinates().getIndexName(), null);
+
+		// noinspection ConstantConditions
+		return doCreate(index, settings);
 	}
 
 	@Override
 	public boolean create(Document settings) {
-		return doCreate(getIndexCoordinates().getIndexName(), settings);
+		return doCreate(getIndexCoordinates(), settings);
 	}
 
-	protected abstract boolean doCreate(String indexName, @Nullable Document settings);
+	protected abstract boolean doCreate(IndexCoordinates index, @Nullable Document settings);
 
 	@Override
 	public boolean delete() {
-		return doDelete(getIndexCoordinates().getIndexName());
+		return doDelete(getIndexCoordinates());
 	}
 
-	protected abstract boolean doDelete(String indexName);
+	protected abstract boolean doDelete(IndexCoordinates index);
 
 	@Override
 	public boolean exists() {
-		return doExists(getIndexCoordinates().getIndexName());
+		return doExists(getIndexCoordinates());
 	}
 
-	protected abstract boolean doExists(String indexName);
+	protected abstract boolean doExists(IndexCoordinates index);
 
 	@Override
 	public boolean putMapping(Document mapping) {
@@ -149,10 +165,10 @@ public Map<String, Object> getSettings() {
 
 	@Override
 	public Map<String, Object> getSettings(boolean includeDefaults) {
-		return doGetSettings(getIndexCoordinates().getIndexName(), includeDefaults);
+		return doGetSettings(getIndexCoordinates(), includeDefaults);
 	}
 
-	protected abstract Map<String, Object> doGetSettings(String indexName, boolean includeDefaults);
+	protected abstract Map<String, Object> doGetSettings(IndexCoordinates index, boolean includeDefaults);
 
 	@Override
 	public void refresh() {
@@ -170,10 +186,10 @@ public boolean addAlias(AliasQuery query) {
 
 	@Override
 	public List<AliasMetaData> queryForAlias() {
-		return doQueryForAlias(getIndexCoordinates().getIndexName());
+		return doQueryForAlias(getIndexCoordinates());
 	}
 
-	protected abstract List<AliasMetaData> doQueryForAlias(String indexName);
+	protected abstract List<AliasMetaData> doQueryForAlias(IndexCoordinates index);
 
 	@Override
 	public boolean removeAlias(AliasQuery query) {
@@ -238,14 +254,15 @@ ElasticsearchPersistentEntity<?> getRequiredPersistentEntity(Class<?> clazz) {
 		return elasticsearchConverter.getMappingContext().getRequiredPersistentEntity(clazz);
 	}
 
-	/**
-	 * get the current {@link IndexCoordinates}. These may change over time when the entity class has a SpEL constructed
-	 * index name. When this IndexOperations is not bound to a class, the bound IndexCoordinates are returned.
-	 *
-	 * @return IndexCoordinates
-	 */
 	protected IndexCoordinates getIndexCoordinates() {
-		return (boundClass != null) ? getIndexCoordinatesFor(boundClass) : boundIndex;
+
+		if (boundClass != null) {
+			return getIndexCoordinatesFor(boundClass);
+		}
+
+		Assert.notNull(boundIndex, "boundIndex may not be null");
+
+		return boundIndex;
 	}
 
 	public IndexCoordinates getIndexCoordinatesFor(Class<?> clazz) {

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

@@ -32,6 +32,7 @@
 import org.elasticsearch.action.search.SearchResponse;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.index.query.MoreLikeThisQueryBuilder;
+import org.elasticsearch.search.suggest.SuggestBuilder;
 import org.springframework.beans.BeansException;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
@@ -48,13 +49,15 @@
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty;
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
 import org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchMappingContext;
+import org.springframework.data.elasticsearch.core.query.BulkOptions;
 import org.springframework.data.elasticsearch.core.query.GetQuery;
 import org.springframework.data.elasticsearch.core.query.IndexQuery;
 import org.springframework.data.elasticsearch.core.query.IndexQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.MoreLikeThisQuery;
 import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.elasticsearch.core.query.SeqNoPrimaryTerm;
+import org.springframework.data.elasticsearch.core.query.UpdateQuery;
 import org.springframework.data.elasticsearch.support.VersionInfo;
 import org.springframework.data.mapping.callback.EntityCallbacks;
 import org.springframework.data.util.CloseableIterator;
@@ -199,6 +202,11 @@ public <T> T get(GetQuery query, Class<T> clazz, IndexCoordinates index) {
 		return get(query.getId(), clazz, index);
 	}
 
+	@Override
+	public <T> List<T> multiGet(Query query, Class<T> clazz) {
+		return multiGet(query, clazz, getIndexCoordinatesFor(clazz));
+	}
+
 	@Override
 	@Nullable
 	public <T> T queryForObject(GetQuery query, Class<T> clazz) {
@@ -226,6 +234,11 @@ public String delete(String id, Class<?> entityType) {
 		return this.delete(id, getIndexCoordinatesFor(entityType));
 	}
 
+	@Override
+	public void delete(Query query, Class<?> clazz) {
+		delete(query, getIndexCoordinatesFor(clazz));
+	}
+
 	@Override
 	public String delete(Object entity) {
 		return delete(entity, getIndexCoordinatesFor(entity.getClass()));
@@ -235,6 +248,22 @@ public String delete(Object entity) {
 	public String delete(Object entity, IndexCoordinates index) {
 		return this.delete(getEntityId(entity), index);
 	}
+
+	@Override
+	public List<String> bulkIndex(List<IndexQuery> queries, Class<?> clazz) {
+		return bulkIndex(queries, getIndexCoordinatesFor(clazz));
+	}
+
+	@Override
+	public List<String> bulkIndex(List<IndexQuery> queries, BulkOptions bulkOptions, Class<?> clazz) {
+		return bulkIndex(queries, bulkOptions, getIndexCoordinatesFor(clazz));
+	}
+
+	@Override
+	public void bulkUpdate(List<UpdateQuery> queries, Class<?> clazz) {
+		bulkUpdate(queries, getIndexCoordinatesFor(clazz));
+	}
+
 	// endregion
 
 	// region SearchOperations
@@ -282,6 +311,11 @@ public <T> SearchHits<T> search(MoreLikeThisQuery query, Class<T> clazz, IndexCo
 		return search(new NativeSearchQueryBuilder().withQuery(moreLikeThisQueryBuilder).build(), clazz, index);
 	}
 
+	@Override
+	public <T> List<SearchHits<T>> multiSearch(List<? extends Query> queries, Class<T> clazz) {
+		return multiSearch(queries, clazz, getIndexCoordinatesFor(clazz));
+	}
+
 	@Override
 	public <T> List<SearchHits<T>> multiSearch(List<? extends Query> queries, Class<T> clazz, IndexCoordinates index) {
 		MultiSearchRequest request = new MultiSearchRequest();
@@ -300,9 +334,46 @@ public <T> List<SearchHits<T>> multiSearch(List<? extends Query> queries, Class<
 		return res;
 	}
 
+	@Override
+	public List<SearchHits<?>> multiSearch(List<? extends Query> queries, List<Class<?>> classes) {
+
+		Assert.notNull(queries, "queries must not be null");
+		Assert.notNull(classes, "classes must not be null");
+		Assert.isTrue(queries.size() == classes.size(), "queries and classes must have the same size");
+
+		MultiSearchRequest request = new MultiSearchRequest();
+		Iterator<Class<?>> it = classes.iterator();
+		for (Query query : queries) {
+			Class<?> clazz = it.next();
+			request.add(requestFactory.searchRequest(query, clazz, getIndexCoordinatesFor(clazz)));
+		}
+
+		MultiSearchResponse.Item[] items = getMultiSearchResult(request);
+
+		List<SearchHits<?>> res = new ArrayList<>(queries.size());
+		int c = 0;
+		Iterator<Class<?>> it1 = classes.iterator();
+		for (Query query : queries) {
+			Class entityClass = it1.next();
+
+			SearchDocumentResponseCallback<SearchHits<?>> callback = new ReadSearchDocumentResponseCallback<>(entityClass,
+					getIndexCoordinatesFor(entityClass));
+
+			SearchResponse response = items[c++].getResponse();
+			res.add(callback.doWith(SearchDocumentResponse.from(response)));
+		}
+		return res;
+	}
+
 	@Override
 	public List<SearchHits<?>> multiSearch(List<? extends Query> queries, List<Class<?>> classes,
 			IndexCoordinates index) {
+
+		Assert.notNull(queries, "queries must not be null");
+		Assert.notNull(classes, "classes must not be null");
+		Assert.notNull(index, "index must not be null");
+		Assert.isTrue(queries.size() == classes.size(), "queries and classes must have the same size");
+
 		MultiSearchRequest request = new MultiSearchRequest();
 		Iterator<Class<?>> it = classes.iterator();
 		for (Query query : queries) {
@@ -356,6 +427,12 @@ protected void searchScrollClear(String scrollId) {
 	abstract protected void searchScrollClear(List<String> scrollIds);
 
 	abstract protected MultiSearchResponse.Item[] getMultiSearchResult(MultiSearchRequest request);
+
+	@Override
+	public SearchResponse suggest(SuggestBuilder suggestion, Class<?> clazz) {
+		return suggest(suggestion, getIndexCoordinatesFor(clazz));
+	}
+
 	// endregion
 
 	// region Helper methods