Query (Algolia Search Offline API Client for Android)

Object
- com.algolia.search.saas.AbstractQuery
- - com.algolia.search.saas.Query

```
public class Query
extends AbstractQuery
```
Describes all parameters of a search query.
There are two ways to access parameters:
1. Using the high-level, typed properties for individual parameters (recommended). 2. Using the low-level, untyped getter (`get()`) and setter (`set()`) or the subscript operator. Use this approach if the parameter you wish to set is not supported by this class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Query.AlternativesAsExact`
`static class`	`Query.ExactOnSingleWordQuery`
`static class`	`Query.GeoRect` A rectangle in geo coordinates.
`static class`	`Query.IgnorePlurals` A value of the `ignorePlurals` setting.
`static class`	`Query.Polygon` A polygon in geo coordinates.
`static class`	`Query.QueryType`
`static class`	`Query.RemoveWordsIfNoResults`
`static class`	`Query.SortFacetValuesBy`
`static class`	`Query.TypoTolerance`

Nested classes/interfaces inherited from class com.algolia.search.saas.AbstractQuery
AbstractQuery.LatLng

Field Summary

Fields
Modifier and Type Field and Description

static String KEY_SORT_FACET_VALUES_BY

static int RADIUS_ALL

Fields
Modifier and Type	Field and Description
`static String`	`KEY_SORT_FACET_VALUES_BY`
`static int`	`RADIUS_ALL`

Constructor Summary

Constructors
Constructor and Description
`Query()` Construct an empty query.
`Query(CharSequence query)` Construct a query with the specified query text.
`Query(Query other)` Clone an existing query.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Boolean`	`getAdvancedSyntax()`
`Boolean`	`getAllowTyposOnNumericTokens()`
`Query.AlternativesAsExact[]`	`getAlternativesAsExact()`
`Boolean`	`getAnalytics()`
`String[]`	`getAnalyticsTags()`
`AbstractQuery.LatLng`	`getAroundLatLng()`
`Boolean`	`getAroundLatLngViaIP()`
`Integer`	`getAroundPrecision()`
`Integer`	`getAroundRadius()` Get the current radius for around latitude/longitude queries.
`String[]`	`getAttributesToHighlight()`
`String[]`	`getAttributesToRetrieve()`
`String[]`	`getAttributesToSnippet()`
`Boolean`	`getClickAnalytics()`
`String[]`	`getDisableExactOnAttributes()`
`String[]`	`getDisableTypoToleranceOnAttributes()`
`Integer`	`getDistinct()`
`Boolean`	`getEnableRules()`
`Query.ExactOnSingleWordQuery`	`getExactOnSingleWordQuery()`
`JSONArray`	`getFacetFilters()` Deprecated. Use `getFilters()` instead.
`Boolean`	`getFacetingAfterDistinct()`
`String[]`	`getFacets()`
`String`	`getFilters()` Get the numeric, facet or/and tag filters for this Query.
`Boolean`	`getGetRankingInfo()`
`String`	`getHighlightPostTag()`
`String`	`getHighlightPreTag()`
`Integer`	`getHitsPerPage()`
`Query.IgnorePlurals`	`getIgnorePlurals()`
`Query.GeoRect[]`	`getInsideBoundingBox()`
`Query.Polygon[]`	`getInsidePolygon()`
`Integer`	`getLength()`
`Integer`	`getMaxFacetHits()`
`Integer`	`getMaxValuesPerFacet()`
`Integer`	`getMinimumAroundRadius()`
`Integer`	`getMinProximity()`
`Integer`	`getMinWordSizefor1Typo()`
`Integer`	`getMinWordSizefor2Typos()`
`JSONArray`	`getNumericFilters()` Deprecated. Use `getFilters()` instead.
`Integer`	`getOffset()`
`String[]`	`getOptionalFilters()`
`String[]`	`getOptionalWords()`
`Integer`	`getPage()`
`Boolean`	`getPercentileComputation()`
`String`	`getQuery()`
`Query.QueryType`	`getQueryType()`
`Object`	`getRemoveStopWords()`
`Query.RemoveWordsIfNoResults`	`getRemoveWordsIfNoResults()`
`Boolean`	`getReplaceSynonymsInHighlight()`
`String[]`	`getResponseFields()` Get the fields the response will contain.
`Boolean`	`getRestrictHighlightAndSnippetArrays()`
`String[]`	`getRestrictSearchableAttributes()`
`String[]`	`getRuleContexts()`
`String`	`getSnippetEllipsisText()`
`Query.SortFacetValuesBy`	`getSortFacetValuesBy()`
`Boolean`	`getSumOrFiltersScores()`
`Boolean`	`getSynonyms()`
`JSONArray`	`getTagFilters()`
`Query.TypoTolerance`	`getTypoTolerance()`
`Query`	`set(String name, Object value)` Set a parameter in an untyped fashion.
`Query`	`setAdvancedSyntax(Boolean enabled)` Enable the advanced query syntax.
`Query`	`setAllowTyposOnNumericTokens(Boolean enabled)`
`Query`	`setAlternativesAsExact(Query.AlternativesAsExact[] types)`
`Query`	`setAnalytics(Boolean enabled)`
`Query`	`setAnalyticsTags(String... tags)`
`Query`	`setAroundLatLng(AbstractQuery.LatLng location)` Search for entries around a given latitude/longitude.
`Query`	`setAroundLatLngViaIP(Boolean enabled)` Search for entries around the latitude/longitude of user (using IP geolocation)
`Query`	`setAroundPrecision(Integer precision)` Change the radius or around latitude/longitude query
`Query`	`setAroundRadius(Integer radius)` Change the radius for around latitude/longitude queries.
`Query`	`setAttributesToHighlight(List<String> attributes)` Deprecated.
`Query`	`setAttributesToHighlight(String... attributes)` Specify the list of attribute names to highlight.
`Query`	`setAttributesToRetrieve(List<String> attributes)` Deprecated.
`Query`	`setAttributesToRetrieve(String... attributes)` Specify the list of attribute names to retrieve.
`Query`	`setAttributesToSnippet(String... attributes)` Specify the list of attribute names to Snippet alongside the number of words to return (syntax is 'attributeName:nbWords').
`Query`	`setClickAnalytics(Boolean enabled)`
`Query`	`setDisableExactOnAttributes(String... attributes)` List of attributes on which you want to disable computation of the `exact` ranking criterion (must be a subset of the `searchableAttributes` index setting).
`Query`	`setDisableTypoToleranceOnAttributes(String... attributes)` List of attributes on which you want to disable typo tolerance (must be a subset of the `searchableAttributes` index setting).
`Query`	`setDistinct(Integer nbHitsToKeep)` This feature is similar to the distinct just before but instead of keeping the best value per value of attributeForDistinct, it allows to keep N values.
`Query`	`setEnableRules(Boolean enabled)`
`Query`	`setExactOnSingleWordQuery(Query.ExactOnSingleWordQuery type)`
`Query`	`setFacetFilters(JSONArray filters)` Deprecated. Use `setFilters(String)` instead.
`Query`	`setFacetingAfterDistinct(Boolean enabled)` Force faceting to be applied after de-duplication.
`Query`	`setFacets(String... facets)` List of object attributes that you want to use for faceting.
`Query`	`setFilters(String filters)` Filter the query with numeric, facet or/and tag filters.
`Query`	`setGetRankingInfo(Boolean enabled)` if set, the result hits will contain ranking information in _rankingInfo attribute.
`Query`	`setHighlightPostTag(String tag)`
`Query`	`setHighlightPreTag(String tag)`
`Query`	`setHitsPerPage(Integer nbHitsPerPage)` Set the number of hits per page.
`Query`	`setIgnorePlurals(boolean enabled)` If set to true, plural won't be considered as a typo (for example car/cars will be considered as equals).
`Query`	`setIgnorePlurals(Collection<String> languageISOCodes)` A list of language codes for which plural won't be considered as a typo (for example car/cars will be considered as equals).
`Query`	`setIgnorePlurals(String... languageISOCodes)` One or several language codes for which plural won't be considered as a typo (for example car/cars will be considered as equals).
`Query`	`setInsideBoundingBox(Query.GeoRect... boxes)` Search for entries inside one area or the union of several areas defined by the two extreme points of a rectangle.
`Query`	`setInsidePolygon(AbstractQuery.LatLng... points)` Search for entries inside a given area defined by the points of a polygon.
`Query`	`setInsidePolygon(Query.Polygon... polygons)` Search for entries inside a given area defined by several polygons.
`Query`	`setLength(Integer n)` Maximum number of hits to return.
`Query`	`setMaxFacetHits(Integer n)` Limit the number of facet values returned for each facet.
`Query`	`setMaxValuesPerFacet(Integer n)` Limit the number of facet values returned for each facet.
`Query`	`setMinimumAroundRadius(Integer minimumAroundRadius)` Specify the minimum number of characters in a query word to accept one typo in this word.
`Query`	`setMinProximity(Integer nbChars)` Specify the minimum number of characters in a query word to accept one typo in this word.
`Query`	`setMinWordSizefor1Typo(Integer nbChars)` Specify the minimum number of characters in a query word to accept one typo in this word.
`Query`	`setMinWordSizefor2Typos(Integer nbChars)` Specify the minimum number of characters in a query word to accept one typo in this word.
`Query`	`setNumericFilters(JSONArray filters)` Deprecated. Use `setFilters(String)` instead.
`Query`	`setOffset(int offset)` Set the offset of the first hit to return (zero-based).
`Query`	`setOptionalFilters(String... filters)` Set a list of filters for ranking purposes, to rank higher records that contain the filter(s).
`Query`	`setOptionalWords(String... words)` Set a list of words that should be considered as optional when found in the query.
`Query`	`setPage(Integer page)` Set the page to retrieve (zero base).
`Query`	`setPercentileComputation(boolean enabled)` Whether to include the query in processing time percentile computation.
`Query`	`setQuery(CharSequence query)` Set the full text query
`Query`	`setQueryType(Query.QueryType type)` Select how the query words are interpreted:
`Query`	`setRemoveStopWords(Object removeStopWords)` Enable the removal of stop words, disabled by default.
`Query`	`setRemoveWordsIfNoResults(Query.RemoveWordsIfNoResults type)` Select the strategy to adopt when a query does not return any result.
`Query`	`setReplaceSynonymsInHighlight(Boolean enabled)`
`Query`	`setResponseFields(String... attributes)` Choose which fields the response will contain.
`Query`	`setRestrictHighlightAndSnippetArrays(boolean restrict)` Restricts arrays in highlight and snippet results to items that matched the query.
`Query`	`setRestrictSearchableAttributes(String... attributes)` List of object attributes you want to use for textual search (must be a subset of the `searchableAttributes` index setting).
`Query`	`setRuleContexts(String... ruleContexts)` Set a list of contexts for which rules are enabled.
`Query`	`setSnippetEllipsisText(String snippetEllipsisText)` Specify the string that is used as an ellipsis indicator when a snippet is truncated (defaults to the empty string).
`Query`	`setSortFacetValuesBy(Query.SortFacetValuesBy order)` When using `setFacets(java.lang.String...)`, Algolia retrieves a list of matching facet values for each faceted attribute.
`Query`	`setSumOrFiltersScores(Boolean enabled)`
`Query`	`setSynonyms(Boolean enabled)`
`Query`	`setTagFilters(JSONArray tagFilters)`
`Query`	`setTypoTolerance(Query.TypoTolerance type)`

