Class SearchParameters<T extends SearchParameters<T>>

    • Field Detail

      • query

        protected String query
      • similarQuery

        protected String similarQuery
      • getRankingInfo

        protected Boolean getRankingInfo
      • naturalLanguages

        protected List<String> naturalLanguages
      • clickAnalytics

        protected Boolean clickAnalytics
      • analytics

        protected Boolean analytics
      • analyticsTags

        protected List<String> analyticsTags
      • synonyms

        protected Boolean synonyms
      • replaceSynonymsInHighlight

        protected Boolean replaceSynonymsInHighlight
      • minProximity

        protected Integer minProximity
      • responseFields

        protected List<String> responseFields
      • maxFacetHits

        protected Long maxFacetHits
      • percentileComputation

        protected Boolean percentileComputation
      • queryLanguages

        protected List<String> queryLanguages
      • decompoundQuery

        protected Boolean decompoundQuery
      • enableReRanking

        protected Boolean enableReRanking
      • attributesToRetrieve

        protected List<String> attributesToRetrieve
      • restrictSearchableAttributes

        protected List<String> restrictSearchableAttributes
      • filters

        protected String filters
      • maxValuesPerFacet

        protected Long maxValuesPerFacet
      • facetingAfterDistinct

        protected Boolean facetingAfterDistinct
      • sortFacetValuesBy

        protected String sortFacetValuesBy
      • aroundLatLng

        protected String aroundLatLng
      • aroundLatLngViaIP

        protected Boolean aroundLatLngViaIP
      • minimumAroundRadius

        protected Integer minimumAroundRadius
      • insideBoundingBox

        protected List<List<Float>> insideBoundingBox
      • attributesToHighlight

        protected List<String> attributesToHighlight
      • attributesToSnippet

        protected List<String> attributesToSnippet
      • highlightPreTag

        protected String highlightPreTag
      • highlightPostTag

        protected String highlightPostTag
      • snippetEllipsisText

        protected String snippetEllipsisText
      • restrictHighlightAndSnippetArrays

        protected Boolean restrictHighlightAndSnippetArrays
      • hitsPerPage

        protected Integer hitsPerPage
      • enableRules

        protected Boolean enableRules
      • ruleContexts

        protected List<String> ruleContexts
      • queryType

        protected String queryType
      • advancedSyntax

        protected Boolean advancedSyntax
      • advancedSyntaxFeatures

        protected List<String> advancedSyntaxFeatures
      • optionalWords

        protected List<String> optionalWords
      • disableExactOnAttributes

        protected List<String> disableExactOnAttributes
      • exactOnSingleWordQuery

        protected String exactOnSingleWordQuery
      • alternativesAsExact

        protected List<String> alternativesAsExact
      • sumOrFiltersScores

        protected Boolean sumOrFiltersScores
      • minWordSizefor1Typo

        protected Integer minWordSizefor1Typo
      • minWordSizefor2Typos

        protected Integer minWordSizefor2Typos
      • allowTyposOnNumericTokens

        protected Boolean allowTyposOnNumericTokens
      • disableTypoToleranceOnAttributes

        protected List<String> disableTypoToleranceOnAttributes
      • userToken

        protected String userToken
      • validUntil

        protected Integer validUntil
      • restrictIndices

        protected List<String> restrictIndices
      • restrictSources

        protected String restrictSources
      • enablePersonalization

        protected Boolean enablePersonalization
      • personalizationImpact

        protected Integer personalizationImpact
      • enableABTest

        protected Boolean enableABTest
      • relevancyStrictness

        protected Integer relevancyStrictness
    • Constructor Detail

      • SearchParameters

        public SearchParameters()
    • Method Detail

      • getThis

        public abstract T getThis()
        To prevent unchecked cast warning.
      • getQuery

        public String getQuery()
      • setQuery

        public T setQuery​(String query)
      • getSimilarQuery

        public String getSimilarQuery()
      • setSimilarQuery

        public T setSimilarQuery​(String similarQuery)
      • getGetRankingInfo

        public Boolean getGetRankingInfo()
      • setGetRankingInfo

        public T setGetRankingInfo​(Boolean getRankingInfo)
      • setExplain

        public T setExplain​(List<String> explain)
      • getNaturalLanguages

        public List<String> getNaturalLanguages()
      • setNaturalLanguages

        public T setNaturalLanguages​(List<String> naturalLanguages)
      • setNumericFilters

        public T setNumericFilters​(List<List<String>> numericFilters)
      • setTagFilters

        public T setTagFilters​(List<List<String>> tagFilters)
      • getClickAnalytics

        public Boolean getClickAnalytics()
      • setClickAnalytics

        public T setClickAnalytics​(Boolean clickAnalytics)
      • getAnalytics

        public Boolean getAnalytics()
      • setAnalytics

        public T setAnalytics​(Boolean analytics)
      • getAnalyticsTags

        public List<String> getAnalyticsTags()
      • setAnalyticsTags

        public T setAnalyticsTags​(List<String> analyticsTags)
      • getSynonyms

        public Boolean getSynonyms()
      • setSynonyms

        public T setSynonyms​(Boolean synonyms)
      • getReplaceSynonymsInHighlight

        public Boolean getReplaceSynonymsInHighlight()
      • setReplaceSynonymsInHighlight

        public T setReplaceSynonymsInHighlight​(Boolean replaceSynonymsInHighlight)
      • getMinProximity

        public Integer getMinProximity()
      • setMinProximity

        public T setMinProximity​(Integer minProximity)
      • getResponseFields

        public List<String> getResponseFields()
      • setResponseFields

        public T setResponseFields​(List<String> responseFields)
      • getMaxFacetHits

        public Long getMaxFacetHits()
      • setMaxFacetHits

        public T setMaxFacetHits​(Long maxFacetHits)
      • getPercentileComputation

        public Boolean getPercentileComputation()
      • setPercentileComputation

        public T setPercentileComputation​(Boolean percentileComputation)
      • getQueryLanguages

        public List<String> getQueryLanguages()
      • setQueryLanguages

        public T setQueryLanguages​(List<String> queryLanguages)
      • getAttributesToRetrieve

        public List<String> getAttributesToRetrieve()
      • setAttributesToRetrieve

        public T setAttributesToRetrieve​(List<String> attributesToRetrieve)
      • getRestrictSearchableAttributes

        public List<String> getRestrictSearchableAttributes()
      • setRestrictSearchableAttributes

        public T setRestrictSearchableAttributes​(List<String> restrictSearchableAttributes)
      • getFilters

        public String getFilters()
      • setFilters

        public T setFilters​(String filters)
      • setFacets

        public T setFacets​(List<String> facets)
      • getMaxValuesPerFacet

        public Long getMaxValuesPerFacet()
      • setMaxValuesPerFacet

        public T setMaxValuesPerFacet​(Long maxValuesPerFacet)
      • getFacetingAfterDistinct

        public Boolean getFacetingAfterDistinct()
      • setFacetingAfterDistinct

        public T setFacetingAfterDistinct​(Boolean facetingAfterDistinct)
      • getSortFacetValuesBy

        public String getSortFacetValuesBy()
      • setSortFacetValuesBy

        public T setSortFacetValuesBy​(String sortFacetValuesBy)
      • getAroundLatLng

        public String getAroundLatLng()
      • setAroundLatLng

        public T setAroundLatLng​(String aroundLatLng)
      • getAroundLatLngViaIP

        public Boolean getAroundLatLngViaIP()
      • setAroundLatLngViaIP

        public T setAroundLatLngViaIP​(Boolean aroundLatLngViaIP)
      • getMinimumAroundRadius

        public Integer getMinimumAroundRadius()
      • setMinimumAroundRadius

        public T setMinimumAroundRadius​(Integer minimumAroundRadius)
      • getInsideBoundingBox

        public List<List<Float>> getInsideBoundingBox()
      • setInsideBoundingBox

        public T setInsideBoundingBox​(List<List<Float>> insideBoundingBox)
      • setInsidePolygon

        public T setInsidePolygon​(List<List<Float>> insidePolygon)
      • getAttributesToHighlight

        public List<String> getAttributesToHighlight()
      • setAttributesToHighlight

        public T setAttributesToHighlight​(List<String> attributesToHighlight)
      • getAttributesToSnippet

        public List<String> getAttributesToSnippet()
      • setAttributesToSnippet

        public T setAttributesToSnippet​(List<String> attributesToSnippet)
      • getHighlightPreTag

        public String getHighlightPreTag()
      • setHighlightPreTag

        public T setHighlightPreTag​(String highlightPreTag)
      • getHighlightPostTag

        public String getHighlightPostTag()
      • setHighlightPostTag

        public T setHighlightPostTag​(String highlightPostTag)
      • getSnippetEllipsisText

        public String getSnippetEllipsisText()
      • setSnippetEllipsisText

        public T setSnippetEllipsisText​(String snippetEllipsisText)
      • getRestrictHighlightAndSnippetArrays

        public Boolean getRestrictHighlightAndSnippetArrays()
      • setRestrictHighlightAndSnippetArrays

        public T setRestrictHighlightAndSnippetArrays​(Boolean restrictHighlightAndSnippetArrays)
      • getPage

        public Integer getPage()
      • setPage

        public T setPage​(Integer page)
      • getHitsPerPage

        public Integer getHitsPerPage()
      • setHitsPerPage

        public T setHitsPerPage​(Integer hitsPerPage)
      • getOffset

        public Integer getOffset()
      • setOffset

        public T setOffset​(Integer offset)
      • getLength

        public Integer getLength()
      • setLength

        public T setLength​(Integer length)
      • getEnableRules

        public Boolean getEnableRules()
      • setEnableRules

        public T setEnableRules​(Boolean enableRules)
      • getRuleContexts

        public List<String> getRuleContexts()
      • setRuleContexts

        public T setRuleContexts​(List<String> ruleContexts)
      • getQueryType

        public String getQueryType()
      • setQueryType

        public T setQueryType​(String queryType)
      • getAdvancedSyntax

        public Boolean getAdvancedSyntax()
      • setAdvancedSyntax

        public T setAdvancedSyntax​(Boolean advancedSyntax)
      • getAdvancedSyntaxFeatures

        public List<String> getAdvancedSyntaxFeatures()
      • setAdvancedSyntaxFeatures

        public T setAdvancedSyntaxFeatures​(List<String> advancedSyntaxFeatures)
      • getOptionalWords

        public List<String> getOptionalWords()
      • setOptionalWords

        public T setOptionalWords​(List<String> optionalWords)
      • getDisableExactOnAttributes

        public List<String> getDisableExactOnAttributes()
      • setDisableExactOnAttributes

        public T setDisableExactOnAttributes​(List<String> disableExactOnAttributes)
      • getExactOnSingleWordQuery

        public String getExactOnSingleWordQuery()
      • setExactOnSingleWordQuery

        public T setExactOnSingleWordQuery​(String exactOnSingleWordQuery)
      • getAlternativesAsExact

        public List<String> getAlternativesAsExact()
      • setAlternativesAsExact

        public T setAlternativesAsExact​(List<String> alternativesAsExact)
      • getMinWordSizefor1Typo

        public Integer getMinWordSizefor1Typo()
      • setMinWordSizefor1Typo

        public T setMinWordSizefor1Typo​(Integer minWordSizefor1Typo)
      • getMinWordSizefor2Typos

        public Integer getMinWordSizefor2Typos()
      • setMinWordSizefor2Typos

        public T setMinWordSizefor2Typos​(Integer minWordSizefor2Typos)
      • getAllowTyposOnNumericTokens

        public Boolean getAllowTyposOnNumericTokens()
      • setAllowTyposOnNumericTokens

        public T setAllowTyposOnNumericTokens​(Boolean allowTyposOnNumericTokens)
      • getDisableTypoToleranceOnAttributes

        public List<String> getDisableTypoToleranceOnAttributes()
      • setDisableTypoToleranceOnAttributes

        public T setDisableTypoToleranceOnAttributes​(List<String> disableTypoToleranceOnAttributes)
      • getUserToken

        public String getUserToken()
      • setUserToken

        public T setUserToken​(String userToken)
      • getValidUntil

        public Integer getValidUntil()
      • setValidUntil

        public T setValidUntil​(Integer validUntil)
      • getRestrictIndices

        public List<String> getRestrictIndices()
      • setRestrictIndices

        public T setRestrictIndices​(List<String> restrictIndices)
      • getRestrictSources

        public String getRestrictSources()
      • setRestrictSources

        public T setRestrictSources​(String restrictSources)
      • getEnablePersonalization

        public Boolean getEnablePersonalization()
      • setEnablePersonalization

        public T setEnablePersonalization​(Boolean enablePersonalization)
      • getPersonalizationImpact

        public Integer getPersonalizationImpact()
      • setPersonalizationImpact

        public T setPersonalizationImpact​(Integer personalizationImpact)
      • setFacetFilters

        public T setFacetFilters​(List<List<String>> facetFilters)
      • getDistinct

        public Distinct getDistinct()
      • setDistinct

        public T setDistinct​(Distinct distinct)
      • setAroundRadius

        public T setAroundRadius​(AroundRadius aroundRadius)
      • getRemoveWordsIfNoResults

        public RemoveWordsType getRemoveWordsIfNoResults()
      • setRemoveWordsIfNoResults

        public T setRemoveWordsIfNoResults​(RemoveWordsType removeWordsIfNoResults)
      • setRemoveStopWords

        public T setRemoveStopWords​(RemoveStopWords removeStopWords)
      • setTypoTolerance

        public T setTypoTolerance​(TypoTolerance typoTolerance)
      • setIgnorePlurals

        public T setIgnorePlurals​(IgnorePlurals ignorePlurals)
      • setOptionalFilters

        public T setOptionalFilters​(List<List<String>> optionalFilters)
      • getSumOrFiltersScores

        public Boolean getSumOrFiltersScores()
      • setSumOrFiltersScores

        public T setSumOrFiltersScores​(Boolean sumOrFiltersScores)
      • getEnableABTest

        public Boolean getEnableABTest()
      • setEnableABTest

        public T setEnableABTest​(Boolean enableABTest)
      • getDecompoundQuery

        public Boolean getDecompoundQuery()
      • setDecompoundQuery

        public T setDecompoundQuery​(Boolean decompoundQuery)
      • setCustomParameters

        public T setCustomParameters​(Map<String,​Object> customSettings)
      • setCustomParameter

        public T setCustomParameter​(String key,
                                    Object value)
      • getRelevancyStrictness

        public Integer getRelevancyStrictness()
      • setRelevancyStrictness

        public T setRelevancyStrictness​(Integer relevancyStrictness)
      • getEnableReRanking

        public Boolean getEnableReRanking()
      • setEnableReRanking

        public T setEnableReRanking​(Boolean enableReRanking)
      • toParam

        public String toParam()