Class SearchParameters<T extends SearchParameters<T>>
- java.lang.Object
-
- com.algolia.search.models.indexing.SearchParameters<T>
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
BrowseIndexQuery,ConsequenceParams,Query
public abstract class SearchParameters<T extends SearchParameters<T>> extends Object implements Serializable
- See Also:
- Serialized Form
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description SearchParameters()
-
Method Summary
-
-
-
Field Detail
-
query
protected String query
-
similarQuery
protected String similarQuery
-
distinct
protected Distinct distinct
-
getRankingInfo
protected Boolean getRankingInfo
-
clickAnalytics
protected Boolean clickAnalytics
-
analytics
protected Boolean analytics
-
synonyms
protected Boolean synonyms
-
replaceSynonymsInHighlight
protected Boolean replaceSynonymsInHighlight
-
minProximity
protected Integer minProximity
-
maxFacetHits
protected Long maxFacetHits
-
percentileComputation
protected Boolean percentileComputation
-
decompoundQuery
protected Boolean decompoundQuery
-
enableReRanking
protected Boolean enableReRanking
-
filters
protected String filters
-
maxValuesPerFacet
protected Long maxValuesPerFacet
-
facetingAfterDistinct
protected Boolean facetingAfterDistinct
-
sortFacetValuesBy
protected String sortFacetValuesBy
-
aroundLatLng
protected String aroundLatLng
-
aroundLatLngViaIP
protected Boolean aroundLatLngViaIP
-
aroundRadius
protected AroundRadius aroundRadius
-
aroundPrecision
protected List<AroundPrecision> aroundPrecision
-
minimumAroundRadius
protected Integer minimumAroundRadius
-
highlightPreTag
protected String highlightPreTag
-
highlightPostTag
protected String highlightPostTag
-
snippetEllipsisText
protected String snippetEllipsisText
-
restrictHighlightAndSnippetArrays
protected Boolean restrictHighlightAndSnippetArrays
-
page
protected Integer page
-
hitsPerPage
protected Integer hitsPerPage
-
offset
protected Integer offset
-
length
protected Integer length
-
enableRules
protected Boolean enableRules
-
queryType
protected String queryType
-
removeWordsIfNoResults
protected RemoveWordsType removeWordsIfNoResults
-
advancedSyntax
protected Boolean advancedSyntax
-
removeStopWords
protected RemoveStopWords removeStopWords
-
exactOnSingleWordQuery
protected String exactOnSingleWordQuery
-
sumOrFiltersScores
protected Boolean sumOrFiltersScores
-
minWordSizefor1Typo
protected Integer minWordSizefor1Typo
-
minWordSizefor2Typos
protected Integer minWordSizefor2Typos
-
typoTolerance
protected TypoTolerance typoTolerance
-
allowTyposOnNumericTokens
protected Boolean allowTyposOnNumericTokens
-
ignorePlurals
protected IgnorePlurals ignorePlurals
-
userToken
protected String userToken
-
validUntil
protected Integer validUntil
-
restrictSources
protected String restrictSources
-
enablePersonalization
protected Boolean enablePersonalization
-
personalizationImpact
protected Integer personalizationImpact
-
enableABTest
protected Boolean enableABTest
-
relevancyStrictness
protected Integer relevancyStrictness
-
-
Method Detail
-
getThis
public abstract T getThis()
To prevent unchecked cast warning.
-
getQuery
public String getQuery()
-
getSimilarQuery
public String getSimilarQuery()
-
getGetRankingInfo
public Boolean getGetRankingInfo()
-
getClickAnalytics
public Boolean getClickAnalytics()
-
getAnalytics
public Boolean getAnalytics()
-
getSynonyms
public Boolean getSynonyms()
-
getReplaceSynonymsInHighlight
public Boolean getReplaceSynonymsInHighlight()
-
setReplaceSynonymsInHighlight
public T setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)
-
getMinProximity
public Integer getMinProximity()
-
getMaxFacetHits
public Long getMaxFacetHits()
-
getPercentileComputation
public Boolean getPercentileComputation()
-
setRestrictSearchableAttributes
public T setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)
-
getFilters
public String getFilters()
-
getMaxValuesPerFacet
public Long getMaxValuesPerFacet()
-
getFacetingAfterDistinct
public Boolean getFacetingAfterDistinct()
-
getSortFacetValuesBy
public String getSortFacetValuesBy()
-
getAroundLatLng
public String getAroundLatLng()
-
getAroundLatLngViaIP
public Boolean getAroundLatLngViaIP()
-
getAroundPrecision
public List<AroundPrecision> getAroundPrecision()
-
setAroundPrecision
public T setAroundPrecision(List<AroundPrecision> aroundPrecision)
-
getMinimumAroundRadius
public Integer getMinimumAroundRadius()
-
getHighlightPreTag
public String getHighlightPreTag()
-
getHighlightPostTag
public String getHighlightPostTag()
-
getSnippetEllipsisText
public String getSnippetEllipsisText()
-
getRestrictHighlightAndSnippetArrays
public Boolean getRestrictHighlightAndSnippetArrays()
-
setRestrictHighlightAndSnippetArrays
public T setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)
-
getPage
public Integer getPage()
-
getHitsPerPage
public Integer getHitsPerPage()
-
getOffset
public Integer getOffset()
-
getLength
public Integer getLength()
-
getEnableRules
public Boolean getEnableRules()
-
getQueryType
public String getQueryType()
-
getAdvancedSyntax
public Boolean getAdvancedSyntax()
-
setDisableExactOnAttributes
public T setDisableExactOnAttributes(List<String> disableExactOnAttributes)
-
getExactOnSingleWordQuery
public String getExactOnSingleWordQuery()
-
getMinWordSizefor1Typo
public Integer getMinWordSizefor1Typo()
-
getMinWordSizefor2Typos
public Integer getMinWordSizefor2Typos()
-
getAllowTyposOnNumericTokens
public Boolean getAllowTyposOnNumericTokens()
-
setAllowTyposOnNumericTokens
public T setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)
-
setDisableTypoToleranceOnAttributes
public T setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)
-
getUserToken
public String getUserToken()
-
getValidUntil
public Integer getValidUntil()
-
getRestrictSources
public String getRestrictSources()
-
getEnablePersonalization
public Boolean getEnablePersonalization()
-
getPersonalizationImpact
public Integer getPersonalizationImpact()
-
getDistinct
public Distinct getDistinct()
-
getAroundRadius
public AroundRadius getAroundRadius()
-
setAroundRadius
public T setAroundRadius(AroundRadius aroundRadius)
-
getRemoveWordsIfNoResults
public RemoveWordsType getRemoveWordsIfNoResults()
-
setRemoveWordsIfNoResults
public T setRemoveWordsIfNoResults(RemoveWordsType removeWordsIfNoResults)
-
getRemoveStopWords
public RemoveStopWords getRemoveStopWords()
-
setRemoveStopWords
public T setRemoveStopWords(RemoveStopWords removeStopWords)
-
getTypoTolerance
public TypoTolerance getTypoTolerance()
-
setTypoTolerance
public T setTypoTolerance(TypoTolerance typoTolerance)
-
getIgnorePlurals
public IgnorePlurals getIgnorePlurals()
-
setIgnorePlurals
public T setIgnorePlurals(IgnorePlurals ignorePlurals)
-
getSumOrFiltersScores
public Boolean getSumOrFiltersScores()
-
getEnableABTest
public Boolean getEnableABTest()
-
getDecompoundQuery
public Boolean getDecompoundQuery()
-
getRelevancyStrictness
public Integer getRelevancyStrictness()
-
getEnableReRanking
public Boolean getEnableReRanking()
-
toParam
public String toParam()
-
-