Upgrading to Elasticsearch 1.7.0. Adding way to customize queries on the query helper using ES api.

Author: Luc Boutier

elasticsearch-annotations/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>fr.lucboutier.elasticsearch</groupId>
         <artifactId>elasticsearch-mapping-parent</artifactId>
-        <version>1.3.0</version>
+        <version>1.4.0</version>
     </parent>
 
     <artifactId>elasticsearch-annotations</artifactId>

elasticsearch-mapping/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>fr.lucboutier.elasticsearch</groupId>
         <artifactId>elasticsearch-mapping-parent</artifactId>
-        <version>1.3.0</version>
+        <version>1.4.0</version>
     </parent>
 
     <artifactId>elasticsearch-mapping</artifactId>

elasticsearch-mapping/src/main/java/org/elasticsearch/mapping/QueryBuilderAdapter.java

@@ -0,0 +1,16 @@
+package org.elasticsearch.mapping;
+
+import org.elasticsearch.index.query.QueryBuilder;
+
+/**
+ * Interface used to allow modification of the Query Builder when using QueryHelper to generate the search query.
+ */
+public interface QueryBuilderAdapter {
+    /**
+     * Adapt a query.
+     * 
+     * @param queryBuilder A query builder to adapt before adding filters, sort and other post-processing elements to the query.
+     * @return The query builder with adaptations.
+     */
+    QueryBuilder adapt(QueryBuilder queryBuilder);
+}

elasticsearch-mapping/src/main/java/org/elasticsearch/mapping/QueryHelper.java

@@ -1,11 +1,7 @@
 package org.elasticsearch.mapping;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.Map.Entry;
-import java.util.Set;
 
 import javax.annotation.Resource;
 
@@ -18,11 +14,7 @@
 import org.elasticsearch.common.collect.Maps;
 import org.elasticsearch.common.logging.ESLogger;
 import org.elasticsearch.common.logging.Loggers;
-import org.elasticsearch.index.query.BoolQueryBuilder;
-import org.elasticsearch.index.query.FilterBuilder;
-import org.elasticsearch.index.query.FilterBuilders;
-import org.elasticsearch.index.query.QueryBuilder;
-import org.elasticsearch.index.query.QueryBuilders;
+import org.elasticsearch.index.query.*;
 import org.elasticsearch.index.query.functionscore.ScoreFunctionBuilders;
 import org.elasticsearch.search.facet.FacetBuilder;
 import org.elasticsearch.search.sort.SortBuilder;
