com.algolia.search.inputs.query_rules

Class ConsequenceParams<T>

java.lang.Object

com.algolia.search.objects.Query

com.algolia.search.inputs.query_rules.ConsequenceParams<T>

All Implemented Interfaces:

Serializable

public class ConsequenceParams<T>
extends Query

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.algolia.search.objects.Query

Query.QueryType, Query.RemoveWordsType

Field Summary

Fields inherited from class com.algolia.search.objects.Query

advancedSyntax, allowTyposOnNumericTokens, alternativesAsExact, analytics, analyticsTags, aroundLatLng, aroundLatLngViaIP, aroundPrecision, aroundRadius, attributesToHighlight, attributesToRetrieve, attributesToSnippet, cursor, customParameters, disableExactOnAttributes, disableTypoToleranceOnAttributes, distinct, enableRules, exactOnSingleWordQuery, facetFilters, facetingAfterDistinct, facets, filters, getRankingInfo, highlightPostTag, highlightPreTag, hitsPerPage, ignorePlurals, insideBoundingBox, insidePolygon, length, maxFacetHits, maxValuesPerFacet, minimumAroundRadius, minProximity, minWordSizefor1Typo, minWordSizefor2Typos, numericFilters, offset, optionalWords, page, percentileComputation, queryLanguages, queryType, removeStopWords, removeWordsIfNoResults, replaceSynonymsInHighlight, responseFields, restrictHighlightAndSnippetArrays, restrictIndices, restrictSearchableAttributes, restrictSources, ruleContexts, snippetEllipsisText, sortFacetValuesBy, synonyms, tagFilters, typoTolerance, userToken, validUntil

Constructor Summary

Constructors

Constructor and Description
ConsequenceParams()

Method Summary

