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(List<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	setAroundRadius(Object aroundRadius)
Query	setAroundRadiusAll()
Query	setAttributesToHighlight(List<String> attributesToHighlight)
Query	setAttributesToRetrieve(List<String> attributesToRetrieve)
Query	setAttributesToSnippet(List<String> attributesToSnippet)
Query	setCursor(String cursor)
Query	setDisableExactOnAttributes(List<String> disableExactOnAttributes)
Query	setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)
Query	setDistinct(Distinct distinct)
Query	setExactOnSingleWordQuery(String exactOnSingleWordQuery)
Query	setFacetFilters(List<String> facetFilters)
Query	setFacetingAfterDistinct(Boolean facetingAfterDistinct)
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	setIgnorePlurals(IgnorePlurals ignorePlurals)
Query	setInsideBoundingBox(List<String> insideBoundingBox)
Query	setInsidePolygon(List<String> insidePolygon)
Query	setLength(Integer length)
Query	setMaxFacetHits(Integer maxFacetHits)
Query	setMaxValuesPerFacet(Integer maxValuesPerFacet)
Query	setMinimumAroundRadius(Integer minimumAroundRadius)
Query	setMinProximity(Integer minProximity)
Query	setMinWordSizefor1Typo(Integer minWordSizefor1Typo)
Query	setMinWordSizefor2Typos(Integer minWordSizefor2Typos)
Query	setNumericFilters(List<String> numericFilters)
Query	setOffset(Integer offset)
Query	setOptionalWords(List<String> optionalWords)
Query	setPage(Integer page)
Query	setPercentileComputation(Boolean percentileComputation)
Query	setQuery(String query)
Query	setQueryType(String queryType)
Query	setRemoveStopWords(RemoveStopWords removeStopWords)
Query	setRemoveWordsIfNoResults(Query.RemoveWordsType removeWordsIfNoResults)
Query	setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
Query	setResponseFields(List<String> responseFields)
Query	setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)
Query	setRestrictIndices(List<String> restrictIndices)
Query	setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)
Query	setRestrictSources(String restrictSources)
Query	setSnippetEllipsisText(String snippetEllipsisText)
Query	setSynonyms(Boolean synonyms)
Query	setTagFilters(List<String> tagFilters)
Query	setTypoTolerance(Query.TypoTolerance typoTolerance)
Query	setUserToken(String userToken)
Query	setValidUntil(Integer validUntil)
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()

setAroundRadius

public Query setAroundRadius(Integer aroundRadius)

setAroundRadiusAll

public Query setAroundRadiusAll()

addCustomParameter

public Query addCustomParameter(String key,
                                String value)

setDistinct

public Query setDistinct(Distinct distinct)

setGetRankingInfo

public Query setGetRankingInfo(Boolean getRankingInfo)

setNumericFilters

public Query setNumericFilters(List<String> numericFilters)

setTagFilters

public Query setTagFilters(List<String> tagFilters)

setAnalytics

public Query setAnalytics(Boolean analytics)

setAnalyticsTags

public Query setAnalyticsTags(String analyticsTags)

setSynonyms

public Query setSynonyms(Boolean synonyms)

setReplaceSynonymsInHighlight

public Query setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

setMinProximity

public Query setMinProximity(Integer minProximity)

setResponseFields

public Query setResponseFields(List<String> responseFields)

setMaxFacetHits

public Query setMaxFacetHits(Integer maxFacetHits)

setAttributesToRetrieve

public Query setAttributesToRetrieve(List<String> attributesToRetrieve)

setRestrictSearchableAttributes

public Query setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

setFilters

public Query setFilters(String filters)

setFacets

public Query setFacets(String facets)

setMaxValuesPerFacet

public Query setMaxValuesPerFacet(Integer maxValuesPerFacet)

setFacetFilters

public Query setFacetFilters(List<String> facetFilters)

setFacetingAfterDistinct

public Query setFacetingAfterDistinct(Boolean facetingAfterDistinct)

setAroundLatLng

public Query setAroundLatLng(String aroundLatLng)

setAroundLatLngViaIP

public Query setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

setAroundRadius

public Query setAroundRadius(Object aroundRadius)

setAroundPrecision

public Query setAroundPrecision(Integer aroundPrecision)

setMinimumAroundRadius

public Query setMinimumAroundRadius(Integer minimumAroundRadius)

setInsideBoundingBox

public Query setInsideBoundingBox(List<String> insideBoundingBox)

setInsidePolygon

public Query setInsidePolygon(List<String> insidePolygon)

setAttributesToHighlight

public Query setAttributesToHighlight(List<String> attributesToHighlight)

setAttributesToSnippet

public Query setAttributesToSnippet(List<String> attributesToSnippet)

setHighlightPreTag

public Query setHighlightPreTag(String highlightPreTag)

setHighlightPostTag

public Query setHighlightPostTag(String highlightPostTag)

setSnippetEllipsisText

public Query setSnippetEllipsisText(String snippetEllipsisText)

setRestrictHighlightAndSnippetArrays

public Query setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

setPage

public Query setPage(Integer page)

setHitsPerPage

public Query setHitsPerPage(Integer hitsPerPage)

setOffset

public Query setOffset(Integer offset)

setLength

public Query setLength(Integer length)

setQueryType

public Query setQueryType(String queryType)

setRemoveWordsIfNoResults

public Query setRemoveWordsIfNoResults(Query.RemoveWordsType removeWordsIfNoResults)

setAdvancedSyntax

public Query setAdvancedSyntax(Boolean advancedSyntax)

setOptionalWords

public Query setOptionalWords(List<String> optionalWords)

setRemoveStopWords

public Query setRemoveStopWords(RemoveStopWords removeStopWords)

setDisableExactOnAttributes

public Query setDisableExactOnAttributes(List<String> disableExactOnAttributes)

setExactOnSingleWordQuery

public Query setExactOnSingleWordQuery(String exactOnSingleWordQuery)

setAlternativesAsExact

public Query setAlternativesAsExact(List<String> alternativesAsExact)

setQuery

public Query setQuery(String query)

setMinWordSizefor1Typo

public Query setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

setMinWordSizefor2Typos

public Query setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

setTypoTolerance

public Query setTypoTolerance(Query.TypoTolerance typoTolerance)

setAllowTyposOnNumericTokens

public Query setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

setIgnorePlurals

public Query setIgnorePlurals(IgnorePlurals ignorePlurals)

setDisableTypoToleranceOnAttributes

public Query setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

setUserToken

public Query setUserToken(String userToken)

setValidUntil

public Query setValidUntil(Integer validUntil)

setRestrictIndices

public Query setRestrictIndices(List<String> restrictIndices)

setRestrictSources

public Query setRestrictSources(String restrictSources)

setCursor

public Query setCursor(String cursor)

setPercentileComputation

public Query setPercentileComputation(Boolean percentileComputation)