DATAMONGO-1455, DATAMONGO-1456 - Add support for $caseSensitive and $diacriticSensitive to $text.

We added methods to set values for $caseSensitive and $diacriticSensitive when using TextCriteria. Both operators are optional and will not be used until explicitly set.

    // { "$text" : { "$search" : "coffee" , "$caseSensitive" : true } }
    TextCriteria.forDefaultLanguage().matching("coffee").caseSensitive(true);

    // { "$text" : { "$search" : "coffee" , "$diacriticSensitive" : true } }
    TextCriteria.forDefaultLanguage().matching("coffee").diacriticSensitive(true);

Original pull request: #375.

Author: christophstrobl

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2016 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.
@@ -33,6 +33,8 @@ public class TextCriteria implements CriteriaDefinition {
 
 	private final List<Term> terms;
 	private String language;
+	private Boolean caseSensitive;
+	private Boolean diacriticSensitive;
 
 	/**
 	 * Creates a new {@link TextCriteria}.
@@ -164,6 +166,32 @@ public TextCriteria matchingPhrase(String phrase) {
 		return this;
 	}
 
+	/**
+	 * Optionally enable or disable case sensitive search.
+	 *
+	 * @param caseSensitive boolean flag endable/disable.
+	 * @return never {@literal null}.
+	 * @since 1.10
+	 */
+	public TextCriteria caseSensitive(boolean caseSensitive) {
+
+		this.caseSensitive = caseSensitive;
+		return this;
+	}
+
+	/**
+	 * Optionallly enable or disable diacritic sensitive search against version 3 text indexes.
+	 *
+	 * @param diacriticSensitive boolean flag endable/disable.
+	 * @return never {@literal null}.
+	 * @since 1.10
+	 */
+	public TextCriteria diacriticSensitive(boolean diacriticSensitive) {
+
+		this.diacriticSensitive = diacriticSensitive;
+		return this;
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.core.query.CriteriaDefinition#getKey()
@@ -190,6 +218,14 @@ public Document getCriteriaObject() {
 			document.put("$search", join(terms));
 		}
 
+		if (caseSensitive != null) {
+			document.put("$caseSensitive", caseSensitive);
+		}
+
+		if (diacriticSensitive != null) {
+			document.put("$diacriticSensitive", diacriticSensitive);
+		}
+
 		return new Document("$text", document);
 	}
 

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/query/TextCriteriaUnitTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2016 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.
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.mongodb.core.query;
 
+import static org.hamcrest.core.IsEqual.*;
+
 import org.bson.Document;
 import org.hamcrest.core.IsEqual;
 import org.junit.Assert;
@@ -35,7 +37,7 @@ public class TextCriteriaUnitTests {
 	public void shouldNotHaveLanguageField() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage();
-		Assert.assertThat(criteria.getCriteriaObject(), IsEqual.equalTo(searchObject("{ }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ }")));
 	}
 
 	/**
@@ -45,7 +47,7 @@ public void shouldNotHaveLanguageField() {
 	public void shouldNotHaveLanguageForNonDefaultLanguageField() {
 
 		TextCriteria criteria = TextCriteria.forLanguage("spanish");
-		Assert.assertThat(criteria.getCriteriaObject(), IsEqual.equalTo(searchObject("{ \"$language\" : \"spanish\" }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ \"$language\" : \"spanish\" }")));
 	}
 
 	/**
@@ -55,7 +57,7 @@ public void shouldNotHaveLanguageForNonDefaultLanguageField() {
 	public void shouldCreateSearchFieldForSingleTermCorrectly() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage().matching("cake");
-		Assert.assertThat(criteria.getCriteriaObject(), IsEqual.equalTo(searchObject("{ \"$search\" : \"cake\" }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ \"$search\" : \"cake\" }")));
 	}
 
 	/**
@@ -65,8 +67,7 @@ public void shouldCreateSearchFieldForSingleTermCorrectly() {
 	public void shouldCreateSearchFieldCorrectlyForMultipleTermsCorrectly() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage().matchingAny("bake", "coffee", "cake");
-		Assert.assertThat(criteria.getCriteriaObject(),
-				IsEqual.equalTo(searchObject("{ \"$search\" : \"bake coffee cake\" }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ \"$search\" : \"bake coffee cake\" }")));
 	}
 
 	/**
@@ -87,7 +88,7 @@ public void shouldCreateSearchFieldForPhraseCorrectly() {
 	public void shouldCreateNotFieldCorrectly() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage().notMatching("cake");
-		Assert.assertThat(criteria.getCriteriaObject(), IsEqual.equalTo(searchObject("{ \"$search\" : \"-cake\" }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ \"$search\" : \"-cake\" }")));
 	}
 
 	/**
@@ -97,8 +98,7 @@ public void shouldCreateNotFieldCorrectly() {
 	public void shouldCreateSearchFieldCorrectlyForNotMultipleTermsCorrectly() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage().notMatchingAny("bake", "coffee", "cake");
-		Assert.assertThat(criteria.getCriteriaObject(),
-				IsEqual.equalTo(searchObject("{ \"$search\" : \"-bake -coffee -cake\" }")));
+		Assert.assertThat(criteria.getCriteriaObject(), equalTo(searchObject("{ \"$search\" : \"-bake -coffee -cake\" }")));
 	}
 
 	/**
@@ -109,7 +109,30 @@ public void shouldCreateSearchFieldForNotPhraseCorrectly() {
 
 		TextCriteria criteria = TextCriteria.forDefaultLanguage().notMatchingPhrase("coffee cake");
 		Assert.assertThat(DBObjectTestUtils.getAsDocument(criteria.getCriteriaObject(), "$text"),
-				IsEqual.<Document> equalTo(new Document("$search", "-\"coffee cake\"")));
+				equalTo(new Document("$search", "-\"coffee cake\"")));
+	}
+
+	/**
+	 * @see DATAMONGO-1455
+	 */
+	@Test
+	public void caseSensitiveOperatorShouldBeSetCorrectly() {
+
+		TextCriteria criteria = TextCriteria.forDefaultLanguage().matching("coffee").caseSensitive(true);
+
+		assertThat(DBObjectTestUtils.getAsDocument(criteria.getCriteriaObject(), "$text"),
+				equalTo(Document.parse("{ \"$search\" : \"coffee\", \"$caseSensitive\" : true }")));
+	}
+
+	/**
+	 * @see DATAMONGO-1456
+	 */
+	@Test
+	public void diacriticSensitiveOperatorShouldBeSetCorrectly() {
+
+		TextCriteria criteria = TextCriteria.forDefaultLanguage().matching("coffee").diacriticSensitive(true);
+		assertThat(DBObjectTestUtils.getAsDocument(criteria.getCriteriaObject(), "$text"),
+				equalTo(Document.parse("{ \"$search\" : \"coffee\", \"$diacriticSensitive\" : true }")));
 	}
 
 	private Document searchObject(String json) {

src/main/asciidoc/reference/mongodb.adoc

@@ -1356,6 +1356,8 @@ TextQuery.searching(new TextCriteria().matching("\"coffee cake\""));
 TextQuery.searching(new TextCriteria().phrase("coffee cake"));
 ----
 
+The flags for `$caseSensitive` and `$diacriticSensitive` can be set via the according methods on `TextCriteria`. Please note that these two optional flags have been introduced in MongoDB 3.2 and will not be included in the query unless explicitly set.
+
 include::../{spring-data-commons-docs}/query-by-example.adoc[leveloffset=+1]
 include::query-by-example.adoc[leveloffset=+1]