DATAMONGO-973 - Add support for deriving full-text queries.

Added support to execute full-text queries on repositories. Query methods now can have a parameter of type TextCriteria which will be triggering a text search clause for the property annotated with @testscore.

Retrieving document score and sorting by score is only possible if the entity holds a property annotated with @TextScore. If present, any find execution will be enriched so that it asserts loading of the according { $meta : textScore } field. The sort object will only be mapped in case the existing sort property already exists - in that case we replace the existing expression for the property with its $meta representation.

This allows for example the following:

TextCriteria criteria = TextCriteria.forDefaultLanguage().matching("term");

repository.findAllBy(criteria, new Sort("score"));
repository.findAllBy(criteria, new PageRequest(0, 10, Direction.DESC, "score"));
repository.findByFooOrderByScoreDesc("foo", criteria);

For more details and examples see the "Full text search queries" section in the reference manual.

Author: christophstrobl

spring-data-mongodb/Spring Data MongoDB.sonargraph

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<context version="7.1.9.205">
+<context version="7.1.10.209">
     <scope type="Project" name="spring-data-mongodb">
         <element type="TypeFilterReferenceOverridden" name="Filter">
             <element type="IncludeTypePattern" name="org.springframework.data.mongodb.**"/>
@@ -32,6 +32,7 @@
                         <element type="IncludeTypePattern" name="**.config.**"/>
                     </element>
                     <dependency toName="Project|spring-data-mongodb::Layer|Core::Subsystem|Mapping" type="AllowedDependency"/>
+                    <dependency toName="Project|spring-data-mongodb::Layer|Repositories::Subsystem|API" type="AllowedDependency"/>
                     <dependency toName="Project|spring-data-mongodb::Layer|Repositories::Subsystem|Implementation" type="AllowedDependency"/>
                 </element>
                 <dependency toName="Project|spring-data-mongodb::Layer|Config" type="AllowedDependency"/>

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java