Methods inherited from class com.algolia.search.saas.AbstractQuery
build, equals, get, hashCode, parseFrom, parseLatLng, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - RADIUS_ALL
```
public static final int RADIUS_ALL
```
    See Also:
    
    Constant Field Values
  - KEY_SORT_FACET_VALUES_BY
```
public static final String KEY_SORT_FACET_VALUES_BY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Query
```
public Query()
```
    Construct an empty query.
  - Query
```
public Query(CharSequence query)
```
    Construct a query with the specified query text.
    
    Parameters:
    
    query - Query text.
  - Query
```
public Query(@NonNull
             Query other)
```
    Clone an existing query.
    
    Parameters:
    
    other - The query to be cloned.
- Method Detail
  - setAdvancedSyntax
```
@NonNull
public Query setAdvancedSyntax(Boolean enabled)
```
    Enable the advanced query syntax. Defaults to false. - Phrase query: a phrase query defines a particular sequence of terms. A phrase query is build by Algolia's query parser for words surrounded by ". For example, "search engine" will retrieve records having search next to engine only. Typo-tolerance is disabled on phrase queries. - Prohibit operator: The prohibit operator excludes records that contain the term after the - symbol. For example search -engine will retrieve records containing search but not engine.
  - getAdvancedSyntax
```
public Boolean getAdvancedSyntax()
```
  - setAllowTyposOnNumericTokens
```
@NonNull
public Query setAllowTyposOnNumericTokens(Boolean enabled)
```
    Parameters:
    
    enabled - If set to false, disable typo-tolerance on numeric tokens. Defaults to true.
  - getAllowTyposOnNumericTokens
```
public Boolean getAllowTyposOnNumericTokens()
```
  - setClickAnalytics
```
@NonNull
public Query setClickAnalytics(Boolean enabled)
```
    Parameters:
    
    enabled - If set to true, the results will return queryID which is needed for sending click | conversion events. Defaults to false.
  - getClickAnalytics
```
public Boolean getClickAnalytics()
```
  - setAnalytics
```
@NonNull
public Query setAnalytics(Boolean enabled)
```
    Parameters:
    
    enabled - If set to false, this query will not be taken into account in analytics feature. Defaults to true.
  - getAnalytics
```
public Boolean getAnalytics()
```
  - setAnalyticsTags
```
@NonNull
public Query setAnalyticsTags(String... tags)
```
    Parameters:
    
    tags - Set the analytics tags identifying the query
  - getAnalyticsTags
```
public String[] getAnalyticsTags()
```
  - setAroundLatLng
```
@NonNull
public Query setAroundLatLng(@Nullable
                                      AbstractQuery.LatLng location)
