Merge branch 'master' into feat/offline-facet-search

Author: Clément Le Provost

algoliasearch/src/main/java/com/algolia/search/saas/Index.java

@@ -182,7 +182,19 @@ protected Request multipleQueriesAsync(@NonNull List<Query> queries, @NonNull Co
     }
 
     /**
-     * Search for some text in a facet values.
+     * Search (asynchronously) for some text in a facet values.
+     *
+     * @param facetName The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.
+     * @param text      The text to search for in the facet's values.
+     * @param handler   A Completion handler that will be notified of the request's outcome.
+     * @return A cancellable request.
+     */
+    public Request searchForFacetValuesAsync(@NonNull String facetName, @NonNull String text, @NonNull final CompletionHandler handler) throws AlgoliaException {
+        return searchForFacetValues(facetName, text, null, handler);
+    }
+
+    /**
+     * Search (asynchronously) for some text in a facet values.
      *
      * @param facetName The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.
      * @param text      The text to search for in the facet's values.
@@ -202,6 +214,19 @@ public Request searchForFacetValues(@NonNull String facetName, @NonNull String t
      * @param handler   A Completion handler that will be notified of the request's outcome.
      * @return A cancellable request.
      */
+    public Request searchForFacetValuesAsync(@NonNull String facetName, @NonNull String facetText, @Nullable Query query, @NonNull final CompletionHandler handler) {
+        return searchForFacetValues(facetName, facetText, query, handler);
+    }
+
+    /**
+     * Search (asynchronously) for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.
+     *
+     * @param facetName The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.
+     * @param facetText      The text to search for in the facet's values.
+     * @param query     An optional query to take extra search parameters into account. There parameters apply to index objects like in a regular search query. Only facet values contained in the matched objects will be returned
+     * @param handler   A Completion handler that will be notified of the request's outcome.
+     * @return A cancellable request.
+     */
     public Request searchForFacetValues(@NonNull String facetName, @NonNull String facetText, @Nullable Query query, @NonNull final CompletionHandler handler) {
         try {
             final String path = "/1/indexes/" + getEncodedIndexName() + "/facets/" + URLEncoder.encode(facetName, "UTF-8") + "/query";

algoliasearch/src/main/java/com/algolia/search/saas/Query.java

@@ -813,6 +813,19 @@ public Polygon(Polygon other) {
         }
     }
 
+    private static final String KEY_MAX_FACET_HITS = "maxFacetHits";
+
+    /**
+     * Limit the number of facet values returned for each facet.
+     */
+    public @NonNull Query setMaxFacetHits(Integer n) {
+        return set(KEY_MAX_FACET_HITS, n);
+    }
+
+    public Integer getMaxFacetHits() {
+        return parseInt(get(KEY_MAX_FACET_HITS));
+    }
+
     private static final String KEY_MAX_VALUES_PER_FACET = "maxValuesPerFacet";
 
     /**

algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java

@@ -644,6 +644,16 @@ public void removeStopWordsInvalidClass() throws Exception {
         fail("setRemoveStopWords should throw when its parameter is neither Boolean nor String.");
     }
 
+    @Test
+    public void maxFacetHits() {
+        Query query = new Query();
+        assertNull(query.getMaxFacetHits());
+        query.setMaxFacetHits(456);
+        assertEquals(Integer.valueOf(456), query.getMaxFacetHits());
+        assertEquals("456", query.get("maxFacetHits"));
+        assertEquals(query.getMaxFacetHits(), Query.parse(query.build()).getMaxFacetHits());
+    }
+
     @Test
     public void maxValuesPerFacet() {
         Query query = new Query();