@@ -1616,7 +1616,8 @@ protected <S, T> List<T> doFind(String collectionName, DBObject query, DBObject
 			CursorPreparer preparer, DbObjectCallback<T> objectCallback) {
 
 		MongoPersistentEntity<?> entity = mappingContext.getPersistentEntity(entityClass);
-		DBObject mappedFields = fields == null ? null : queryMapper.getMappedObject(fields, entity);
+
+		DBObject mappedFields = queryMapper.getMappedFields(fields, entity);
 		DBObject mappedQuery = queryMapper.getMappedObject(query, entity);
 
 		if (LOGGER.isDebugEnabled()) {
@@ -1969,8 +1970,7 @@ private DBObject getMappedSortObject(Query query, Class<?> type) {
 			return null;
 		}
 
-		MongoPersistentEntity<?> entity = mappingContext.getPersistentEntity(type);
-		return queryMapper.getMappedObject(query.getSortObject(), entity);
+		return queryMapper.getMappedSort(query.getSortObject(), mappingContext.getPersistentEntity(type));
 	}
 
 	// Callback implementations
@@ -2030,7 +2030,7 @@ public FindCallback(DBObject query, DBObject fields) {
 		}
 
 		public DBCursor doInCollection(DBCollection collection) throws MongoException, DataAccessException {
-			if (fields == null) {
+			if (fields == null || fields.toMap().isEmpty()) {
 				return collection.find(query);
 			} else {
 				return collection.find(query, fields);

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/CustomConversions.java

@@ -45,6 +45,7 @@
 import org.springframework.data.mongodb.core.convert.MongoConverters.StringToBigDecimalConverter;
 import org.springframework.data.mongodb.core.convert.MongoConverters.StringToBigIntegerConverter;
 import org.springframework.data.mongodb.core.convert.MongoConverters.StringToURLConverter;
+import org.springframework.data.mongodb.core.convert.MongoConverters.TermToStringConverter;
 import org.springframework.data.mongodb.core.convert.MongoConverters.URLToStringConverter;
 import org.springframework.data.mongodb.core.mapping.MongoSimpleTypes;
 import org.springframework.util.Assert;
@@ -58,6 +59,7 @@
  * 
  * @author Oliver Gierke
  * @author Thomas Darimont
+ * @author Christoph Strobl
  */
 public class CustomConversions {
 
@@ -106,7 +108,8 @@ public CustomConversions(List<?> converters) {
 		toRegister.add(URLToStringConverter.INSTANCE);
 		toRegister.add(StringToURLConverter.INSTANCE);
 		toRegister.add(DBObjectToStringConverter.INSTANCE);
-		
+		toRegister.add(TermToStringConverter.INSTANCE);
+
 		toRegister.addAll(JodaTimeConverters.getConvertersToRegister());
 		toRegister.addAll(GeoConverters.getConvertersToRegister());
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverters.java

@@ -25,6 +25,8 @@
 import org.springframework.core.convert.TypeDescriptor;
 import org.springframework.core.convert.converter.Converter;
 import org.springframework.data.convert.ReadingConverter;
+import org.springframework.data.convert.WritingConverter;
+import org.springframework.data.mongodb.core.query.Term;
 import org.springframework.util.StringUtils;
 
 import com.mongodb.DBObject;
@@ -34,6 +36,7 @@
  * 
  * @author Oliver Gierke
  * @author Thomas Darimont
+ * @author Christoph Strobl
  */
 abstract class MongoConverters {
 
@@ -160,4 +163,19 @@ public String convert(DBObject source) {
 			return source == null ? null : source.toString();
 		}
 	}
+
+	/**
+	 * @author Christoph Strobl
+	 * @since 1.6
+	 */
+	@WritingConverter
+	public static enum TermToStringConverter implements Converter<Term, String> {
+
+		INSTANCE;
+
+		@Override
+		public String convert(Term source) {
+			return source == null ? null : source.getFormatted();
+		}
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java

@@ -57,6 +57,11 @@
 public class QueryMapper {
 
 	private static final List<String> DEFAULT_ID_NAMES = Arrays.asList("id", "_id");
+	private static final DBObject META_TEXT_SCORE = new BasicDBObject("$meta", "textScore");
+
+	private enum MetaMapping {
+		FORCE, WHEN_PRESENT, IGNORE;
+	}
 
 	private final ConversionService conversionService;
 	private final MongoConverter converter;
@@ -119,6 +124,61 @@ public DBObject getMappedObject(DBObject query, MongoPersistentEntity<?> entity)
 		return result;
 	}
 
+	/**
+	 * Maps fields used for sorting to the {@link MongoPersistentEntity}s properties. <br />
+	 * Also converts properties to their {@code $meta} representation if present.
+	 * 
+	 * @param sortObject
+	 * @param entity
+	 * @return
+	 * @since 1.6
+	 */
+	public DBObject getMappedSort(DBObject sortObject, MongoPersistentEntity<?> entity) {
+
+		if (sortObject == null) {
+			return null;
+		}
+
+		DBObject mappedSort = getMappedObject(sortObject, entity);
+		mapMetaAttributes(mappedSort, entity, MetaMapping.WHEN_PRESENT);
+		return mappedSort;
+	}
+
+	/**
+	 * Maps fields to retrieve to the {@link MongoPersistentEntity}s properties. <br />
+	 * Also onverts and potentially adds missing property {@code $meta} representation.
+	 * 
+	 * @param fieldsObject
+	 * @param entity
+	 * @return
+	 * @since 1.6
+	 */
+	public DBObject getMappedFields(DBObject fieldsObject, MongoPersistentEntity<?> entity) {
+
+		DBObject mappedFields = fieldsObject != null ? getMappedObject(fieldsObject, entity) : new BasicDBObject();
+		mapMetaAttributes(mappedFields, entity, MetaMapping.FORCE);
+		return mappedFields.keySet().isEmpty() ? null : mappedFields;
+	}
+
+	private void mapMetaAttributes(DBObject source, MongoPersistentEntity<?> entity, MetaMapping metaMapping) {
+
+		if (entity == null || source == null) {
+			return;
+		}
+
+		if (entity.hasTextScoreProperty() && !MetaMapping.IGNORE.equals(metaMapping)) {
+			MongoPersistentProperty textScoreProperty = entity.getTextScoreProperty();
+			if (MetaMapping.FORCE.equals(metaMapping)
+					|| (MetaMapping.WHEN_PRESENT.equals(metaMapping) && source.containsField(textScoreProperty.getFieldName()))) {
+				source.putAll(getMappedTextScoreField(textScoreProperty));
+			}
+		}
+	}
+
+	private DBObject getMappedTextScoreField(MongoPersistentProperty property) {
+		return new BasicDBObject(property.getFieldName(), META_TEXT_SCORE);
+	}
+
 	/**
 	 * Extracts the mapped object value for given field out of rawValue taking nested {@link Keyword}s into account
 	 * 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/TextIndexDefinition.java

@@ -276,7 +276,7 @@ public TextIndexDefinitionBuilder onFields(String... fieldnames) {
 		 * @return
 		 */
 		public TextIndexDefinitionBuilder onField(String fieldname) {
-			return onField(fieldname, Float.NaN);
+			return onField(fieldname, 1F);
 		}
 
 		/**

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentEntity.java

@@ -114,6 +114,24 @@ public String getLanguage() {
 		return this.language;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.mapping.MongoPersistentEntity#getTextScoreProperty()
+	 */
+	@Override
+	public MongoPersistentProperty getTextScoreProperty() {
+		return getPersistentProperty(TextScore.class);
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.mapping.MongoPersistentEntity#hasTextScoreProperty()
+	 */
+	@Override
+	public boolean hasTextScoreProperty() {
+		return getTextScoreProperty() != null;
+	}
+
 	/* 
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mapping.model.BasicPersistentEntity#verify()

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoPersistentEntity.java

@@ -40,4 +40,21 @@ public interface MongoPersistentEntity<T> extends PersistentEntity<T, MongoPersi
 	 */
 	String getLanguage();
 
+	/**
+	 * Returns the property holding text score value.
+	 * 
+	 * @since 1.6
+	 * @see #hasTextScoreProperty()
+	 * @return {@literal null} if not present.
+	 */
+	MongoPersistentProperty getTextScoreProperty();
+
+	/**
+	 * Returns whether the entity has a {@link TextScore} property.
+	 * 
+	 * @since 1.6
+	 * @return true if property annotated with {@link TextScore} is present.
+	 */
+	boolean hasTextScoreProperty();
+
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/BasicQuery.java

@@ -50,8 +50,12 @@ public BasicQuery(DBObject queryObject, DBObject fieldsObject) {
 		this.fieldsObject = fieldsObject;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.query.Query#addCriteria(org.springframework.data.mongodb.core.query.CriteriaDefinition)
+	 */
 	@Override
-	public Query addCriteria(Criteria criteria) {
+	public Query addCriteria(CriteriaDefinition criteria) {
 		this.queryObject.putAll(criteria.getCriteriaObject());
 		return this;
 	}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/CriteriaDefinition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2011 the original author or authors.
+ * Copyright 2010-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,8 +17,25 @@
 
 import com.mongodb.DBObject;
 
+/**
+ * @author Oliver Gierke
+ * @author Christoph Strobl
+ */
 public interface CriteriaDefinition {
 
+	/**
+	 * Get {@link DBObject} representation.
+	 * 
+	 * @return
+	 */
 	DBObject getCriteriaObject();
 
-}
+	/**
+	 * Get the identifying {@literal key}.
+	 * 
+	 * @return
+	 * @since 1.6
+	 */
+	String getKey();
+
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/NearQuery.java

@@ -343,7 +343,6 @@ public Integer getSkip() {
 	 * 
 	 * @return
 	 */
-	@SuppressWarnings("deprecation")
 	public DBObject toDBObject() {
 
 		BasicDBObject dbObject = new BasicDBObject();

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java

@@ -39,56 +39,63 @@
  * @author Thomas Risberg
  * @author Oliver Gierke
  * @author Thomas Darimont
+ * @author Christoph Strobl
  */
 public class Query {
 
 	private static final String RESTRICTED_TYPES_KEY = "_$RESTRICTED_TYPES";
 
 	private final Set<Class<?>> restrictedTypes = new HashSet<Class<?>>();
-	private final Map<String, Criteria> criteria = new LinkedHashMap<String, Criteria>();
+	private final Map<String, CriteriaDefinition> criteria = new LinkedHashMap<String, CriteriaDefinition>();
 	private Field fieldSpec;
 	private Sort sort;
 	private int skip;
 	private int limit;
 	private String hint;
 
 	/**
-	 * Static factory method to create a {@link Query} using the provided {@link Criteria}.
+	 * Static factory method to create a {@link Query} using the provided {@link CriteriaDefinition}.
 	 * 
-	 * @param criteria must not be {@literal null}.
+	 * @param criteriaDefinition must not be {@literal null}.
 	 * @return
+	 * @since 1.6
 	 */
-	public static Query query(Criteria criteria) {
-		return new Query(criteria);
+	public static Query query(CriteriaDefinition criteriaDefinition) {
+		return new Query(criteriaDefinition);
 	}
 
 	public Query() {}
 
 	/**
-	 * Creates a new {@link Query} using the given {@link Criteria}.
+	 * Creates a new {@link Query} using the given {@link CriteriaDefinition}.
 	 * 
-	 * @param criteria must not be {@literal null}.
+	 * @param criteriaDefinition must not be {@literal null}.
+	 * @since 1.6
 	 */
-	public Query(Criteria criteria) {
-		addCriteria(criteria);
+	public Query(CriteriaDefinition criteriaDefinition) {
+		addCriteria(criteriaDefinition);
 	}
 
 	/**
-	 * Adds the given {@link Criteria} to the current {@link Query}.
+	 * Adds the given {@link CriteriaDefinition} to the current {@link Query}.
 	 * 
-	 * @param criteria must not be {@literal null}.
+	 * @param criteriaDefinition must not be {@literal null}.
 	 * @return
+	 * @since 1.6
 	 */
-	public Query addCriteria(Criteria criteria) {
-		CriteriaDefinition existing = this.criteria.get(criteria.getKey());
-		String key = criteria.getKey();
+	public Query addCriteria(CriteriaDefinition criteriaDefinition) {
+
+		CriteriaDefinition existing = this.criteria.get(criteriaDefinition.getKey());
+		String key = criteriaDefinition.getKey();
+
 		if (existing == null) {
-			this.criteria.put(key, criteria);
+			this.criteria.put(key, criteriaDefinition);
 		} else {
 			throw new InvalidMongoDbApiUsageException("Due to limitations of the com.mongodb.BasicDBObject, "
 					+ "you can't add a second '" + key + "' criteria. " + "Query already contains '"
 					+ existing.getCriteriaObject() + "'.");
 		}
+
 		return this;
 	}
 
@@ -268,8 +275,8 @@ public String getHint() {
 		return hint;
 	}
 
-	protected List<Criteria> getCriteria() {
-		return new ArrayList<Criteria>(this.criteria.values());
+	protected List<CriteriaDefinition> getCriteria() {
+		return new ArrayList<CriteriaDefinition>(this.criteria.values());
 	}
 
 	/*