com.exalead.searchapi.client

Class CloudView5RelevanceQueryBuilder

java.lang.Object

com.exalead.searchapi.client.CloudView5RelevanceQueryBuilder

public class CloudView5RelevanceQueryBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudView5RelevanceQueryBuilder.Sort

Constructor Summary

Constructors

Constructor and Description
CloudView5RelevanceQueryBuilder(SearchQuery sq)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollapsing()
CloudView5RelevanceQueryBuilder.Sort	getSort() Returns the field on which the results will be sorted
java.lang.String	getStaticRankingExpression() Get the static ranking expression set on the current query
CloudView5RelevanceQueryBuilder	setCollapsing(boolean lsb, boolean msb) Configure CloudView 5 style collapsing
CloudView5RelevanceQueryBuilder	setSort(java.lang.String fieldName) Sets the field on which the results will be sorted on.
CloudView5RelevanceQueryBuilder	setSort(java.lang.String fieldName, boolean ascending, boolean isSecondary) Sets the field on which the results will be sorted on.
CloudView5RelevanceQueryBuilder	setStaticRankingExpression(java.lang.String expression) Sets the static ranking expression to use for this query
void	unSetStaticRankingExpression() Remove the static ranking expression for the current query

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudView5RelevanceQueryBuilder

public CloudView5RelevanceQueryBuilder(SearchQuery sq)

Method Detail

setCollapsing

public CloudView5RelevanceQueryBuilder setCollapsing(boolean lsb,
                                                     boolean msb)

Configure CloudView 5 style collapsing

Parameters:

lsb - use the first 32 bits of the field

msb - use the bits from 33 to 64 of the field

getCollapsing

public java.lang.String getCollapsing()

Returns:

collapsing state, or null if no collapsing state has been set. Collapsing state is in the form: "key1:true/false,key2:true/false". key1 represents the lsb, key2 represents the msb

setStaticRankingExpression

public CloudView5RelevanceQueryBuilder setStaticRankingExpression(java.lang.String expression)

Sets the static ranking expression to use for this query

Parameters:

expression - static ranking expression

unSetStaticRankingExpression

public void unSetStaticRankingExpression()

Remove the static ranking expression for the current query

getStaticRankingExpression

public java.lang.String getStaticRankingExpression()

Get the static ranking expression set on the current query

Returns:

null if no static ranking expression is set.

setSort

public CloudView5RelevanceQueryBuilder setSort(java.lang.String fieldName)

Sets the field on which the results will be sorted on. Note that you can't sort on alphanumerical and category fields

Parameters:

fieldName - the name of a field (that can be used for sorting)

setSort

public CloudView5RelevanceQueryBuilder setSort(java.lang.String fieldName,
                                               boolean ascending,
                                               boolean isSecondary)

Sets the field on which the results will be sorted on. Note that you can't sort on alphanumerical and category fields

Parameters:

fieldName - the name of a field (that can be used for sorting)

isSecondary - wether the sort is secondary or not. When the sort is secondary it is only applied to the results with the same score.

getSort

public CloudView5RelevanceQueryBuilder.Sort getSort()

Returns the field on which the results will be sorted