| Modifier and Type | Method and Description |
|---|---|
Query |
Query.addInsidePolygon(float latitude,
float longitude)
Add a point to the polygon of geo-search (requires a minimum of three points to define a valid polygon)
At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or
"_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).
|
Query |
Query.aroundLatitudeLongitude(float latitude,
float longitude)
Search for entries around a given latitude/longitude with an automatic radius computed depending of the density of the area.
|
Query |
Query.aroundLatitudeLongitude(float latitude,
float longitude,
int radius)
Search for entries around a given latitude/longitude.
|
Query |
Query.aroundLatitudeLongitude(float latitude,
float longitude,
int radius,
int precision)
Search for entries around a given latitude/longitude.
|
Query |
Query.aroundLatitudeLongitudeViaIP(boolean enabled)
Search for entries around the latitude/longitude of user (using IP
geolocation) with an automatic radius depending on area density
|
Query |
Query.aroundLatitudeLongitudeViaIP(boolean enabled,
int radius)
Search for entries around the latitude/longitude of user (using IP
geolocation)
|
Query |
Query.aroundLatitudeLongitudeViaIP(boolean enabled,
int radius,
int precision)
Search for entries around the latitude/longitude of user (using IP
geolocation)
|
Query |
Query.disableTypoToleranceOnAttributes(List<String> attributes) |
Query |
Query.enableAnalytics(boolean enabled) |
Query |
Query.enableAvancedSyntax(boolean advancedSyntax)
Enable the advanced query syntax.
|
Query |
Query.enableDistinct(boolean distinct) |
Query |
Query.enableDistinct(int 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 |
Query.enableRemoveStopWords(boolean removeStopWords)
Enable the removal of stop words.
|
Query |
Query.enableRemoveStopWords(String removeStopWords)
Enable to pass a list of ISO codes
|
Query |
Query.enableReplaceSynonymsInHighlight(boolean enabled) |
Query |
Query.enableSynonyms(boolean enabled) |
Query |
Query.enableTyposOnNumericTokens(boolean enabled) |
Query |
Query.enableTypoTolerance(boolean enabled) |
Query |
APIClient.IndexQuery.getQuery() |
Query |
Query.getRankingInfo(boolean enabled)
if set, the result hits will contain ranking information in _rankingInfo
attribute.
|
Query |
Query.ignorePlural(boolean enabled)
If set to true, plural won't be considered as a typo (for example
car/cars will be considered as equals).
|
Query |
Query.insideBoundingBox(float latitudeP1,
float longitudeP1,
float latitudeP2,
float longitudeP2)
Search for entries inside a given area defined by the two extreme points of a rectangle.
|
Query |
Query.removeWordsIfNoResult(Query.RemoveWordsType type)
Select the strategy to adopt when a query does not return any result.
|
Query |
Query.restrictSearchableAttributes(String attributes)
List of object attributes you want to use for textual search (must be a
subset of the attributesToIndex index setting).
|
Query |
Query.setAlternativesAsExact(String alternativesAsExact) |
Query |
Query.setAnalyticsTags(String analyticsTags) |
Query |
Query.setAroundPrecision(int precision)
Change the precision of around latitude/longitude query
|
Query |
Query.setAroundRadius(int radius)
Change the radius of around latitude/longitude query
|
Query |
Query.setAroundRadiusAll()
Change the radius of around latitude/longitude to `all`
|
Query |
Query.setAttributesToHighlight(List<String> attributes)
Specify the list of attribute names to highlight.
|
Query |
Query.setAttributesToRetrieve(List<String> attributes)
Specify the list of attribute names to retrieve.
|
Query |
Query.setAttributesToSnippet(List<String> attributes)
Specify the list of attribute names to Snippet alongside the number of
words to return (syntax is 'attributeName:nbWords').
|
Query |
Query.setExactOnSingleWordQuery(String exactOnSingleWordQuery) |
Query |
Query.setFacetFilters(List<String> facets)
Filter the query by a list of facets.
|
Query |
Query.setFacetFilters(String facetFilters)
Filter the query by a list of facets.
|
Query |
Query.setFacets(List<String> facets)
List of object attributes that you want to use for faceting.
|
Query |
Query.setFilters(String filters)
Filter the query with numeric, facet or/and tag filters.
|
Query |
Query.setHighlightingTags(String preTag,
String postTag) |
Query |
Query.setHitsPerPage(int nbHitsPerPage)
Set the number of hits per page.
|
Query |
Query.setMaxNumberOfFacets(int n)
Limit the number of facet values returned for each facet.
|
Query |
Query.setMinimumAroundRadius(int radius)
Change the minimum radius of around latitude/longitude query
|
Query |
Query.setMinProximity(int value) |
Query |
Query.setMinWordSizeToAllowOneTypo(int nbChars)
Specify the minimum number of characters in a query word to accept one
typo in this word.
|
Query |
Query.setMinWordSizeToAllowTwoTypos(int nbChars)
Specify the minimum number of characters in a query word to accept two
typos in this word.
|
Query |
Query.setNbHitsPerPage(int nbHitsPerPage)
Deprecated.
Use
setHitsPerPage |
Query |
Query.setNumericFilters(List<String> numerics)
Add a list of numeric filters separated by a comma.
|
Query |
Query.setNumericFilters(String numerics)
Add a list of numeric filters separated by a comma.
|
Query |
Query.setOptionalWords(List<String> words)
Set the list of words that should be considered as optional when found in
the query.
|
Query |
Query.setOptionalWords(String words)
Set the list of words that should be considered as optional when found in
the query.
|
Query |
Query.setPage(int page)
Set the page to retrieve (zero base).
|
Query |
Query.setQueryString(String query)
Set the full text query
|
Query |
Query.setQueryType(Query.QueryType type)
Select how the query words are interpreted:
|
Query |
Query.setReferers(String referers)
Set the referers used to restrict the query from a specific website.
|
Query |
Query.setRestrictIndicies(String indices) |
Query |
Query.setSimilarQueryString(String query)
Set the full text similar query string
|
Query |
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 |
Query.setTagFilters(String tags)
Filter the query by a set of tags.
|
Query |
Query.setTypoTolerance(Query.TypoTolerance typoTolerance) |
Query |
Query.setUserToken(String userToken)
Set the userToken used as identifier for the ratelimit
|
Query |
Query.setValidUntil(Integer timestamp) |
| Modifier and Type | Method and Description |
|---|---|
Index.IndexBrowser |
Index.browse(Query params)
Browse all index content
|
Index.IndexBrowser |
Index.browseFrom(Query params,
String cursor)
Browse all index content starting from a cursor
|
Index.IndexBrowser |
Index.browseFrow(Query params,
String cursor)
Deprecated.
|
void |
Index.deleteByQuery(Query query)
Delete all objects matching a query
|
void |
Index.deleteByQuery(Query query,
int batchLimit) |
String |
APIClient.generateSecuredApiKey(String privateApiKey,
Query query)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
String |
APIClient.generateSecuredApiKey(String privateApiKey,
Query query,
String userToken)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
org.json.JSONObject |
Index.search(Query params)
Search inside the index
|
org.json.JSONObject |
Index.searchDisjunctiveFaceting(Query query,
List<String> disjunctiveFacets) |
org.json.JSONObject |
Index.searchDisjunctiveFaceting(Query query,
List<String> disjunctiveFacets,
Map<String,List<String>> refinements)
Perform a search with disjunctive facets generating as many queries as number of disjunctive facets
|
void |
APIClient.IndexQuery.setQuery(Query query) |
| Constructor and Description |
|---|
IndexQuery(String index,
Query q) |
Query(Query other) |
Copyright © 2016. All rights reserved.