```
    Search for entries around a given latitude/longitude.
  - getAroundLatLng
```
@Nullable
public AbstractQuery.LatLng getAroundLatLng()
```
  - setAroundLatLngViaIP
```
@NonNull
public Query setAroundLatLngViaIP(Boolean enabled)
```
    Search for entries around the latitude/longitude of user (using IP geolocation)
  - getAroundLatLngViaIP
```
public Boolean getAroundLatLngViaIP()
```
  - setAroundPrecision
```
@NonNull
public Query setAroundPrecision(Integer precision)
```
    Change the radius or around latitude/longitude query
  - getAroundPrecision
```
public Integer getAroundPrecision()
```
  - setAroundRadius
```
@NonNull
public Query setAroundRadius(Integer radius)
```
    Change the radius for around latitude/longitude queries.
    
    Parameters:
    
    radius - the radius to set, or Query.RADIUS_ALL to disable stopping at a specific radius.
  - getAroundRadius
```
public Integer getAroundRadius()
```
    Get the current radius for around latitude/longitude queries.
    
    Returns:
    
    Query.RADIUS_ALL if set to 'all'.
  - setAttributesToHighlight
```
@Deprecated
 @NonNull
public Query setAttributesToHighlight(List<String> attributes)
```
    Deprecated.
    
    Deprecated, use setAttributesToHighlight(String...)
  - setAttributesToHighlight
```
@NonNull
public Query setAttributesToHighlight(String... attributes)
```
    Specify the list of attribute names to highlight. By default indexed attributes are highlighted.
  - getAttributesToHighlight
```
public String[] getAttributesToHighlight()
```
  - setAttributesToRetrieve
```
@Deprecated
 @NonNull
