fixup! DATAES-462 - add support for mapping max score and document scores

Author: xhaggi

src/main/java/org/springframework/data/elasticsearch/annotations/Score.java

@@ -0,0 +1,20 @@
+package org.springframework.data.elasticsearch.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Specifies that this field is used for storing the document score.
+ * 
+ * @author Sascha Woo
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+@Documented
+@Inherited
+public @interface Score {
+}

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

@@ -17,6 +17,7 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.lang.reflect.Field;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -33,12 +34,14 @@
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.elasticsearch.ElasticsearchException;
 import org.springframework.data.elasticsearch.annotations.Document;
+import org.springframework.data.elasticsearch.annotations.Score;
 import org.springframework.data.elasticsearch.annotations.ScriptedField;
 import org.springframework.data.elasticsearch.core.aggregation.AggregatedPage;
 import org.springframework.data.elasticsearch.core.aggregation.impl.AggregatedPageImpl;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty;
 import org.springframework.data.mapping.context.MappingContext;
+import org.springframework.data.util.ReflectionUtils;
 import org.springframework.util.Assert;
 
 import com.fasterxml.jackson.core.JsonEncoding;
@@ -63,7 +66,8 @@ public DefaultResultMapper() {
 		super(new DefaultEntityMapper());
 	}
 
-	public DefaultResultMapper(MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext) {
+	public DefaultResultMapper(
+			MappingContext<? extends ElasticsearchPersistentEntity<?>, ElasticsearchPersistentProperty> mappingContext) {
 		super(new DefaultEntityMapper());
 		this.mappingContext = mappingContext;
 	}
@@ -81,6 +85,8 @@ public DefaultResultMapper(
 
 	@Override
 	public <T> AggregatedPage<T> mapResults(SearchResponse response, Class<T> clazz, Pageable pageable) {
+		Field scoreField = ReflectionUtils.findField(clazz, f -> f.getAnnotation(Score.class) != null);
+
 		long totalHits = response.getHits().getTotalHits();
 		float maxScore = response.getHits().getMaxScore();
 
@@ -94,8 +100,9 @@ public <T> AggregatedPage<T> mapResults(SearchResponse response, Class<T> clazz,
 					result = mapEntity(hit.getFields().values(), clazz);
 				}
 
-				if (result instanceof ScoredEntity) {
-					((ScoredEntity) result).setScore(hit.getScore());
+				// set score to field annotated with @Score
+				if (scoreField != null) {
+					ReflectionUtils.setField(scoreField, result, hit.getScore());
 				}
 
 				setPersistentEntityId(result, hit.getId(), clazz);
@@ -121,8 +128,8 @@ private <T> void populateScriptFields(T result, SearchHit hit) {
 						try {
 							field.set(result, searchHitField.getValue());
 						} catch (IllegalArgumentException e) {
-							throw new ElasticsearchException("failed to set scripted field: " + name + " with value: "
-									+ searchHitField.getValue(), e);
+							throw new ElasticsearchException(
+									"failed to set scripted field: " + name + " with value: " + searchHitField.getValue(), e);
 						} catch (IllegalAccessException e) {
 							throw new ElasticsearchException("failed to access scripted field: " + name, e);
 						}

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

@@ -4,6 +4,9 @@
 import org.springframework.data.domain.Page;
 
 /**
+ * A score-aware page gaining information about max score.
+ * 
+ * @param <T>
  * @author Sascha Woo
  */
 public interface ScoredPage<T> extends Page<T> {

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

@@ -1536,8 +1536,8 @@ public void shouldReturnScores() {
 		AggregatedPage<SampleEntity> page = elasticsearchTemplate.queryForPage(searchQuery, SampleEntity.class);
 
 		// then
-		assertThat(page.getMaxScore(), is(not(Float.NaN)));
-		assertThat(page.getContent().get(0).getScore(), is(not(Float.NaN)));
+		assertThat(page.getMaxScore(), greaterThan(0f));
+		assertThat(page.getContent().get(0).getScore(), greaterThan(0f));
 	}
 
 	@Test

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

@@ -15,26 +15,24 @@
  */
 package org.springframework.data.elasticsearch.entities;
 
-import java.lang.Double;
-import java.lang.Long;
-import java.lang.Object;
+import static org.springframework.data.elasticsearch.annotations.FieldType.*;
+
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.ToString;
+
 import org.springframework.data.annotation.Id;
 import org.springframework.data.annotation.Transient;
 import org.springframework.data.annotation.Version;
 import org.springframework.data.elasticsearch.annotations.Document;
 import org.springframework.data.elasticsearch.annotations.Field;
+import org.springframework.data.elasticsearch.annotations.Score;
 import org.springframework.data.elasticsearch.annotations.ScriptedField;
-import org.springframework.data.elasticsearch.core.ScoredEntity;
 import org.springframework.data.elasticsearch.core.geo.GeoPoint;
 
-import static org.springframework.data.elasticsearch.annotations.FieldType.*;
-
 /**
  * @author Rizwan Idrees
  * @author Mohsin Husen
@@ -48,7 +46,7 @@
 @ToString
 @Builder
 @Document(indexName = "test-index-sample", type = "test-type", shards = 1, replicas = 0, refreshInterval = "-1")
-public class SampleEntity implements ScoredEntity {
+public class SampleEntity {
 
 	@Id
 	private String id;
@@ -64,6 +62,7 @@ public class SampleEntity implements ScoredEntity {
 	private GeoPoint location;
 	@Version
 	private Long version;
+	@Score
 	@Transient
 	private float score;