Modifier and Type	Method and Description
ConsequenceParams	addCustomParameter(String key, String value)
Boolean	getAdvancedSyntax()
Boolean	getAllowTyposOnNumericTokens()
List<String>	getAlternativesAsExact()
Boolean	getAnalytics()
String	getAnalyticsTags()
String	getAroundLatLng()
Boolean	getAroundLatLngViaIP()
Integer	getAroundPrecision()
AroundRadius	getAroundRadius()
List<String>	getAttributesToHighlight()
List<String>	getAttributesToRetrieve()
List<String>	getAttributesToSnippet()
List<T>	getAutomaticFacetFilters()
List<T>	getAutomaticOptionalFacetFilters()
List<String>	getDisableExactOnAttributes()
List<String>	getDisableTypoToleranceOnAttributes()
Distinct	getDistinct()
String	getExactOnSingleWordQuery()
FacetFilters	getFacetFilters()
Boolean	getFacetingAfterDistinct()
String	getFacets()
String	getFilters()
Boolean	getGetRankingInfo()
String	getHighlightPostTag()
String	getHighlightPreTag()
Long	getHitsPerPage()
IgnorePlurals	getIgnorePlurals()
List<String>	getInsideBoundingBox()
List<String>	getInsidePolygon()
Long	getLength()
Long	getMaxFacetHits()
Long	getMaxValuesPerFacet()
Integer	getMinimumAroundRadius()
Integer	getMinProximity()
Integer	getMinWordSizefor1Typo()
Integer	getMinWordSizefor2Typos()
List<String>	getNumericFilters()
Long	getOffset()
List<String>	getOptionalWords()
Long	getPage()
Boolean	getPercentileComputation()
ConsequenceQuery	getQuery()
String	getQueryType()
RemoveStopWords	getRemoveStopWords()
Query.RemoveWordsType	getRemoveWordsIfNoResults()
Boolean	getReplaceSynonymsInHighlight()
List<String>	getResponseFields()
Boolean	getRestrictHighlightAndSnippetArrays()
List<String>	getRestrictSearchableAttributes()
String	getSnippetEllipsisText()
Boolean	getSynonyms()
List<String>	getTagFilters()
TypoTolerance	getTypoTolerance()
ConsequenceParams	setAdvancedSyntax(Boolean advancedSyntax)
ConsequenceParams	setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)
ConsequenceParams	setAlternativesAsExact(List<String> alternativesAsExact)
ConsequenceParams	setAnalytics(Boolean analytics)
ConsequenceParams	setAnalyticsTags(String analyticsTags)
ConsequenceParams	setAroundLatLng(String aroundLatLng)
ConsequenceParams	setAroundLatLngViaIP(Boolean aroundLatLngViaIP)
ConsequenceParams	setAroundPrecision(Integer aroundPrecision)
ConsequenceParams	setAroundRadius(AroundRadius aroundRadius)
ConsequenceParams	setAttributesToHighlight(List<String> attributesToHighlight)
ConsequenceParams	setAttributesToRetrieve(List<String> attributesToRetrieve)
ConsequenceParams	setAttributesToSnippet(List<String> attributesToSnippet)
ConsequenceParams	setAutomaticFacetFilters(List<T> automaticFacetFilters)
ConsequenceParams	setAutomaticOptionalFacetFilters(List<T> automaticOptionalFacetFilters)
ConsequenceParams	setDisableExactOnAttributes(List<String> disableExactOnAttributes)
ConsequenceParams	setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)
ConsequenceParams	setDistinct(Distinct distinct)
ConsequenceParams	setExactOnSingleWordQuery(String exactOnSingleWordQuery)
ConsequenceParams	setFacetFilters(FacetFilters facetFilters)
ConsequenceParams	setFacetFilters(List<String> facetFilters) Deprecated.
ConsequenceParams	setFacetingAfterDistinct(Boolean facetingAfterDistinct)
ConsequenceParams	setFacets(String facets)
ConsequenceParams	setFilters(String filters)
ConsequenceParams	setGetRankingInfo(Boolean getRankingInfo)
ConsequenceParams	setHighlightPostTag(String highlightPostTag)
ConsequenceParams	setHighlightPreTag(String highlightPreTag)
ConsequenceParams	setHitsPerPage(Integer hitsPerPage) Deprecated.
ConsequenceParams	setHitsPerPage(Long hitsPerPage)
ConsequenceParams	setIgnorePlurals(IgnorePlurals ignorePlurals)
ConsequenceParams	setInsideBoundingBox(List<String> insideBoundingBox)
ConsequenceParams	setInsidePolygon(List<String> insidePolygon)
ConsequenceParams	setLength(Integer length) Deprecated.
ConsequenceParams	setLength(Long length)
ConsequenceParams	setMaxFacetHits(Integer maxFacetHits) Deprecated.
ConsequenceParams	setMaxFacetHits(Long maxFacetHits)
ConsequenceParams	setMaxValuesPerFacet(Integer maxValuesPerFacet) Deprecated.
ConsequenceParams	setMaxValuesPerFacet(Long maxValuesPerFacet)
ConsequenceParams	setMinimumAroundRadius(Integer minimumAroundRadius)
ConsequenceParams	setMinProximity(Integer minProximity)
ConsequenceParams	setMinWordSizefor1Typo(Integer minWordSizefor1Typo)
ConsequenceParams	setMinWordSizefor2Typos(Integer minWordSizefor2Typos)
ConsequenceParams	setNumericFilters(List<String> numericFilters)
ConsequenceParams	setOffset(Integer offset)
ConsequenceParams	setOffset(Long offset)
ConsequenceParams	setOptionalWords(List<String> optionalWords)
ConsequenceParams	setPage(Integer page)
ConsequenceParams	setPage(Long page)
ConsequenceParams	setPercentileComputation(Boolean percentileComputation)
ConsequenceParams	setQuery(ConsequenceQuery query)
ConsequenceParams	setQueryType(String queryType)
ConsequenceParams	setRemoveStopWords(RemoveStopWords removeStopWords)
ConsequenceParams	setRemoveWordsIfNoResults(Query.RemoveWordsType removeWordsIfNoResults)
ConsequenceParams	setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
ConsequenceParams	setResponseFields(List<String> responseFields)
ConsequenceParams	setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)
ConsequenceParams	setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)
ConsequenceParams	setSnippetEllipsisText(String snippetEllipsisText)
ConsequenceParams	setSynonyms(Boolean synonyms)
ConsequenceParams	setTagFilters(List<String> tagFilters)
ConsequenceParams	setTypoTolerance(TypoTolerance typoTolerance)