public Query setAttributesToRetrieve(List<String> attributes)
```
    Deprecated.
    
    Deprecated, use setAttributesToRetrieve(String...)
  - setAttributesToRetrieve
```
@NonNull
public Query setAttributesToRetrieve(String... attributes)
```
    Specify the list of attribute names to retrieve. By default all attributes are retrieved.
  - getAttributesToRetrieve
```
public String[] getAttributesToRetrieve()
```
  - setAttributesToSnippet
```
@NonNull
public Query setAttributesToSnippet(String... attributes)
```
    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.
  - getAttributesToSnippet
```
public String[] getAttributesToSnippet()
```
  - setDisableExactOnAttributes
```
@NonNull
public Query setDisableExactOnAttributes(String... attributes)
```
    List of attributes on which you want to disable computation of the exact ranking criterion (must be a subset of the `searchableAttributes` index setting).
  - getDisableExactOnAttributes
```
public String[] getDisableExactOnAttributes()
```
  - setDisableTypoToleranceOnAttributes
```
@NonNull
public Query setDisableTypoToleranceOnAttributes(String... attributes)
```
    List of attributes on which you want to disable typo tolerance (must be a subset of the `searchableAttributes` index setting).
  - getDisableTypoToleranceOnAttributes
```
public String[] getDisableTypoToleranceOnAttributes()
```
  - setDistinct
```
@NonNull
public Query setDistinct(Integer nbHitsToKeep)
```
    This feature is similar to the distinct just before but instead of keeping the best value per value of attributeForDistinct, it allows to keep N values.
    
    Parameters:
    
    nbHitsToKeep - Specify the maximum number of hits to keep for each distinct value
  - getDistinct
```
public Integer getDistinct()
```
  - setFacets
```
@NonNull
public Query setFacets(String... facets)
```
    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**.
  - getFacets
```
public String[] getFacets()
```
  - setFacetFilters
```
@NonNull
public Query setFacetFilters(JSONArray filters)
```
    Deprecated. Use setFilters(String) instead.
    
    Set the deprecated facetFilters parameter.
  - getFacetFilters
```
@Nullable
public JSONArray getFacetFilters()
```
    Deprecated. Use getFilters() instead.
    
    Get the value of deprecated facetFilters parameter.
  - getFacetingAfterDistinct
```
@Nullable
public Boolean getFacetingAfterDistinct()
```
  - setFacetingAfterDistinct
```
@NonNull
public Query setFacetingAfterDistinct(Boolean enabled)
```
    Force faceting to be applied after de-duplication. Please check documentation for consequences and limitations
    
    Parameters:
    
    enabled - if true, facets will be computed after de-duplication is applied.
    
    See Also:
    
    facetingAfterDistinct's documentation
  - setFilters
```
@NonNull
public Query setFilters(String filters)
```
    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. The syntax for the underlying numeric, facet and tag filters is the same than in the other filters: available=1 AND (category:Book OR NOT category:Ebook) AND _tags:public date: 1441745506 TO 1441755506 AND inStock > 0 AND author:"John Doe"
    
    Parameters:
    
    filters - a string following the given syntax.
    
    Returns:
    
    the Query for chaining.
  - getFilters
```
@Nullable
public String getFilters()
```
    Get the numeric, facet or/and tag filters for this Query.
    
    Returns:
    
    a String with this query's filters.
  - setGetRankingInfo
```
@NonNull
public Query setGetRankingInfo(Boolean enabled)
```
    if set, the result hits will contain ranking information in _rankingInfo attribute.
  - getGetRankingInfo
```
public Boolean getGetRankingInfo()
```
  - setHighlightPostTag
```
@NonNull
public Query setHighlightPostTag(String tag)
```
  - getHighlightPostTag
```
@Nullable
public String getHighlightPostTag()
```
  - setHighlightPreTag
```
@NonNull
public Query setHighlightPreTag(String tag)
```
  - getHighlightPreTag
```
@Nullable
public String getHighlightPreTag()
```
  - setHitsPerPage
```
@NonNull
public Query setHitsPerPage(Integer nbHitsPerPage)
```
    Set the number of hits per page. Defaults to 10.
  - getHitsPerPage
```
public Integer getHitsPerPage()
```
  - setIgnorePlurals
```
@NonNull
public Query setIgnorePlurals(boolean enabled)
```
    If set to true, plural won't be considered as a typo (for example car/cars will be considered as equals). Defaults to false.
  - setIgnorePlurals
```
@NonNull
public Query setIgnorePlurals(@Nullable
                                       Collection<String> languageISOCodes)
