io.lettuce.core.search.arguments

Class SummarizeArgs.Builder<K,V>

java.lang.Object

io.lettuce.core.search.arguments.SummarizeArgs.Builder<K,V>

Type Parameters:

K - the key type

Enclosing class:

SummarizeArgs<K,V>

public static class SummarizeArgs.Builder<K,V>
extends Object

Builder for SummarizeArgs.

As a final step the build() method needs to be executed to create the final SortByArgs instance.

See Also:

FT.CREATE

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SummarizeArgs<K,V>	build() Build the SummarizeArgs.
SummarizeArgs.Builder<K,V>	field(K field) Add a field to summarize.
SummarizeArgs.Builder<K,V>	fragments(long frags) Set the number of fragments to be returned.
SummarizeArgs.Builder<K,V>	len(long len) Set the number of context words each fragment should contain.
SummarizeArgs.Builder<K,V>	separator(V separator) The string used to divide individual summary snippets.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

field

public SummarizeArgs.Builder<K,V> field(K field)

Add a field to summarize. Each field is summarized. If no FIELDS directive is passed, then all returned fields are summarized.

Parameters:

field - the field to summarize

Returns:

the instance of the current SummarizeArgs.Builder for the purpose of method chaining

fragments

public SummarizeArgs.Builder<K,V> fragments(long frags)

Set the number of fragments to be returned. If not specified, the default is 3.

Parameters:

frags - the number of fragments to return

Returns:

the instance of the current SummarizeArgs.Builder for the purpose of method chaining

len

public SummarizeArgs.Builder<K,V> len(long len)

Set the number of context words each fragment should contain. Context words surround the found term. A higher value will return a larger block of text. If not specified, the default value is 20.

Parameters:

len - the length of the fragments

Returns:

the instance of the current SummarizeArgs.Builder for the purpose of method chaining

separator

public SummarizeArgs.Builder<K,V> separator(V separator)

The string used to divide individual summary snippets. The default is ... which is common among search engines, but you may override this with any other string if you desire to programmatically divide the snippets later on. You may also use a newline sequence, as newlines are stripped from the result body during processing.

Parameters:

separator - the separator between fragments

Returns:

the instance of the current SummarizeArgs.Builder for the purpose of method chaining

build

public SummarizeArgs<K,V> build()

Build the SummarizeArgs.

Returns:

the SummarizeArgs