io.lettuce.core.search

Class SuggestionParser

java.lang.Object

io.lettuce.core.search.SuggestionParser

All Implemented Interfaces:

ComplexDataParser<List<Suggestion>>

public class SuggestionParser
extends Object
implements ComplexDataParser<List<Suggestion>>

Parser for Redis FT.SUGGET command output.

This parser converts the response from the Redis FT.SUGGET command into a list of Suggestion objects. The FT.SUGGET command can return different formats depending on the options used:

• Basic format: Just the suggestion strings
• With WITHSCORES: Alternating suggestion strings and scores
• With WITHPAYLOADS: Alternating suggestion strings and payloads
• With both WITHSCORES and WITHPAYLOADS: Suggestion strings, scores, and payloads in sequence

Suggestion text and payloads are decoded as UTF-8. Scores are read as RESP3 numbers or RESP2 UTF-8 strings.

Since:

6.8

Author:

Tihomir Mateev

Constructor Summary

Constructors

Constructor and Description
SuggestionParser(boolean withScores, boolean withPayloads) Create a new suggestion parser.

Method Summary

Modifier and Type	Method and Description
List<Suggestion>	parse(ComplexData data) Parse the output of the Redis FT.SUGGET command and convert it to a list of Suggestion objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestionParser

public SuggestionParser(boolean withScores,
                        boolean withPayloads)

Create a new suggestion parser.

Parameters:

withScores - whether the response includes scores

withPayloads - whether the response includes payloads

Method Detail

parse

public List<Suggestion> parse(ComplexData data)

Parse the output of the Redis FT.SUGGET command and convert it to a list of Suggestion objects.

The parsing logic depends on the options used with the FT.SUGGET command:

• No options: Each element is a suggestion string
• WITHSCORES only: Elements alternate between suggestion string and score
• WITHPAYLOADS only: Elements alternate between suggestion string and payload
• Both WITHSCORES and WITHPAYLOADS: Elements are in groups of 3: suggestion, score, payload

Specified by:

parse in interface ComplexDataParser<List<Suggestion>>

Parameters:

data - output of FT.SUGGET command

Returns:

a list of Suggestion objects