```
    A list of language codes for which plural won't be considered as a typo (for example car/cars will be considered as equals). If empty or null, this disables the feature.
  - setIgnorePlurals
```
@NonNull
public Query setIgnorePlurals(@Nullable
                                       String... languageISOCodes)
```
    One or several language codes for which plural won't be considered as a typo (for example car/cars will be considered as equals). If empty or null, this disables the feature.
  - getIgnorePlurals
```
@NonNull
public Query.IgnorePlurals getIgnorePlurals()
```
  - setInsideBoundingBox
```
@NonNull
public Query setInsideBoundingBox(@Nullable
                                           Query.GeoRect... boxes)
```
    Search for entries inside one area or the union of several areas defined by the two extreme points of a rectangle.
  - getInsideBoundingBox
```
@Nullable
public Query.GeoRect[] getInsideBoundingBox()
```
  - setInsidePolygon
```
@NonNull
public Query setInsidePolygon(@Nullable
                                       AbstractQuery.LatLng... points)
```
    Search for entries inside a given area defined by the points of a polygon.
  - setInsidePolygon
```
@NonNull
public Query setInsidePolygon(@Nullable
                                       Query.Polygon... polygons)
```
    Search for entries inside a given area defined by several polygons.
  - getInsidePolygon
```
@Nullable
public Query.Polygon[] getInsidePolygon()
```
  - setLength
```
@NonNull
public Query setLength(Integer n)
```
    Maximum number of hits to return.
    In most cases, page/hitsPerPage is the recommended method for pagination.
    
    Parameters:
    
    n - the number of hits to return. (Maximum 1000)
  - getLength
```
public Integer getLength()
```
  - setMaxFacetHits
```
@NonNull
public Query setMaxFacetHits(Integer n)
```
    Limit the number of facet values returned for each facet.
  - getMaxFacetHits
```
public Integer getMaxFacetHits()
```
  - setMaxValuesPerFacet
```
@NonNull
public Query setMaxValuesPerFacet(Integer n)
```
    Limit the number of facet values returned for each facet.
  - getMaxValuesPerFacet
```
public Integer getMaxValuesPerFacet()
```
  - setMinimumAroundRadius
```
@NonNull
public Query setMinimumAroundRadius(Integer minimumAroundRadius)
```
    Specify the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.
  - getMinimumAroundRadius
```
public Integer getMinimumAroundRadius()
```
  - setMinProximity
```
@NonNull
public Query setMinProximity(Integer nbChars)
```
    Specify the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.
  - getMinProximity
```
public Integer getMinProximity()
```
  - setMinWordSizefor1Typo
```
@NonNull
public Query setMinWordSizefor1Typo(Integer nbChars)
```
    Specify the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.
  - getMinWordSizefor1Typo
```
public Integer getMinWordSizefor1Typo()
```
  - setMinWordSizefor2Typos
```
@NonNull
public Query setMinWordSizefor2Typos(Integer nbChars)
```
    Specify the minimum number of characters in a query word to accept one typo in this word. Defaults to 3.
  - getMinWordSizefor2Typos
```
public Integer getMinWordSizefor2Typos()
```
  - setNumericFilters
```
@NonNull
public Query setNumericFilters(JSONArray filters)
```
    Deprecated. Use setFilters(String) instead.
    
    Set the deprecated numericFilters parameter.
  - getNumericFilters
```
@Nullable
public JSONArray getNumericFilters()
```
    Deprecated. Use getFilters() instead.
    
    Get the value of deprecated facetFilters parameter.
  - setOffset
```
@NonNull
public Query setOffset(int offset)
```
    Set the offset of the first hit to return (zero-based). In most cases, page/hitsPerPage is the recommended method for pagination.
    
    Parameters:
    
    offset - a zero-based offset.
  - getOffset
```
public Integer getOffset()
```
  - setOptionalWords
```
@NonNull
public Query setOptionalWords(String... words)
```
    Set a list of words that should be considered as optional when found in the query.
    
    Parameters:
    
    words - The list of optional words.
  - getOptionalWords
```
public String[] getOptionalWords()
```
  - setOptionalFilters
```
@NonNull
public Query setOptionalFilters(String... filters)
```
    Set a list of filters for ranking purposes, to rank higher records that contain the filter(s).
    
    Parameters:
    
    filters - The list of optional filters.
  - getOptionalFilters
```
public String[] getOptionalFilters()
```
  - setPage
```
@NonNull
public Query setPage(Integer page)
```
    Set the page to retrieve (zero base). Defaults to 0.
  - getPage
```
public Integer getPage()
```
  - setPercentileComputation
```
@NonNull
public Query setPercentileComputation(boolean enabled)
```
    Whether to include the query in processing time percentile computation.
    
    Parameters:
    
    enabled - if true, the API records the processing time of the search query and includes it when computing the 90% and 99% percentiles, available in your Algolia dashboard. When `false`, the search query is excluded from percentile computation.
  - getPercentileComputation
```
public Boolean getPercentileComputation()
```
  - setQuery
```
@NonNull
public Query setQuery(CharSequence query)
```
    Set the full text query
  - getQuery
```
@Nullable
public String getQuery()
```
  - setQueryType
```
@NonNull
public Query setQueryType(@Nullable
                                   Query.QueryType type)