Methods inherited from class com.algolia.search.objects.Query

getCursor, getCustomParameters, getEnableRules, getQueryLanguages, getRestrictIndices, getRestrictSources, getRuleContexts, getSortFacetValuesBy, getUserToken, getValidUntil, setCursor, setCustomParameters, setEnableRules, setQuery, setQueryLanguages, setRestrictIndices, setRestrictSources, setRuleContexts, setSortFacetValuesBy, setUserToken, setValidUntil, toParam, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsequenceParams

public ConsequenceParams()

Method Detail

getQuery

public ConsequenceQuery getQuery()

setQuery

public ConsequenceParams setQuery(ConsequenceQuery query)

getAutomaticFacetFilters

public List<T> getAutomaticFacetFilters()

setAutomaticFacetFilters

public ConsequenceParams setAutomaticFacetFilters(List<T> automaticFacetFilters)

getAutomaticOptionalFacetFilters

public List<T> getAutomaticOptionalFacetFilters()

setAutomaticOptionalFacetFilters

public ConsequenceParams setAutomaticOptionalFacetFilters(List<T> automaticOptionalFacetFilters)

getDistinct

public Distinct getDistinct()

Overrides:

getDistinct in class Query

setDistinct

public ConsequenceParams setDistinct(Distinct distinct)

Overrides:

setDistinct in class Query

getGetRankingInfo

public Boolean getGetRankingInfo()

Overrides:

getGetRankingInfo in class Query

setGetRankingInfo

public ConsequenceParams setGetRankingInfo(Boolean getRankingInfo)

Overrides:

setGetRankingInfo in class Query

getNumericFilters

public List<String> getNumericFilters()

Overrides:

getNumericFilters in class Query

setNumericFilters

public ConsequenceParams setNumericFilters(List<String> numericFilters)

Overrides:

setNumericFilters in class Query

getTagFilters

public List<String> getTagFilters()

Overrides:

getTagFilters in class Query

setTagFilters

public ConsequenceParams setTagFilters(List<String> tagFilters)

Overrides:

setTagFilters in class Query

getAnalytics

public Boolean getAnalytics()

Overrides:

getAnalytics in class Query

setAnalytics

public ConsequenceParams setAnalytics(Boolean analytics)

Overrides:

setAnalytics in class Query

getAnalyticsTags

public String getAnalyticsTags()

Overrides:

getAnalyticsTags in class Query

setAnalyticsTags

public ConsequenceParams setAnalyticsTags(String analyticsTags)

Overrides:

setAnalyticsTags in class Query

getSynonyms

public Boolean getSynonyms()

Overrides:

getSynonyms in class Query

setSynonyms

public ConsequenceParams setSynonyms(Boolean synonyms)

Overrides:

setSynonyms in class Query

getReplaceSynonymsInHighlight

public Boolean getReplaceSynonymsInHighlight()

Overrides:

getReplaceSynonymsInHighlight in class Query

setReplaceSynonymsInHighlight

public ConsequenceParams setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

Overrides:

setReplaceSynonymsInHighlight in class Query

getMinProximity

public Integer getMinProximity()

Overrides:

getMinProximity in class Query

setMinProximity

public ConsequenceParams setMinProximity(Integer minProximity)

Overrides:

setMinProximity in class Query

getResponseFields

public List<String> getResponseFields()

Overrides:

getResponseFields in class Query

setResponseFields

public ConsequenceParams setResponseFields(List<String> responseFields)

Overrides:

setResponseFields in class Query