@@ -370,12 +362,35 @@ public SearchQueryHelperBuilder customFilter(FilterBuilder filterBuilder) {
          * @param size The maximum number of elements to return.
          */
         public SearchResponse search(int from, int size) {
+            SearchRequestBuilder searchRequestBuilder = generate(from, size);
+            return searchRequestBuilder.execute().actionGet();
+        }
+
+        /**
+         * Generate a SearchRequestBuilder based on the query helper configuration.
+         *
+         * @return an ElasticSearch SearchRequestBuilder that can be used for more advanced configuraiton.
+         */
+        public SearchRequestBuilder generate() {
+            return generate(null);
+        }
+
+        /**
+         * Generate a SearchRequestBuilder based on the query helper configuration.
+         * 
+         * @return an ElasticSearch SearchRequestBuilder that can be used for more advanced configuraiton.
+         */
+        public SearchRequestBuilder generate(QueryBuilderAdapter queryBuilderAdapter) {
             SearchRequestBuilder searchRequestBuilder = esClient.getClient().prepareSearch(this.indices);
-            searchRequestBuilder.setSearchType(SearchType.QUERY_THEN_FETCH).setSize(size).setFrom(from);
+            searchRequestBuilder.setSearchType(SearchType.QUERY_THEN_FETCH);
+            QueryBuilder query = queryBuilder;
+            if (queryBuilderAdapter != null) {
+                query = queryBuilderAdapter.adapt(queryBuilder);
+            }
             if (functionScore == null) {
-                searchRequestBuilder.setQuery(queryBuilder);
+                searchRequestBuilder.setQuery(query);
             } else {
-                searchRequestBuilder.setQuery(QueryBuilders.functionScoreQuery(queryBuilder, ScoreFunctionBuilders.scriptFunction(functionScore)));
+                searchRequestBuilder.setQuery(QueryBuilders.functionScoreQuery(query, ScoreFunctionBuilders.scriptFunction(functionScore)));
             }
             searchRequestBuilder.setTypes(getTypes());
             if (classes != null && classes.length > 0) {
@@ -401,7 +416,32 @@ public SearchResponse search(int from, int size) {
             } else {
                 searchRequestBuilder.addSort(SortBuilders.fieldSort(prefixField));
             }
-            return searchRequestBuilder.execute().actionGet();
+            return searchRequestBuilder;
+        }
+
+        /**
+         * Generate a SearchRequestBuilder based on the query helper configuration.
+         *
+         * @param from The start index of the search (for pagination).
+         * @param size The maximum number of elements to return.
+         * @param queryBuilderAdapter adapter.
+         * @return an ElasticSearch SearchRequestBuilder that can be used for more advanced configuraiton.
+         */
+        public SearchRequestBuilder generate(int from, int size, QueryBuilderAdapter queryBuilderAdapter) {
+            SearchRequestBuilder searchRequestBuilder = generate(queryBuilderAdapter);
+            searchRequestBuilder.setSize(size).setFrom(from);
+            return searchRequestBuilder;
+        }
+
+        /**
+         * Generate a SearchRequestBuilder based on the query helper configuration.
+         *
+         * @param from The start index of the search (for pagination).
+         * @param size The maximum number of elements to return.
+         * @return an ElasticSearch SearchRequestBuilder that can be used for more advanced configuraiton.
+         */
+        public SearchRequestBuilder generate(int from, int size) {
+            return generate(from, size, null);
         }
 
         private void addFetchContext(SearchRequestBuilder searchRequestBuilder) {

elasticsearch-mapping/src/test/java/org/elasticsearch/mapping/MappingBuilderTest.java

@@ -25,7 +25,7 @@ public void testSimpleClassMapping() throws IntrospectionException, JsonGenerati
         mappingBuilder.initialize("org.elasticsearch.mapping.model");
         String personMapping = mappingBuilder.getMapping(Person.class);
         Assert.assertEquals(
-                "{\"person\":{\"_type\":{\"index\":\"not_analyzed\",\"store\":false},\"_id\":{\"index\":\"no\",\"store\":false,\"path\":\"id\"},\"_source\":{\"enabled\":true},\"properties\":{\"address\":{\"properties\":{\"city\":{\"include_in_all\":false,\"index\":\"not_analyzed\",\"store\":false,\"boost\":1.0,\"term_vector\":\"no\",\"type\":\"string\"}},\"type\":\"nested\"},\"lastname\":{\"include_in_all\":true,\"index\":\"analyzed\",\"store\":false,\"boost\":1.0,\"term_vector\":\"no\",\"type\":\"string\"},\"firstname\":{\"include_in_all\":false,\"index\":\"no\",\"store\":false,\"boost\":1.0,\"term_vector\":\"no\",\"type\":\"string\"}},\"_all\":{\"enabled\":true,\"store\":false,\"analyzer\":\"simple\"}}}",
+                "{\"person\":{\"_type\":{\"index\":\"not_analyzed\",\"store\":false},\"_source\":{\"enabled\":true},\"_id\":{\"path\":\"id\",\"index\":\"no\",\"store\":false},\"_all\":{\"analyzer\":\"simple\",\"store\":false,\"enabled\":true},\"properties\":{\"firstname\":{\"include_in_all\":false,\"term_vector\":\"no\",\"index\":\"no\",\"boost\":1.0,\"store\":false,\"type\":\"string\"},\"address\":{\"type\":\"nested\",\"properties\":{\"city\":{\"include_in_all\":false,\"term_vector\":\"no\",\"index\":\"not_analyzed\",\"boost\":1.0,\"store\":false,\"type\":\"string\"}}},\"alienScore\":{\"include_in_all\":false,\"precision_step\":4,\"index\":\"not_analyzed\",\"boost\":1.0,\"store\":false,\"ignore_malformed\":false,\"type\":\"long\"},\"lastname\":{\"include_in_all\":true,\"term_vector\":\"no\",\"index\":\"analyzed\",\"boost\":1.0,\"store\":false,\"type\":\"string\"}}}}",
                 personMapping);
     }
-}
+}

elasticsearch-mapping/src/test/java/org/elasticsearch/mapping/model/Person.java

@@ -1,10 +1,6 @@
 package org.elasticsearch.mapping.model;
 
-import org.elasticsearch.annotation.ESAll;
-import org.elasticsearch.annotation.ESObject;
-import org.elasticsearch.annotation.Id;
-import org.elasticsearch.annotation.NestedObject;
-import org.elasticsearch.annotation.StringField;
+import org.elasticsearch.annotation.*;
 import org.elasticsearch.annotation.query.TermFilter;
 import org.elasticsearch.mapping.IndexType;
 
@@ -25,6 +21,17 @@ public class Person {
     @NestedObject
     private Address address;
 
+    @NumberField(index = IndexType.not_analyzed, includeInAll = false)
+    private long alienScore = 1;
+
+    public long getAlienScore() {
+        return alienScore;
+    }
+
+    public void setAlienScore(long alienScore) {
+        this.alienScore = alienScore;
+    }
+
     public String getId() {
         return id;
     }

pom.xml

@@ -3,14 +3,14 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fr.lucboutier.elasticsearch</groupId>
     <artifactId>elasticsearch-mapping-parent</artifactId>
-    <version>1.3.0</version>
+    <version>1.4.0</version>
     <packaging>pom</packaging>
 
     <name>Elastic search mapping parent</name>
     <description>An object mapping framework for Elastic Search.</description>
 
     <properties>
-        <elasticsearch.version>1.4.0</elasticsearch.version>
+        <elasticsearch.version>1.7.0</elasticsearch.version>
         <jackson.version>2.0.4</jackson.version>
         <spring.version>3.1.0.RELEASE</spring.version>
         <junit.version>4.10</junit.version>
@@ -31,6 +31,11 @@
                 <artifactId>elasticsearch</artifactId>
                 <version>${elasticsearch.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.apache.lucene</groupId>
+                <artifactId>lucene-expressions</artifactId>
+                <version>4.10.4</version>
+            </dependency>
             <dependency>
                 <groupId>com.fasterxml.jackson.core</groupId>
                 <artifactId>jackson-databind</artifactId>