```
    Select how the query words are interpreted:
  - getQueryType
```
@Nullable
public Query.QueryType getQueryType()
```
  - setRemoveStopWords
```
@NonNull
public Query setRemoveStopWords(Object removeStopWords)
                                  throws AlgoliaException
```
    Enable the removal of stop words, disabled by default. In most use-cases, we don’t recommend enabling this option.
    
    Parameters:
    
    removeStopWords - Boolean: enable or disable all 41 supported languages, String: comma separated list of languages you have in your record (using language iso code).
    
    Throws:
    
    AlgoliaException
  - getRemoveStopWords
```
@Nullable
public Object getRemoveStopWords()
```
  - setRemoveWordsIfNoResults
```
@NonNull
public Query setRemoveWordsIfNoResults(@Nullable
                                                Query.RemoveWordsIfNoResults type)
```
    Select the strategy to adopt when a query does not return any result.
  - getRemoveWordsIfNoResults
```
@Nullable
public Query.RemoveWordsIfNoResults getRemoveWordsIfNoResults()
```
  - setReplaceSynonymsInHighlight
```
@NonNull
public Query setReplaceSynonymsInHighlight(Boolean enabled)
```
    Parameters:
    
    enabled - If set to false, words matched via synonyms expansion will not be replaced by the matched synonym in highlight result. Default to true.
  - getReplaceSynonymsInHighlight
```
public Boolean getReplaceSynonymsInHighlight()
```
  - setRestrictHighlightAndSnippetArrays
```
@NonNull
public Query setRestrictHighlightAndSnippetArrays(boolean restrict)
```
    Restricts arrays in highlight and snippet results to items that matched the query.
    
    Parameters:
    
    restrict - if false, all array items are highlighted/snippeted. When true, only array items that matched at least partially are highlighted/snippeted.
  - getRestrictHighlightAndSnippetArrays
```
public Boolean getRestrictHighlightAndSnippetArrays()
```
  - setRestrictSearchableAttributes
```
@NonNull
public Query setRestrictSearchableAttributes(String... attributes)
```
    List of object attributes you want to use for textual search (must be a subset of the `searchableAttributes` index setting). Attributes are separated with a comma (for example @"name,address"). You can also use a JSON string array encoding (for example encodeURIComponent("[\"name\",\"address\"]")). By default, all attributes specified in `searchableAttributes` settings are used to search.
  - getRestrictSearchableAttributes
```
public String[] getRestrictSearchableAttributes()
```
  - setRuleContexts
```
@NonNull
public Query setRuleContexts(String... ruleContexts)
```
    Set a list of contexts for which rules are enabled.
    Contextual rules matching any of these contexts are eligible, as well as generic rules. When empty, only generic rules are eligible.
    
    Parameters:
    
    ruleContexts - one or several contexts.
  - getRuleContexts
```
@Nullable
public String[] getRuleContexts()
```
  - setSnippetEllipsisText
```
@NonNull
public Query setSnippetEllipsisText(String snippetEllipsisText)
```
    Specify the string that is used as an ellipsis indicator when a snippet is truncated (defaults to the empty string).
  - getSnippetEllipsisText
```
@Nullable
public String getSnippetEllipsisText()
```
  - setSortFacetValuesBy
```
@NonNull
public Query setSortFacetValuesBy(Query.SortFacetValuesBy order)
```
    When using setFacets(java.lang.String...), Algolia retrieves a list of matching facet values for each faceted attribute. This parameter controls how the facet values are sorted within each faceted attribute.
    
    Parameters:
    
    order - supported options are `count` (sort by decreasing count) and `alpha` (sort by increasing alphabetical order)
    
    Returns:
    
    This instance (used to chain calls).
  - getSortFacetValuesBy
```
public Query.SortFacetValuesBy getSortFacetValuesBy()
```
  - setSumOrFiltersScores
```
@NonNull
public Query setSumOrFiltersScores(Boolean enabled)
```
    Parameters:
    
    enabled - False means that the total score of a record is the maximum score of an individual filter. Setting it to true changes the total score by adding together the scores of each filter found. Defaults to false.
  - getSumOrFiltersScores
```
public Boolean getSumOrFiltersScores()
```
  - setSynonyms
```
@NonNull
public Query setSynonyms(Boolean enabled)
```
    Parameters:
    
    enabled - If set to false, this query will not use synonyms defined in configuration. Defaults to true.
  - getSynonyms
```
public Boolean getSynonyms()
```
  - setTagFilters
```
@NonNull
public Query setTagFilters(JSONArray tagFilters)
```
  - getTagFilters
```
@Nullable
public JSONArray getTagFilters()
```
  - setTypoTolerance
```
@NonNull
public Query setTypoTolerance(@Nullable
                                       Query.TypoTolerance type)
