redis.clients.jedis.search

Class FTSearchParams

java.lang.Object

redis.clients.jedis.search.FTSearchParams

All Implemented Interfaces:

IParams

public class FTSearchParams
extends java.lang.Object
implements IParams

Query represents query parameters and filters to load results from the engine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FTSearchParams.GeoFilter GeoFilter encapsulates a radius filter on a geographical indexed fields
static class	FTSearchParams.HighlightParams
static class	FTSearchParams.NumericFilter NumericFilter wraps a range filter on a numeric field.
static class	FTSearchParams.SummarizeParams

Constructor Summary

Constructors

Constructor and Description
FTSearchParams()

Method Summary

Modifier and Type	Method and Description
FTSearchParams	addParam(java.lang.String name, java.lang.Object value) Adds a query parameter.
void	addParams(CommandArguments args)
FTSearchParams	dialect(int dialect) Set the dialect version to execute the query accordingly
FTSearchParams	dialectOptional(int dialect) This method will not replace the dialect if it has been already set.
FTSearchParams	filter(FTSearchParams.NumericFilter numericFilter)
FTSearchParams	filter(java.lang.String field, double min, boolean exclusiveMin, double max, boolean exclusiveMax)
FTSearchParams	filter(java.lang.String field, double min, double max)
FTSearchParams	geoFilter(FTSearchParams.GeoFilter geoFilter)
FTSearchParams	geoFilter(java.lang.String field, double lon, double lat, double radius, GeoUnit unit)
boolean	getNoContent()
java.util.Map<java.lang.String,java.lang.Boolean>	getReturnFieldDecodeMap()
boolean	getWithScores()
FTSearchParams	highlight()
FTSearchParams	highlight(FTSearchParams.HighlightParams highlightParams)
static FTSearchParams.HighlightParams	highlightParams()
FTSearchParams	inFields(java.util.Collection<java.lang.String> fields)
FTSearchParams	inFields(java.lang.String... fields) Limit the query to results that are limited to a specific set of fields
FTSearchParams	inKeys(java.util.Collection<java.lang.String> keys)
FTSearchParams	inKeys(java.lang.String... keys) Limit the query to results that are limited to a specific set of keys
FTSearchParams	inOrder()
FTSearchParams	language(java.lang.String language) Set the query language, for stemming purposes See http://redisearch.io for documentation on languages and stemming
FTSearchParams	limit(int offset, int num) Limit the results to a certain offset and limit
FTSearchParams	noContent() Set the query not to return the contents of documents, and rather just return the ids
FTSearchParams	noStopwords() Set the query not to filter for stopwords.
FTSearchParams	params(java.util.Map<java.lang.String,java.lang.Object> paramValues) Adds all entries of the given map as query parameters, merging them with any parameters already set via addParam(String, Object) or previous params calls.
FTSearchParams	returnField(FieldName field)
FTSearchParams	returnField(FieldName field, boolean decode)
FTSearchParams	returnField(java.lang.String field, boolean decode)
FTSearchParams	returnFields(java.util.Collection<FieldName> fields)
FTSearchParams	returnFields(FieldName... fields)
FTSearchParams	returnFields(java.lang.String... fields) Result's projection - the fields to return by the query
FTSearchParams	scorer(java.lang.String scorer) Set the query custom scorer See http://redisearch.io for documentation on extending RediSearch
static FTSearchParams	searchParams()
FTSearchParams	slop(int slop)
FTSearchParams	sortBy(java.lang.String sortBy, SortingOrder order) Set the query to be sorted by a Sortable field defined in the schema
FTSearchParams	summarize()
FTSearchParams	summarize(FTSearchParams.SummarizeParams summarizeParams)
static FTSearchParams.SummarizeParams	summarizeParams()
FTSearchParams	timeout(long timeout)
FTSearchParams	verbatim() Set the query to verbatim mode, disabling stemming and query expansion
FTSearchParams	withScores() Set the query to return a factored score for each results.

Methods inherited from class java.lang.Object

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

Constructor Detail

FTSearchParams

public FTSearchParams()

Method Detail

searchParams

public static FTSearchParams searchParams()

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

noContent

public FTSearchParams noContent()

Set the query not to return the contents of documents, and rather just return the ids

Returns:

the query itself

verbatim

public FTSearchParams verbatim()

Set the query to verbatim mode, disabling stemming and query expansion

Returns:

the query object

noStopwords

public FTSearchParams noStopwords()

Set the query not to filter for stopwords. In general this should not be used

Returns:

the query object

withScores

public FTSearchParams withScores()

Set the query to return a factored score for each results. This is useful to merge results from multiple queries.

