Query: Updated API to accept String or String[] arguments

Author: PLNech

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

@@ -74,8 +74,8 @@ protected JSONObject addObject(JSONObject obj) throws AlgoliaException {
     /**
      * Add an object in this index
      *
-     * @param obj the object to add. 
-     * @param objectID an objectID you want to attribute to this object 
+     * @param obj the object to add.
+     * @param objectID an objectID you want to attribute to this object
      * (if the attribute already exist the old object will be overwrite)
      * @throws AlgoliaException
      */
@@ -261,7 +261,7 @@ protected JSONObject saveObjects(JSONArray inputArray) throws AlgoliaException {
     }
 
     /**
-     * Delete an object from the index 
+     * Delete an object from the index
      *
      * @param objectID the unique identifier of object to delete
      * @throws AlgoliaException
@@ -306,9 +306,7 @@ protected JSONObject deleteObjects(List<String> objects) throws AlgoliaException
      * @throws AlgoliaException
      */
     protected void deleteByQuery(Query query) throws AlgoliaException {
-        List<String> attributesToRetrieve = new ArrayList<String>();
-        attributesToRetrieve.add("objectID");
-        query.setAttributesToRetrieve(attributesToRetrieve);
+        query.setAttributesToRetrieve("objectID");
         query.setHitsPerPage(100);
 
         JSONObject results = this.search(query);
@@ -342,7 +340,7 @@ protected JSONObject search(Query query) throws AlgoliaException {
     }
 
     /**
-     * Wait the publication of a task on the server. 
+     * Wait the publication of a task on the server.
      * All server task are asynchronous and you can check with this method that the task is published.
      *
      * @param taskID the id of the task returned by server
@@ -501,9 +499,10 @@ public JSONObject searchDisjunctiveFaceting(Query query, List<String> disjunctiv
                     filters.append(or.toString());
                 }
             }
-            List<String> facets = new ArrayList<String>();
-            facets.add(disjunctiveFacet);
-            queries.add(new IndexQuery(this.indexName, new Query(query).setHitsPerPage(0).enableAnalytics(false).setAttributesToRetrieve(new ArrayList<String>()).setAttributesToHighlight(new ArrayList<String>()).setAttributesToSnippet(new ArrayList<String>()).setFacets(facets).setFacetFilters(filters.toString())));
+            String[] facets = new String[]{disjunctiveFacet};
+            queries.add(new IndexQuery(this.indexName, new Query(query).setHitsPerPage(0).enableAnalytics(false)
+                    .setAttributesToRetrieve("").setAttributesToHighlight("").setAttributesToSnippet("")
+                    .setFacets(facets).setFacetFilters(filters.toString())));
         }
         JSONObject answers = this.client.multipleQueries(queries, null);
 

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

@@ -2,27 +2,28 @@
 
 import android.util.Pair;
 
+import org.json.JSONArray;
+
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
-import org.json.JSONArray;
-
 /*
  * Copyright (c) 2015 Algolia
  * http://www.algolia.com/
- * 
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -248,31 +249,67 @@ public Query setSimilarQueryString(String query) {
     /**
      * Specify the list of attribute names to retrieve. By default all
      * attributes are retrieved.
+     * @deprecated use {@code setAttributesToRetrieve(String... attributes)}
      */
+    @Deprecated
     public Query setAttributesToRetrieve(List<String> attributes) {
         this.attributes = attributes;
         return this;
     }
 
+    /**
+     * Specify the list of attribute names to retrieve. By default all
+     * attributes are retrieved.
+     *
+     */
+    public Query setAttributesToRetrieve(String... attributes) {
+        this.attributes = Arrays.asList(attributes);
+        return this;
+    }
+
     /**
      * Specify the list of attribute names to highlight. By default indexed
      * attributes are highlighted.
+     * @deprecated use {@link #setAttributesToHighlight(String...)}
      */
+    @Deprecated
     public Query setAttributesToHighlight(List<String> attributes) {
         this.attributesToHighlight = attributes;
         return this;
     }
 
+
+    /**
+     * Specify the list of attribute names to highlight. By default indexed
+     * attributes are highlighted.
+     */
+    public Query setAttributesToHighlight(String... attributes) {
+        this.attributesToHighlight = Arrays.asList(attributes);
+        return this;
+    }
+
     /**
      * Specify the list of attribute names to Snippet alongside the number of
      * words to return (syntax is 'attributeName:nbWords'). By default no
      * snippet is computed.
+     * @deprecated use {@link #setFacets(String...)}
      */
+    @Deprecated
     public Query setAttributesToSnippet(List<String> attributes) {
         this.attributesToSnippet = attributes;
         return this;
     }
 
+    /**
+     * Specify the list of attribute names to Snippet alongside the number of
+     * words to return (syntax is 'attributeName:nbWords'). By default no
+     * snippet is computed.
+     */
+    public Query setAttributesToSnippet(String... attributes) {
+        this.attributesToSnippet = Arrays.asList(attributes);
+        return this;
+    }
+
     /**
      *
      * @param distinct
@@ -490,7 +527,7 @@ public Query setAroundPrecision(int precision) {
     /**
      * Set the number of hits per page. Defaults to 10.
      *
-     * @deprecated Use {@code setHitsPerPage}
+     * @deprecated Use {@link #setHitsPerPage(int)}
      */
     @Deprecated
     public Query setNbHitsPerPage(int nbHitsPerPage) {
@@ -642,7 +679,9 @@ public Query setOptionalWords(String words) {
      *
      * @param words
      *            The list of optional words.
+     * @deprecated use {@link #setOptionalWords(String...)}
      */
+    @Deprecated
     public Query setOptionalWords(List<String> words) {
         StringBuilder builder = new StringBuilder();
         for (String word : words) {
@@ -653,6 +692,23 @@ public Query setOptionalWords(List<String> words) {
         return this;
     }
 
+    /**
+     * Set the list of words that should be considered as optional when found in
+     * the query.
+     *
+     * @param words
+     *            The list of optional words.
+     */
+    public Query setOptionalWords(String... words) {
+        StringBuilder builder = new StringBuilder();
+        for (String word : words) {
+            builder.append(word);
+            builder.append(",");
+        }
+        this.optionalWords = builder.toString();
+        return this;
+    }
+
     /**
 	 * Filter the query with numeric, facet or/and tag filters.
 	 * The syntax is a SQL like syntax, you can use the OR and AND keywords.
@@ -673,7 +729,9 @@ public Query setFilters(String filters) {
     /**
      * Filter the query by a list of facets. Each filter is encoded as
      * `attributeName:value`.
+     * @deprecated use {@link #setFacetFilters(String...)}
      */
+    @Deprecated
     public Query setFacetFilters(List<String> facets) {
         JSONArray obj = new JSONArray();
         for (String facet : facets) {
@@ -683,6 +741,19 @@ public Query setFacetFilters(List<String> facets) {
         return this;
     }
 
+    /**
+     * Filter the query by a list of facets. Each filter is encoded as
+     * `attributeName:value`.
+     */
+    public Query setFacetFilters(String... facets) {
+        JSONArray obj = new JSONArray();
+        for (String facet : facets) {
+            obj.put(facet);
+        }
+        this.facetFilters = obj.toString();
+        return this;
+    }
+
     /**
      * Filter the query by a list of facets. Filters are separated by commas and
      * each facet is encoded as `attributeName:value`. To OR facets, you must
@@ -701,7 +772,9 @@ public Query setFacetFilters(String facetFilters) {
      * Only attributes that have been added in **attributesForFaceting** index
      * setting can be used in this parameter. You can also use `*` to perform
      * faceting on all attributes specified in **attributesForFaceting**.
+     * @deprecated use {@link #setFacets(String...)}
      */
+    @Deprecated
     public Query setFacets(List<String> facets) {
         JSONArray obj = new JSONArray();
         for (String facet : facets) {
@@ -711,6 +784,21 @@ public Query setFacets(List<String> facets) {
         return this;
     }
 
+    /**
+     * List of object attributes that you want to use for faceting.
+     * Only attributes that have been added in **attributesForFaceting** index
+     * setting can be used in this parameter. You can also use `*` to perform
+     * faceting on all attributes specified in **attributesForFaceting**.
+     */
+    public Query setFacets(String... facets) {
+        JSONArray obj = new JSONArray();
+        for (String facet : facets) {
+            obj.put(facet);
+        }
+        this.facets = obj.toString();
+        return this;
+    }
+
     /**
      * Limit the number of facet values returned for each facet.
      */
@@ -749,7 +837,9 @@ public Query setNumericFilters(String numerics) {
      * Supported operands are `&lt;`, `&lt;=`, `=`, `&gt;` and `&lt;=`. You can have
      * multiple conditions on one attribute like for example
      * `numerics=price&gt;100,price&lt;1000`.
+     * @deprecated use {@link #setNumericFilters(String...)}
      */
+    @Deprecated
     public Query setNumericFilters(List<String> numerics) {
         StringBuilder builder = new StringBuilder();
         boolean first = true;
@@ -763,6 +853,26 @@ public Query setNumericFilters(List<String> numerics) {
         return this;
     }
 
+    /**
+     * Add a list of numeric filters separated by a comma. The syntax of one
+     * filter is `attributeName` followed by `operand` followed by `value.
+     * Supported operands are `&lt;`, `&lt;=`, `=`, `&gt;` and `&lt;=`. You can have
+     * multiple conditions on one attribute like for example
+     * `numerics=price&gt;100,price&lt;1000`.
+     */
+    public Query setNumericFilters(String... numerics) {
+        StringBuilder builder = new StringBuilder();
+        boolean first = true;
+        for (String n : numerics) {
+            if (!first)
+                builder.append(",");
+            builder.append(n);
+            first = false;
+        }
+        this.numerics = builder.toString();
+        return this;
+    }
+
     /**
      * Enable the advanced query syntax. Defaults to false. - Phrase query: a
      * phrase query defines a particular sequence of terms. A phrase query is