getMaxFacetHits

public Long getMaxFacetHits()

Overrides:

getMaxFacetHits in class Query

setMaxFacetHits

public ConsequenceParams setMaxFacetHits(Long maxFacetHits)

Overrides:

setMaxFacetHits in class Query

setMaxFacetHits

@Deprecated
public ConsequenceParams setMaxFacetHits(Integer maxFacetHits)

Deprecated.

Overrides:

setMaxFacetHits in class Query

getPercentileComputation

public Boolean getPercentileComputation()

Overrides:

getPercentileComputation in class Query

setPercentileComputation

public ConsequenceParams setPercentileComputation(Boolean percentileComputation)

Overrides:

setPercentileComputation in class Query

getAttributesToRetrieve

public List<String> getAttributesToRetrieve()

Overrides:

getAttributesToRetrieve in class Query

setAttributesToRetrieve

public ConsequenceParams setAttributesToRetrieve(List<String> attributesToRetrieve)

Overrides:

setAttributesToRetrieve in class Query

getRestrictSearchableAttributes

public List<String> getRestrictSearchableAttributes()

Overrides:

getRestrictSearchableAttributes in class Query

setRestrictSearchableAttributes

public ConsequenceParams setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

Overrides:

setRestrictSearchableAttributes in class Query

getFilters

public String getFilters()

Overrides:

getFilters in class Query

setFilters

public ConsequenceParams setFilters(String filters)

Overrides:

setFilters in class Query

getFacets

public String getFacets()

Overrides:

getFacets in class Query

setFacets

public ConsequenceParams setFacets(String facets)

Overrides:

setFacets in class Query

getMaxValuesPerFacet

public Long getMaxValuesPerFacet()

Overrides:

getMaxValuesPerFacet in class Query

setMaxValuesPerFacet

public ConsequenceParams setMaxValuesPerFacet(Long maxValuesPerFacet)

Overrides:

setMaxValuesPerFacet in class Query

setMaxValuesPerFacet

@Deprecated
public ConsequenceParams setMaxValuesPerFacet(Integer maxValuesPerFacet)

Deprecated.

Overrides:

setMaxValuesPerFacet in class Query

getFacetFilters

public FacetFilters getFacetFilters()

Overrides:

getFacetFilters in class Query

setFacetFilters

@Deprecated
public ConsequenceParams setFacetFilters(List<String> facetFilters)

Deprecated.

Overrides:

setFacetFilters in class Query

setFacetFilters

public ConsequenceParams setFacetFilters(FacetFilters facetFilters)

Overrides:

setFacetFilters in class Query

getFacetingAfterDistinct

public Boolean getFacetingAfterDistinct()

Overrides:

getFacetingAfterDistinct in class Query

setFacetingAfterDistinct

public ConsequenceParams setFacetingAfterDistinct(Boolean facetingAfterDistinct)

Overrides:

setFacetingAfterDistinct in class Query

getAroundLatLng

public String getAroundLatLng()

Overrides:

getAroundLatLng in class Query

setAroundLatLng

public ConsequenceParams setAroundLatLng(String aroundLatLng)

Overrides:

setAroundLatLng in class Query

getAroundLatLngViaIP

public Boolean getAroundLatLngViaIP()

Overrides:

getAroundLatLngViaIP in class Query

setAroundLatLngViaIP

public ConsequenceParams setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

Overrides:

setAroundLatLngViaIP in class Query

getAroundRadius

public AroundRadius getAroundRadius()

Overrides:

getAroundRadius in class Query

setAroundRadius

public ConsequenceParams setAroundRadius(AroundRadius aroundRadius)

Overrides:

setAroundRadius in class Query

getAroundPrecision

public Integer getAroundPrecision()

Overrides:

getAroundPrecision in class Query

setAroundPrecision

public ConsequenceParams setAroundPrecision(Integer aroundPrecision)

Overrides:

setAroundPrecision in class Query

getMinimumAroundRadius

public Integer getMinimumAroundRadius()

