io.lettuce.core.search

Class SearchReply.SearchResult<K,V>

java.lang.Object

io.lettuce.core.search.SearchReply.SearchResult<K,V>

Type Parameters:

K - Key type.

V - Value type.

Enclosing class:

SearchReply<K,V>

public static class SearchReply.SearchResult<K,V>
extends Object

Represents a single search result document.

Constructor Summary

Constructors

Constructor and Description
SearchResult()
SearchResult(K id) Creates a new SearchResult with the specified document ID.

Method Summary

Modifier and Type	Method and Description
void	addFields(K key, V value) Adds a single document field
void	addFields(Map<K,V> fields) Adds all the provided fields
Map<K,V>	getFields() Gets the document fields.
K	getId() Gets the document ID.
V	getPayload() Gets the document payload.
Double	getScore() Gets the document score.
V	getSortKey() Gets the sort key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult(K id)

Creates a new SearchResult with the specified document ID.

Parameters:

id - the document ID

SearchResult

public SearchResult()

Method Detail

getId

public K getId()

Gets the document ID.

Returns:

the document ID

getScore

public Double getScore()

Gets the document score.

This is only available if WITHSCORES was used in the search.

Returns:

the document score, or null if not available

getPayload

public V getPayload()

Gets the document payload.

This is only available if WITHPAYLOADS was used in the search.

Returns:

the document payload, or null if not available

getSortKey

public V getSortKey()

Gets the sort key.

This is only available if WITHSORTKEYS was used in the search.

Returns:

the sort key, or null if not available

getFields

public Map<K,V> getFields()

Gets the document fields.

This contains the field names and values of the document. If NOCONTENT was used in the search, this will be null or empty.

Returns:

the document fields, or null if not available

addFields

public void addFields(Map<K,V> fields)

Adds all the provided fields

Parameters:

fields - the document fields

addFields

public void addFields(K key,
                      V value)

Adds a single document field

Parameters:

key - the field name

value - the field value