com.algolia.search.objects

Class Query

java.lang.Object

com.algolia.search.objects.Query

public class Query
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.QueryType
static class	Query.RemoveWordsType
static class	Query.TypoTolerance

Constructor Summary

Constructors

Constructor and Description
Query()
Query(String query)

Method Summary

Modifier and Type	Method and Description
Query	addCustomParameter(String key, String value)
Query	setAdvancedSyntax(Boolean advancedSyntax)
Query	setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)
Query	setAlternativesAsExact(String alternativesAsExact)
Query	setAnalytics(Boolean analytics)
Query	setAnalyticsTags(String analyticsTags)
Query	setAroundLatLng(String aroundLatLng)
Query	setAroundLatLngViaIP(Boolean aroundLatLngViaIP)
Query	setAroundPrecision(Integer aroundPrecision)
Query	setAroundRadius(Integer aroundRadius)
Query	setAroundRadiusAll()
Query	setAttributesToHighlight(List<String> attributesToHighlight)
Query	setAttributesToRetrieve(List<String> attributesToRetrieve)
Query	setAttributesToSnippet(List<String> attributesToSnippet)
Query	setCursor(String cursor)
Query	setDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributes)
Query	setDistinct(Boolean distinct)
Query	setExactOnSingleWordQuery(String exactOnSingleWordQuery)
Query	setFacetFilters(String facetFilters)
Query	setFacets(String facets)
Query	setFilters(String filters)
Query	setGetRankingInfo(Boolean getRankingInfo)
Query	setHighlightPostTag(String highlightPostTag)
Query	setHighlightPreTag(String highlightPreTag)
Query	setHitsPerPage(Integer hitsPerPage)
Query	setIgnorePlural(Boolean ignorePlural)
Query	setInsideBoundingBox(String insideBoundingBox)
Query	setInsidePolygon(String insidePolygon)
Query	setMaxValuesPerFacet(Integer maxValuesPerFacet)
Query	setMinimumAroundRadius(Integer minimumAroundRadius)
Query	setMinProximity(Integer minProximity)
Query	setMinWordSizeForApprox1(Integer minWordSizeForApprox1)
Query	setMinWordSizeForApprox2(Integer minWordSizeForApprox2)
Query	setNumericFilters(String numericFilters)
Query	setOptionalWords(String optionalWords)
Query	setPage(Integer page)
Query	setQuery(String query)
Query	setQueryType(Query.QueryType queryType)
Query	setRemoveStopWords(Boolean removeStopWords)
Query	setRemoveStopWords(List<String> isoCode)
Query	setRemoveWordsIfNoResult(Query.RemoveWordsType removeWordsIfNoResult)
Query	setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
Query	setRestrictSearchableAttributes(String restrictSearchableAttributes)
Query	setSnippetEllipsisText(String snippetEllipsisText)
Query	setSynonyms(Boolean synonyms)
Query	setTagsFilters(String tagsFilters)
Query	setTypoTolerance(Query.TypoTolerance typoTolerance)
Query	setUserToken(String userToken)
String	toParam()
Map<String,String>	toQueryParam()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Query

public Query()

Query

public Query(String query)

Method Detail

toQueryParam

public Map<String,String> toQueryParam()

toParam

public String toParam()

setQuery

public Query setQuery(String query)

setQueryType

public Query setQueryType(Query.QueryType queryType)

setTypoTolerance

public Query setTypoTolerance(Query.TypoTolerance typoTolerance)

setMinWordSizeForApprox1

public Query setMinWordSizeForApprox1(Integer minWordSizeForApprox1)

setMinWordSizeForApprox2

public Query setMinWordSizeForApprox2(Integer minWordSizeForApprox2)

setAllowTyposOnNumericTokens

public Query setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

setIgnorePlural

public Query setIgnorePlural(Boolean ignorePlural)

setRestrictSearchableAttributes

public Query setRestrictSearchableAttributes(String restrictSearchableAttributes)

setAdvancedSyntax

public Query setAdvancedSyntax(Boolean advancedSyntax)

setAnalytics

public Query setAnalytics(Boolean analytics)

setAnalyticsTags

public Query setAnalyticsTags(String analyticsTags)

setSynonyms

public Query setSynonyms(Boolean synonyms)

setReplaceSynonymsInHighlight

public Query setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

setOptionalWords

public Query setOptionalWords(String optionalWords)

setMinProximity

public Query setMinProximity(Integer minProximity)

setRemoveWordsIfNoResult

public Query setRemoveWordsIfNoResult(Query.RemoveWordsType removeWordsIfNoResult)

setDisableTypoToleranceOnAttributes

public Query setDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributes)

setRemoveStopWords

public Query setRemoveStopWords(Boolean removeStopWords)

setRemoveStopWords

public Query setRemoveStopWords(List<String> isoCode)

setExactOnSingleWordQuery

public Query setExactOnSingleWordQuery(String exactOnSingleWordQuery)

setAlternativesAsExact

public Query setAlternativesAsExact(String alternativesAsExact)

setPage

public Query setPage(Integer page)

setHitsPerPage

public Query setHitsPerPage(Integer hitsPerPage)

setAttributesToRetrieve

public Query setAttributesToRetrieve(List<String> attributesToRetrieve)

setAttributesToHighlight

public Query setAttributesToHighlight(List<String> attributesToHighlight)

setAttributesToSnippet

public Query setAttributesToSnippet(List<String> attributesToSnippet)

setGetRankingInfo

public Query setGetRankingInfo(Boolean getRankingInfo)

setHighlightPreTag

public Query setHighlightPreTag(String highlightPreTag)

setHighlightPostTag

public Query setHighlightPostTag(String highlightPostTag)

setSnippetEllipsisText

public Query setSnippetEllipsisText(String snippetEllipsisText)

setNumericFilters

public Query setNumericFilters(String numericFilters)

setTagsFilters

public Query setTagsFilters(String tagsFilters)

setDistinct

public Query setDistinct(Boolean distinct)

setFacets

public Query setFacets(String facets)

setFacetFilters

public Query setFacetFilters(String facetFilters)

setMaxValuesPerFacet

public Query setMaxValuesPerFacet(Integer maxValuesPerFacet)

setFilters

public Query setFilters(String filters)

setAroundLatLng

public Query setAroundLatLng(String aroundLatLng)

setAroundLatLngViaIP

public Query setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

setAroundRadius

public Query setAroundRadius(Integer aroundRadius)

setAroundRadiusAll

public Query setAroundRadiusAll()

setAroundPrecision

public Query setAroundPrecision(Integer aroundPrecision)

setMinimumAroundRadius

public Query setMinimumAroundRadius(Integer minimumAroundRadius)

setInsideBoundingBox

public Query setInsideBoundingBox(String insideBoundingBox)

setInsidePolygon

public Query setInsidePolygon(String insidePolygon)

setUserToken

public Query setUserToken(String userToken)

setCursor

public Query setCursor(String cursor)

addCustomParameter

public Query addCustomParameter(String key,
                                String value)