com.independentsoft.share

Class SearchQuery

java.lang.Object

com.independentsoft.share.SearchQuery

public class SearchQuery
extends java.lang.Object

The Class SearchQuery.

Constructor Summary

Constructors

Constructor and Description
SearchQuery() Instantiates a new search query.
SearchQuery(IRestriction restriction) Instantiates a new search query.
SearchQuery(IRestriction restriction) Instantiates a new search query.
SearchQuery(java.lang.String query) Instantiates a new search query.

Method Summary

Modifier and Type	Method and Description
void	enableFql(boolean enableFql) Enable fql.
void	enableInterleaving(boolean enableInterleaving) Enable interleaving.
void	enableNicknames(boolean enableNicknames) Enable nicknames.
void	enableOrderingHitHighlightedProperty(boolean enableOrderingHitHighlightedProperty) Enable ordering hit highlighted property.
void	enablePhonetic(boolean enablePhonetic) Enable phonetic.
void	enableQueryRules(boolean enableQueryRules) Enable query rules.
void	enableSorting(boolean enableSorting) Enable sorting.
void	enableStemming(boolean enableStemming) Enable stemming.
QueryLogClientType	getClientType() Gets the client type.
java.lang.String	getCollapseSpecification() Gets the collapse specification.
Locale	getCulture() Gets the culture.
int	getDesiredSnippetLength() Gets the desired snippet length.
java.lang.String	getHiddenConstraints() Gets the hidden constraints.
int	getHitHighlightedMultivaluePropertyLimit() Gets the hit highlighted multivalue property limit.
java.util.List<java.lang.String>	getHitHighlightedProperties() Gets the hit highlighted properties.
int	getMaxSnippetLength() Gets the max snippet length.
java.lang.String	getPersonalizationData() Gets the personalization data.
java.util.List<SearchQueryProperty>	getProperties() Gets the properties.
java.lang.String	getQuery() Gets the query.
java.lang.String	getQueryTemplatePropertiesUrl() Gets the query template properties url.
java.lang.String	getRankingModelId() Gets the ranking model id.
java.util.List<java.lang.String>	getRefinementFilters() Gets the refinement filters.
java.util.List<java.lang.String>	getRefiners() Gets the refiners.
java.util.List<ReorderingRule>	getReorderingRules() Gets the reordering rules.
java.lang.String	getResultsUrl() Gets the results url.
int	getRowLimit() Gets the row limit.
int	getRowsPerPage() Gets the rows per page.
java.util.List<java.lang.String>	getSelectProperties() Gets the select properties.
java.util.List<Sort>	getSortList() Gets the sort list.
java.lang.String	getSourceId() Gets the source id.
int	getStartRow() Gets the start row.
int	getSummaryLength() Gets the summary length.
java.util.List<java.lang.String>	getTags() Gets the tags.
java.lang.String	getTemplate() Gets the template.
int	getTimeout() Gets the timeout.
Locale	getUILanguage() Gets the UI language.
boolean	hasNicknamesEnabled() Checks for nicknames enabled.
boolean	hasQueryRulesEnabled() Checks for query rules enabled.
boolean	isBypassResultTypes() Checks if is bypass result types.
boolean	isFqlEnabled() Checks if is fql enabled.
boolean	isGenerateBlockRankLog() Checks if is generate block rank log.
boolean	isInterleavingEnabled() Checks if is interleaving enabled.
boolean	isOrderingHitHighlightedPropertyEnabled() Checks if is ordering hit highlighted property enabled.
boolean	isPhoneticEnabled() Checks if is phonetic enabled.
boolean	isProcessBestBets() Checks if is process best bets.
boolean	isProcessPersonalFavorites() Checks if is process personal favorites.
boolean	isSortingEnabled() Checks if is sorting enabled.
boolean	isStemmingEnabled() Checks if is stemming enabled.
boolean	isTrimDuplicates() Checks if is trim duplicates.
void	setBypassResultTypes(boolean bypassResultTypes) Sets the bypass result types.
void	setClientType(QueryLogClientType clientType) Sets the client type.
void	setCollapseSpecification(java.lang.String collapseSpecification) Sets the collapse specification.
void	setCulture(Locale culture) Sets the culture.
void	setDesiredSnippetLength(int desiredSnippetLength) Sets the desired snippet length.
void	setGenerateBlockRankLog(boolean generateBlockRankLog) Sets the generate block rank log.
void	setHiddenConstraints(java.lang.String hiddenConstraints) Sets the hidden constraints.
void	setHitHighlightedMultivaluePropertyLimit(int hitHighlightedMultivaluePropertyLimit) Sets the hit highlighted multivalue property limit.
void	setMaxSnippetLength(int maxSnippetLength) Sets the max snippet length.
void	setPersonalizationData(java.lang.String personalizationData) Sets the personalization data.
void	setProcessBestBets(boolean processBestBets) Sets the process best bets.
void	setProcessPersonalFavorites(boolean processPersonalFavorites) Sets the process personal favorites.
void	setQuery(java.lang.String query) Sets the query.
void	setQueryTemplatePropertiesUrl(java.lang.String queryTemplatePropertiesUrl) Sets the query template properties url.
void	setRankingModelId(java.lang.String rankingModelId) Sets the ranking model id.
void	setResultsUrl(java.lang.String resultsUrl) Sets the results url.
void	setRowLimit(int rowLimit) Sets the row limit.
void	setRowsPerPage(int rowsPerPage) Sets the rows per page.
void	setSourceId(java.lang.String sourceId) Sets the source id.
void	setStartRow(int startRow) Sets the start row.
void	setSummaryLength(int summaryLength) Sets the summary length.
void	setTemplate(java.lang.String template) Sets the template.
void	setTimeout(int timeout) Sets the timeout.
void	setTrimDuplicates(boolean trimDuplicates) Sets the trim duplicates.
void	setUILanguage(Locale uiLanguage) Sets the UI language.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchQuery

public SearchQuery()

Instantiates a new search query.

SearchQuery

public SearchQuery(IRestriction restriction)

Instantiates a new search query.

Parameters:

restriction - the restriction

SearchQuery

public SearchQuery(IRestriction restriction)

Instantiates a new search query.

Parameters:

restriction - the restriction

SearchQuery

public SearchQuery(java.lang.String query)

Instantiates a new search query.

Parameters:

query - the query

Method Detail

enableFql

public void enableFql(boolean enableFql)

Enable fql.

Parameters:

enableFql - the enable fql

enableInterleaving

public void enableInterleaving(boolean enableInterleaving)

Enable interleaving.

Parameters:

enableInterleaving - the enable interleaving

enableNicknames

public void enableNicknames(boolean enableNicknames)

Enable nicknames.

Parameters:

enableNicknames - the enable nicknames

enableOrderingHitHighlightedProperty

public void enableOrderingHitHighlightedProperty(boolean enableOrderingHitHighlightedProperty)

Enable ordering hit highlighted property.

Parameters:

enableOrderingHitHighlightedProperty - the enable ordering hit highlighted property

enablePhonetic

public void enablePhonetic(boolean enablePhonetic)

Enable phonetic.

Parameters:

enablePhonetic - the enable phonetic

enableQueryRules

public void enableQueryRules(boolean enableQueryRules)

Enable query rules.

Parameters:

enableQueryRules - the enable query rules

enableSorting

public void enableSorting(boolean enableSorting)

Enable sorting.

Parameters:

enableSorting - the enable sorting

enableStemming

public void enableStemming(boolean enableStemming)

Enable stemming.

Parameters:

enableStemming - the enable stemming

getClientType

public QueryLogClientType getClientType()

Gets the client type.

Returns:

the client type

getCollapseSpecification

public java.lang.String getCollapseSpecification()

Gets the collapse specification.

Returns:

the collapse specification

getCulture

public Locale getCulture()

Gets the culture.

Returns:

the culture

getDesiredSnippetLength

public int getDesiredSnippetLength()

Gets the desired snippet length.

Returns:

the desired snippet length

getHiddenConstraints

public java.lang.String getHiddenConstraints()

Gets the hidden constraints.

Returns:

the hidden constraints

getHitHighlightedMultivaluePropertyLimit

public int getHitHighlightedMultivaluePropertyLimit()

Gets the hit highlighted multivalue property limit.