Returns:

the query object itself

filter

public FTSearchParams filter(java.lang.String field,
                             double min,
                             double max)

filter

public FTSearchParams filter(java.lang.String field,
                             double min,
                             boolean exclusiveMin,
                             double max,
                             boolean exclusiveMax)

filter

public FTSearchParams filter(FTSearchParams.NumericFilter numericFilter)

geoFilter

public FTSearchParams geoFilter(java.lang.String field,
                                double lon,
                                double lat,
                                double radius,
                                GeoUnit unit)

geoFilter

public FTSearchParams geoFilter(FTSearchParams.GeoFilter geoFilter)

inKeys

public FTSearchParams inKeys(java.lang.String... keys)

Limit the query to results that are limited to a specific set of keys

Parameters:

keys - a list of TEXT fields in the schemas

Returns:

the query object itself

inKeys

public FTSearchParams inKeys(java.util.Collection<java.lang.String> keys)

inFields

public FTSearchParams inFields(java.lang.String... fields)

Limit the query to results that are limited to a specific set of fields

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

inFields

public FTSearchParams inFields(java.util.Collection<java.lang.String> fields)

returnFields

public FTSearchParams returnFields(java.lang.String... fields)

Result's projection - the fields to return by the query

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

returnField

public FTSearchParams returnField(FieldName field)

returnFields

public FTSearchParams returnFields(FieldName... fields)

returnFields

public FTSearchParams returnFields(java.util.Collection<FieldName> fields)

returnField

public FTSearchParams returnField(java.lang.String field,
                                  boolean decode)

returnField

public FTSearchParams returnField(FieldName field,
                                  boolean decode)

summarize

public FTSearchParams summarize()

summarize

public FTSearchParams summarize(FTSearchParams.SummarizeParams summarizeParams)

highlight

public FTSearchParams highlight()

highlight

public FTSearchParams highlight(FTSearchParams.HighlightParams highlightParams)

scorer

public FTSearchParams scorer(java.lang.String scorer)

Set the query custom scorer

See http://redisearch.io for documentation on extending RediSearch

Parameters:

scorer - a custom scorer.

Returns:

the query object itself

slop

public FTSearchParams slop(int slop)

timeout

public FTSearchParams timeout(long timeout)

inOrder

public FTSearchParams inOrder()

language

public FTSearchParams language(java.lang.String language)

Set the query language, for stemming purposes

See http://redisearch.io for documentation on languages and stemming

Parameters:

language - a language.

Returns:

the query object itself

sortBy

public FTSearchParams sortBy(java.lang.String sortBy,
                             SortingOrder order)

Set the query to be sorted by a Sortable field defined in the schema

Parameters:

sortBy - the sorting field's name

order - the sorting order

Returns:

the query object itself

limit

public FTSearchParams limit(int offset,
                            int num)

Limit the results to a certain offset and limit

Parameters:

offset - the first result to show, zero based indexing

num - how many results we want to show

Returns:

the query itself, for builder-style syntax

addParam

public FTSearchParams addParam(java.lang.String name,
                               java.lang.Object value)

Adds a query parameter. Parameters are referenced in the query string by $ followed by the parameter name, e.g. $user, and each such reference is substituted by the corresponding parameter value.

Adding a parameter with an existing name overwrites its previous value. Parameters accumulate across addParam and params(Map) calls.

Parameters:

name - the parameter name, referenced in the query as $name

value - the parameter value; can be String, long or float

Returns:

the query object itself

params

public FTSearchParams params(java.util.Map<java.lang.String,java.lang.Object> paramValues)

Adds all entries of the given map as query parameters, merging them with any parameters already set via addParam(String, Object) or previous params calls. An entry whose name is already set overwrites its previous value.

Parameters:

paramValues - parameter name to value; values can be String, long or float

Returns:

the query object itself

See Also:

addParam(String, Object)

dialect

public FTSearchParams dialect(int dialect)

Set the dialect version to execute the query accordingly

Parameters:

dialect - integer

Returns:

the query object itself

dialectOptional

@Internal
public FTSearchParams dialectOptional(int dialect)

This method will not replace the dialect if it has been already set.

Parameters:

dialect - dialect

Returns:

this

getNoContent

@Internal
public boolean getNoContent()

getWithScores

@Internal
public boolean getWithScores()

getReturnFieldDecodeMap

@Internal
public java.util.Map<java.lang.String,java.lang.Boolean> getReturnFieldDecodeMap()

summarizeParams

public static FTSearchParams.SummarizeParams summarizeParams()

highlightParams

public static FTSearchParams.HighlightParams highlightParams()