DATAES-462 - add query builder option to track scores

Author: xhaggi

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

@@ -991,7 +991,8 @@ private SearchRequestBuilder prepareSearch(Query query) {
 		SearchRequestBuilder searchRequestBuilder = client.prepareSearch(toArray(query.getIndices()))
 				.setSearchType(query.getSearchType())
 				.setTypes(toArray(query.getTypes()))
-				.setVersion(true);
+				.setVersion(true)
+				.setTrackScores(query.getTrackScores());
 
 		if (query.getSourceFilter() != null) {
 			SourceFilter sourceFilter = query.getSourceFilter();

src/main/java/org/springframework/data/elasticsearch/core/query/AbstractQuery.java

@@ -15,10 +15,12 @@
  */
 package org.springframework.data.elasticsearch.core.query;
 
-import static java.util.Collections.addAll;
+import static java.util.Collections.*;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+
 import org.elasticsearch.action.search.SearchType;
 import org.elasticsearch.action.support.IndicesOptions;
 import org.springframework.data.domain.Pageable;
@@ -32,6 +34,7 @@
  * @author Mohsin Husen
  * @author Mark Paluch
  * @author Alen Turkovic
+ * @author Sascha Woo
  */
 abstract class AbstractQuery implements Query {
 
@@ -46,6 +49,7 @@ abstract class AbstractQuery implements Query {
 	protected String route;
 	protected SearchType searchType = SearchType.DFS_QUERY_THEN_FETCH;
 	protected IndicesOptions indicesOptions;
+	protected boolean trackScores;
 
 	@Override
 	public Sort getSort() {
@@ -160,4 +164,13 @@ public IndicesOptions getIndicesOptions() {
 	public void setIndicesOptions(IndicesOptions indicesOptions) {
 		this.indicesOptions = indicesOptions;
 	}
+
+	@Override
+	public boolean getTrackScores() {
+		return trackScores;
+	}
+
+	public void setTrackScores(boolean trackScores) {
+		this.trackScores = trackScores;
+	}
 }

src/main/java/org/springframework/data/elasticsearch/core/query/NativeSearchQueryBuilder.java

@@ -36,12 +36,13 @@
  * @author Artur Konczak
  * @author Mark Paluch
  * @author Alen Turkovic
+ * @author Sascha Woo
  */
 public class NativeSearchQueryBuilder {
 
 	private QueryBuilder queryBuilder;
 	private QueryBuilder filterBuilder;
-    private List<ScriptField> scriptFields = new ArrayList<>();
+	private List<ScriptField> scriptFields = new ArrayList<>();
 	private List<SortBuilder> sortBuilders = new ArrayList<>();
 	private List<FacetRequest> facetRequests = new ArrayList<>();
 	private List<AbstractAggregationBuilder> aggregationBuilders = new ArrayList<>();
@@ -53,6 +54,7 @@ public class NativeSearchQueryBuilder {
 	private SourceFilter sourceFilter;
 	private List<IndexBoost> indicesBoost;
 	private float minScore;
+	private boolean trackScores;
 	private Collection<String> ids;
 	private String route;
 	private SearchType searchType;
@@ -73,10 +75,10 @@ public NativeSearchQueryBuilder withSort(SortBuilder sortBuilder) {
 		return this;
 	}
 
-    public NativeSearchQueryBuilder withScriptField(ScriptField scriptField) {
-        this.scriptFields.add(scriptField);
-        return this;
-    }
+	public NativeSearchQueryBuilder withScriptField(ScriptField scriptField) {
+		this.scriptFields.add(scriptField);
+		return this;
+	}
 
 	public NativeSearchQueryBuilder addAggregation(AbstractAggregationBuilder aggregationBuilder) {
 		this.aggregationBuilders.add(aggregationBuilder);
@@ -119,15 +121,20 @@ public NativeSearchQueryBuilder withFields(String... fields) {
 	}
 
 	public NativeSearchQueryBuilder withSourceFilter(SourceFilter sourceFilter) {
-				this.sourceFilter = sourceFilter;
-				return this;
+		this.sourceFilter = sourceFilter;
+		return this;
 	}
 
 	public NativeSearchQueryBuilder withMinScore(float minScore) {
 		this.minScore = minScore;
 		return this;
 	}
 
+	public NativeSearchQueryBuilder withTrackScores(boolean trackScores) {
+		this.trackScores = trackScores;
+		return this;
+	}
+
 	public NativeSearchQueryBuilder withIds(Collection<String> ids) {
 		this.ids = ids;
 		return this;
@@ -149,8 +156,11 @@ public NativeSearchQueryBuilder withIndicesOptions(IndicesOptions indicesOptions
 	}
 
 	public NativeSearchQuery build() {
-		NativeSearchQuery nativeSearchQuery = new NativeSearchQuery(queryBuilder, filterBuilder, sortBuilders, highlightFields);
+		NativeSearchQuery nativeSearchQuery = new NativeSearchQuery(queryBuilder, filterBuilder, sortBuilders,
+				highlightFields);
+
 		nativeSearchQuery.setPageable(pageable);
+		nativeSearchQuery.setTrackScores(trackScores);
 
 		if (indices != null) {
 			nativeSearchQuery.addIndices(indices);
@@ -168,13 +178,13 @@ public NativeSearchQuery build() {
 			nativeSearchQuery.addSourceFilter(sourceFilter);
 		}
 
-		if(indicesBoost != null) {
-		    nativeSearchQuery.setIndicesBoost(indicesBoost);
+		if (indicesBoost != null) {
+			nativeSearchQuery.setIndicesBoost(indicesBoost);
 		}
 
-        if (!isEmpty(scriptFields)) {
-            nativeSearchQuery.setScriptFields(scriptFields);
-        }
+		if (!isEmpty(scriptFields)) {
+			nativeSearchQuery.setScriptFields(scriptFields);
+		}
 
 		if (!isEmpty(facetRequests)) {
 			nativeSearchQuery.setFacets(facetRequests);

src/main/java/org/springframework/data/elasticsearch/core/query/Query.java

@@ -30,6 +30,7 @@
  * @author Mohsin Husen
  * @author Mark Paluch
  * @author Alen Turkovic
+ * @author Sascha Woo
  */
 public interface Query {
 
@@ -114,8 +115,7 @@ public interface Query {
 	void addSourceFilter(SourceFilter sourceFilter);
 
 	/**
-	 * Get SourceFilter to be returned to get include and exclude source
-	 * fields as part of search request.
+	 * Get SourceFilter to be returned to get include and exclude source fields as part of search request.
 	 *
 	 * @return SourceFilter
 	 */
@@ -128,6 +128,13 @@ public interface Query {
 	 */
 	float getMinScore();
 
+	/**
+	 * Get if scores will be computed and tracked, regardless of whether sorting on a field. Defaults to <tt>false</tt>.
+	 * 
+	 * @return
+	 */
+	boolean getTrackScores();
+
 	/**
 	 * Get Ids
 	 *
@@ -142,7 +149,6 @@ public interface Query {
 	 */
 	String getRoute();
 
-
 	/**
 	 * Type of search
 	 *