Returns:

the hit highlighted multivalue property limit

getHitHighlightedProperties

public java.util.List<java.lang.String> getHitHighlightedProperties()

Gets the hit highlighted properties.

Returns:

the hit highlighted properties

getMaxSnippetLength

public int getMaxSnippetLength()

Gets the max snippet length.

Returns:

the max snippet length

getPersonalizationData

public java.lang.String getPersonalizationData()

Gets the personalization data.

Returns:

the personalization data

getProperties

public java.util.List<SearchQueryProperty> getProperties()

Gets the properties.

Returns:

the properties

getQuery

public java.lang.String getQuery()

Gets the query.

Returns:

the query

getQueryTemplatePropertiesUrl

public java.lang.String getQueryTemplatePropertiesUrl()

Gets the query template properties url.

Returns:

the query template properties url

getRankingModelId

public java.lang.String getRankingModelId()

Gets the ranking model id.

Returns:

the ranking model id

getRefinementFilters

public java.util.List<java.lang.String> getRefinementFilters()

Gets the refinement filters.

Returns:

the refinement filters

getRefiners

public java.util.List<java.lang.String> getRefiners()

Gets the refiners.

Returns:

the refiners

getReorderingRules

public java.util.List<ReorderingRule> getReorderingRules()

Gets the reordering rules.

Returns:

the reordering rules

getResultsUrl

public java.lang.String getResultsUrl()

Gets the results url.

Returns:

the results url

getRowLimit

public int getRowLimit()

Gets the row limit.

Returns:

the row limit

getRowsPerPage

public int getRowsPerPage()

Gets the rows per page.

Returns:

the rows per page

getSelectProperties

public java.util.List<java.lang.String> getSelectProperties()

Gets the select properties.

Returns:

the select properties

getSortList

public java.util.List<Sort> getSortList()

Gets the sort list.

Returns:

the sort list

getSourceId

public java.lang.String getSourceId()

Gets the source id.

Returns:

the source id

getStartRow

public int getStartRow()

Gets the start row.

Returns:

the start row

getSummaryLength

public int getSummaryLength()

Gets the summary length.

Returns:

the summary length

getTags

public java.util.List<java.lang.String> getTags()

Gets the tags.

Returns:

the tags

getTemplate

public java.lang.String getTemplate()

Gets the template.

Returns:

the template

getTimeout

public int getTimeout()

Gets the timeout.

Returns:

the timeout

getUILanguage

public Locale getUILanguage()

Gets the UI language.

Returns:

the UI language

hasNicknamesEnabled

public boolean hasNicknamesEnabled()

Checks for nicknames enabled.

Returns:

true, if successful

hasQueryRulesEnabled

public boolean hasQueryRulesEnabled()

Checks for query rules enabled.

Returns:

true, if successful

isBypassResultTypes

public boolean isBypassResultTypes()

Checks if is bypass result types.

Returns:

true, if is bypass result types

isFqlEnabled

public boolean isFqlEnabled()

Checks if is fql enabled.

Returns:

true, if is fql enabled

isGenerateBlockRankLog

public boolean isGenerateBlockRankLog()

Checks if is generate block rank log.

Returns:

true, if is generate block rank log

isInterleavingEnabled

public boolean isInterleavingEnabled()

Checks if is interleaving enabled.

Returns:

true, if is interleaving enabled

isOrderingHitHighlightedPropertyEnabled

public boolean isOrderingHitHighlightedPropertyEnabled()

Checks if is ordering hit highlighted property enabled.

Returns:

true, if is ordering hit highlighted property enabled

isPhoneticEnabled

public boolean isPhoneticEnabled()

Checks if is phonetic enabled.

Returns:

true, if is phonetic enabled

isProcessBestBets

public boolean isProcessBestBets()

Checks if is process best bets.

Returns:

true, if is process best bets

isProcessPersonalFavorites

public boolean isProcessPersonalFavorites()

Checks if is process personal favorites.

Returns:

true, if is process personal favorites

isSortingEnabled

public boolean isSortingEnabled()

Checks if is sorting enabled.

Returns:

true, if is sorting enabled

isStemmingEnabled

public boolean isStemmingEnabled()