Overrides:

getMinimumAroundRadius in class Query

setMinimumAroundRadius

public ConsequenceParams setMinimumAroundRadius(Integer minimumAroundRadius)

Overrides:

setMinimumAroundRadius in class Query

getInsideBoundingBox

public List<String> getInsideBoundingBox()

Overrides:

getInsideBoundingBox in class Query

setInsideBoundingBox

public ConsequenceParams setInsideBoundingBox(List<String> insideBoundingBox)

Overrides:

setInsideBoundingBox in class Query

getInsidePolygon

public List<String> getInsidePolygon()

Overrides:

getInsidePolygon in class Query

setInsidePolygon

public ConsequenceParams setInsidePolygon(List<String> insidePolygon)

Overrides:

setInsidePolygon in class Query

getAttributesToHighlight

public List<String> getAttributesToHighlight()

Overrides:

getAttributesToHighlight in class Query

setAttributesToHighlight

public ConsequenceParams setAttributesToHighlight(List<String> attributesToHighlight)

Overrides:

setAttributesToHighlight in class Query

getAttributesToSnippet

public List<String> getAttributesToSnippet()

Overrides:

getAttributesToSnippet in class Query

setAttributesToSnippet

public ConsequenceParams setAttributesToSnippet(List<String> attributesToSnippet)

Overrides:

setAttributesToSnippet in class Query

getHighlightPreTag

public String getHighlightPreTag()

Overrides:

getHighlightPreTag in class Query

setHighlightPreTag

public ConsequenceParams setHighlightPreTag(String highlightPreTag)

Overrides:

setHighlightPreTag in class Query

getHighlightPostTag

public String getHighlightPostTag()

Overrides:

getHighlightPostTag in class Query

setHighlightPostTag

public ConsequenceParams setHighlightPostTag(String highlightPostTag)

Overrides:

setHighlightPostTag in class Query

getSnippetEllipsisText

public String getSnippetEllipsisText()

Overrides:

getSnippetEllipsisText in class Query

setSnippetEllipsisText

public ConsequenceParams setSnippetEllipsisText(String snippetEllipsisText)

Overrides:

setSnippetEllipsisText in class Query

getRestrictHighlightAndSnippetArrays

public Boolean getRestrictHighlightAndSnippetArrays()

Overrides:

getRestrictHighlightAndSnippetArrays in class Query

setRestrictHighlightAndSnippetArrays

public ConsequenceParams setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

Overrides:

setRestrictHighlightAndSnippetArrays in class Query

getPage

public Long getPage()

Overrides:

getPage in class Query

setPage

public ConsequenceParams setPage(Long page)

Overrides:

setPage in class Query

setPage

public ConsequenceParams setPage(Integer page)

Overrides:

setPage in class Query

getHitsPerPage

public Long getHitsPerPage()

Overrides:

getHitsPerPage in class Query

setHitsPerPage

public ConsequenceParams setHitsPerPage(Long hitsPerPage)

Overrides:

setHitsPerPage in class Query

setHitsPerPage

@Deprecated
public ConsequenceParams setHitsPerPage(Integer hitsPerPage)

Deprecated.

Overrides:

setHitsPerPage in class Query

getOffset

public Long getOffset()

Overrides:

getOffset in class Query

setOffset

public ConsequenceParams setOffset(Long offset)

Overrides:

setOffset in class Query

setOffset

public ConsequenceParams setOffset(Integer offset)

Overrides:

setOffset in class Query

getLength

public Long getLength()

Overrides:

getLength in class Query

setLength

public ConsequenceParams setLength(Long length)

Overrides:

setLength in class Query

setLength

@Deprecated
public ConsequenceParams setLength(Integer length)

Deprecated.

Overrides:

setLength in class Query

getQueryType

public String getQueryType()

Overrides:

getQueryType in class Query

setQueryType

public ConsequenceParams setQueryType(String queryType)

Overrides:

setQueryType in class Query

getRemoveWordsIfNoResults