```
  - getTypoTolerance
```
@Nullable
public Query.TypoTolerance getTypoTolerance()
```
  - setExactOnSingleWordQuery
```
@NonNull
public Query setExactOnSingleWordQuery(@Nullable
                                                Query.ExactOnSingleWordQuery type)
```
  - getExactOnSingleWordQuery
```
@Nullable
public Query.ExactOnSingleWordQuery getExactOnSingleWordQuery()
```
  - setEnableRules
```
@NonNull
public Query setEnableRules(Boolean enabled)
```
    Parameters:
    
    enabled - If set to false, rules processing is disabled: no rule will match the query. Defaults to true.
  - getEnableRules
```
public Boolean getEnableRules()
```
  - setAlternativesAsExact
```
@NonNull
public Query setAlternativesAsExact(@Nullable
                                             Query.AlternativesAsExact[] types)
```
  - getAlternativesAsExact
```
@Nullable
public Query.AlternativesAsExact[] getAlternativesAsExact()
```
  - setResponseFields
```
@NonNull
public Query setResponseFields(String... attributes)
```
    Choose which fields the response will contain. Applies to search and browse queries.
    By default, all fields are returned. If this parameter is specified, only the fields explicitly listed will be returned, unless * is used, in which case all fields are returned. Specifying an empty list or unknown field names is an error.
  - getResponseFields
```
public String[] getResponseFields()
```
    Get the fields the response will contain. If unspecified, all fields are returned.
  - set
```
@NonNull
public Query set(@NonNull
                          String name,
                          @Nullable
                          Object value)