Checks if is stemming enabled.

Returns:

true, if is stemming enabled

isTrimDuplicates

public boolean isTrimDuplicates()

Checks if is trim duplicates.

Returns:

true, if is trim duplicates

setBypassResultTypes

public void setBypassResultTypes(boolean bypassResultTypes)

Sets the bypass result types.

Parameters:

bypassResultTypes - the new bypass result types

setClientType

public void setClientType(QueryLogClientType clientType)

Sets the client type.

Parameters:

clientType - the new client type

setCollapseSpecification

public void setCollapseSpecification(java.lang.String collapseSpecification)

Sets the collapse specification.

Parameters:

collapseSpecification - the new collapse specification

setCulture

public void setCulture(Locale culture)

Sets the culture.

Parameters:

culture - the new culture

setDesiredSnippetLength

public void setDesiredSnippetLength(int desiredSnippetLength)

Sets the desired snippet length.

Parameters:

desiredSnippetLength - the new desired snippet length

setGenerateBlockRankLog

public void setGenerateBlockRankLog(boolean generateBlockRankLog)

Sets the generate block rank log.

Parameters:

generateBlockRankLog - the new generate block rank log

setHiddenConstraints

public void setHiddenConstraints(java.lang.String hiddenConstraints)

Sets the hidden constraints.

Parameters:

hiddenConstraints - the new hidden constraints

setHitHighlightedMultivaluePropertyLimit

public void setHitHighlightedMultivaluePropertyLimit(int hitHighlightedMultivaluePropertyLimit)

Sets the hit highlighted multivalue property limit.

Parameters:

hitHighlightedMultivaluePropertyLimit - the new hit highlighted multivalue property limit

setMaxSnippetLength

public void setMaxSnippetLength(int maxSnippetLength)

Sets the max snippet length.

Parameters:

maxSnippetLength - the new max snippet length

setPersonalizationData

public void setPersonalizationData(java.lang.String personalizationData)

Sets the personalization data.

Parameters:

personalizationData - the new personalization data

setProcessBestBets

public void setProcessBestBets(boolean processBestBets)

Sets the process best bets.

Parameters:

processBestBets - the new process best bets

setProcessPersonalFavorites

public void setProcessPersonalFavorites(boolean processPersonalFavorites)

Sets the process personal favorites.

Parameters:

processPersonalFavorites - the new process personal favorites

setQuery

public void setQuery(java.lang.String query)

Sets the query.

Parameters:

query - the new query

setQueryTemplatePropertiesUrl

public void setQueryTemplatePropertiesUrl(java.lang.String queryTemplatePropertiesUrl)

Sets the query template properties url.

Parameters:

queryTemplatePropertiesUrl - the new query template properties url

setRankingModelId

public void setRankingModelId(java.lang.String rankingModelId)

Sets the ranking model id.

Parameters:

rankingModelId - the new ranking model id

setResultsUrl

public void setResultsUrl(java.lang.String resultsUrl)

Sets the results url.

Parameters:

resultsUrl - the new results url

setRowLimit

public void setRowLimit(int rowLimit)

Sets the row limit.

Parameters:

rowLimit - the new row limit

setRowsPerPage

public void setRowsPerPage(int rowsPerPage)

Sets the rows per page.

Parameters:

rowsPerPage - the new rows per page

setSourceId

public void setSourceId(java.lang.String sourceId)

Sets the source id.

Parameters:

sourceId - the new source id

setStartRow

public void setStartRow(int startRow)

Sets the start row.

Parameters:

startRow - the new start row

setSummaryLength

public void setSummaryLength(int summaryLength)

Sets the summary length.

Parameters:

summaryLength - the new summary length

setTemplate

public void setTemplate(java.lang.String template)

Sets the template.

Parameters:

template - the new template

setTimeout

public void setTimeout(int timeout)

Sets the timeout.

Parameters:

timeout - the new timeout

setTrimDuplicates

public void setTrimDuplicates(boolean trimDuplicates)

Sets the trim duplicates.

Parameters:

trimDuplicates - the new trim duplicates

setUILanguage

public void setUILanguage(Locale uiLanguage)

Sets the UI language.

Parameters:

uiLanguage - the new UI language

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object