public Query.RemoveWordsType getRemoveWordsIfNoResults()

Overrides:

getRemoveWordsIfNoResults in class Query

setRemoveWordsIfNoResults

public ConsequenceParams setRemoveWordsIfNoResults(Query.RemoveWordsType removeWordsIfNoResults)

Overrides:

setRemoveWordsIfNoResults in class Query

getAdvancedSyntax

public Boolean getAdvancedSyntax()

Overrides:

getAdvancedSyntax in class Query

setAdvancedSyntax

public ConsequenceParams setAdvancedSyntax(Boolean advancedSyntax)

Overrides:

setAdvancedSyntax in class Query

getOptionalWords

public List<String> getOptionalWords()

Overrides:

getOptionalWords in class Query

setOptionalWords

public ConsequenceParams setOptionalWords(List<String> optionalWords)

Overrides:

setOptionalWords in class Query

getRemoveStopWords

public RemoveStopWords getRemoveStopWords()

Overrides:

getRemoveStopWords in class Query

setRemoveStopWords

public ConsequenceParams setRemoveStopWords(RemoveStopWords removeStopWords)

Overrides:

setRemoveStopWords in class Query

getDisableExactOnAttributes

public List<String> getDisableExactOnAttributes()

Overrides:

getDisableExactOnAttributes in class Query

setDisableExactOnAttributes

public ConsequenceParams setDisableExactOnAttributes(List<String> disableExactOnAttributes)

Overrides:

setDisableExactOnAttributes in class Query

getExactOnSingleWordQuery

public String getExactOnSingleWordQuery()

Overrides:

getExactOnSingleWordQuery in class Query

setExactOnSingleWordQuery

public ConsequenceParams setExactOnSingleWordQuery(String exactOnSingleWordQuery)

Overrides:

setExactOnSingleWordQuery in class Query

getAlternativesAsExact

public List<String> getAlternativesAsExact()

Overrides:

getAlternativesAsExact in class Query

setAlternativesAsExact

public ConsequenceParams setAlternativesAsExact(List<String> alternativesAsExact)

Overrides:

setAlternativesAsExact in class Query

getMinWordSizefor1Typo

public Integer getMinWordSizefor1Typo()

Overrides:

getMinWordSizefor1Typo in class Query

setMinWordSizefor1Typo

public ConsequenceParams setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

Overrides:

setMinWordSizefor1Typo in class Query

getMinWordSizefor2Typos

public Integer getMinWordSizefor2Typos()

Overrides:

getMinWordSizefor2Typos in class Query

setMinWordSizefor2Typos

public ConsequenceParams setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

Overrides:

setMinWordSizefor2Typos in class Query

getTypoTolerance

public TypoTolerance getTypoTolerance()

Overrides:

getTypoTolerance in class Query

setTypoTolerance

public ConsequenceParams setTypoTolerance(TypoTolerance typoTolerance)

Overrides:

setTypoTolerance in class Query

getAllowTyposOnNumericTokens

public Boolean getAllowTyposOnNumericTokens()

Overrides:

getAllowTyposOnNumericTokens in class Query

setAllowTyposOnNumericTokens

public ConsequenceParams setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

Overrides:

setAllowTyposOnNumericTokens in class Query

getIgnorePlurals

public IgnorePlurals getIgnorePlurals()

Overrides:

getIgnorePlurals in class Query

setIgnorePlurals

public ConsequenceParams setIgnorePlurals(IgnorePlurals ignorePlurals)

Overrides:

setIgnorePlurals in class Query

getDisableTypoToleranceOnAttributes

public List<String> getDisableTypoToleranceOnAttributes()

Overrides:

getDisableTypoToleranceOnAttributes in class Query

setDisableTypoToleranceOnAttributes

public ConsequenceParams setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

Overrides:

setDisableTypoToleranceOnAttributes in class Query

addCustomParameter

public ConsequenceParams addCustomParameter(String key,
                                            String value)

Overrides:

addCustomParameter in class Query