redis.clients.jedis.search

Class Combiner

java.lang.Object

redis.clients.jedis.search.Combiner

All Implemented Interfaces:

IParams

Direct Known Subclasses:

Combiners.Linear, Combiners.RRF

@Experimental
public abstract class Combiner
extends java.lang.Object
implements IParams

Abstract combiner for combining multiple search scores. Instances are created via Combiners.

See Also:

Combiners

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Combiner(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
Combiner	as(java.lang.String alias) Set an alias for the combined score field using YIELD_SCORE_AS.
java.lang.String	getName()
protected abstract java.util.List<java.lang.Object>	getOwnArgs()

Methods inherited from class java.lang.Object

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

Constructor Detail

Combiner

protected Combiner(java.lang.String name)

Method Detail

getName

public final java.lang.String getName()

as

public final Combiner as(java.lang.String alias)

Set an alias for the combined score field using YIELD_SCORE_AS.

Parameters:

alias - the field name to use for the combined score

Returns:

this instance

getOwnArgs

protected abstract java.util.List<java.lang.Object> getOwnArgs()

addParams

public final void addParams(CommandArguments args)

Specified by:

addParams in interface IParams