```
    Set a parameter in an untyped fashion. This low-level accessor is intended to access parameters that this client does not yet support.
    
    Overrides:
    
    set in class AbstractQuery
    
    Parameters:
    
    name - The parameter's name.
    
    value - The parameter's value, or null to remove it. It will first be converted to a String by the `toString()` method.
    
    Returns:
    
    This instance (used to chain calls).

Class Query

Nested Class Summary

Nested classes/interfaces inherited from class com.algolia.search.saas.AbstractQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.algolia.search.saas.AbstractQuery

Methods inherited from class Object

Field Detail

RADIUS_ALL

KEY_SORT_FACET_VALUES_BY

Constructor Detail

Query

Query

Query

Method Detail

setAdvancedSyntax

getAdvancedSyntax

setAllowTyposOnNumericTokens

getAllowTyposOnNumericTokens

setClickAnalytics

getClickAnalytics

setAnalytics

getAnalytics

setAnalyticsTags

getAnalyticsTags

setAroundLatLng

getAroundLatLng

setAroundLatLngViaIP

getAroundLatLngViaIP

setAroundPrecision

getAroundPrecision

setAroundRadius

getAroundRadius

setAttributesToHighlight

setAttributesToHighlight

getAttributesToHighlight

setAttributesToRetrieve

setAttributesToRetrieve

getAttributesToRetrieve

setAttributesToSnippet

getAttributesToSnippet

setDisableExactOnAttributes

getDisableExactOnAttributes

setDisableTypoToleranceOnAttributes

getDisableTypoToleranceOnAttributes

setDistinct

getDistinct

setFacets

getFacets

setFacetFilters

getFacetFilters

getFacetingAfterDistinct

setFacetingAfterDistinct

setFilters

getFilters

setGetRankingInfo

getGetRankingInfo

setHighlightPostTag

getHighlightPostTag

setHighlightPreTag

getHighlightPreTag

setHitsPerPage

getHitsPerPage

setIgnorePlurals

setIgnorePlurals

setIgnorePlurals

getIgnorePlurals

setInsideBoundingBox

getInsideBoundingBox

setInsidePolygon

setInsidePolygon

getInsidePolygon

setLength

getLength

setMaxFacetHits

getMaxFacetHits

setMaxValuesPerFacet

getMaxValuesPerFacet

setMinimumAroundRadius