Package redis.clients.jedis.search.schemafields

Class TextField

java.lang.Object

redis.clients.jedis.search.schemafields.SchemaField

redis.clients.jedis.search.schemafields.TextField

All Implemented Interfaces:

IParams

public class TextField
extends SchemaField

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	noIndex
private boolean	noStem
private String	phoneticMatcher
private boolean	sortable
private boolean	sortableUNF
private Double	weight
private boolean	withSuffixTrie

Fields inherited from class redis.clients.jedis.search.schemafields.SchemaField

fieldName

Constructor Summary

Constructors

Constructor	Description
TextField(String fieldName)
TextField(FieldName fieldName)

Method Summary

Modifier and Type	Method	Description
void	addParams(CommandArguments args)
TextField	as(String attribute)
TextField	noIndex()	Avoid indexing.
TextField	noStem()	Disable stemming when indexing.
static TextField	of(String fieldName)
static TextField	of(FieldName fieldName)
TextField	phonetic(String matcher)	Perform phonetic matching.
TextField	sortable()	Sorts the results by the value of this field.
TextField	sortableUNF()	Sorts the results by the value of this field without normalization.
TextField	sortableUnNormalizedForm()
TextField	weight(double weight)	Declares the importance of this attribute when calculating result accuracy.
TextField	withSuffixTrie()	Keeps a suffix trie with all terms which match the suffix.

Methods inherited from class redis.clients.jedis.search.schemafields.SchemaField

getFieldName, getName

Methods inherited from class java.lang.Object

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

Field Details

sortable

private boolean sortable

sortableUNF

private boolean sortableUNF

noStem

private boolean noStem

noIndex

private boolean noIndex

phoneticMatcher

private String phoneticMatcher

weight

private Double weight

withSuffixTrie

private boolean withSuffixTrie

Constructor Details

TextField

public TextField(String fieldName)

TextField

public TextField(FieldName fieldName)

Method Details

of

public static TextField of(String fieldName)

of

public static TextField of(FieldName fieldName)

as

public TextField as(String attribute)

Overrides:

as in class SchemaField

sortable

public TextField sortable()

Sorts the results by the value of this field.

sortableUNF

public TextField sortableUNF()

Sorts the results by the value of this field without normalization.

sortableUnNormalizedForm

public TextField sortableUnNormalizedForm()

See Also:

• sortableUNF()

noStem

public TextField noStem()

Disable stemming when indexing.

noIndex

public TextField noIndex()

Avoid indexing.

phonetic

public TextField phonetic(String matcher)

Perform phonetic matching.

weight

public TextField weight(double weight)

Declares the importance of this attribute when calculating result accuracy. This is a multiplication factor.

withSuffixTrie

public TextField withSuffixTrie()

Keeps a suffix trie with all terms which match the suffix. It is used to optimize contains and suffix queries.

addParams

public void addParams(CommandArguments args)