senselogic.sitevision.api.search.searcher.builder

Interface SpellCheckBuilder

All Superinterfaces:

Builder<SpellCheck>

@Requireable(value="SpellCheckBuilder")
public interface SpellCheckBuilder
extends Builder<SpellCheck>

Builder for creating a SpellCheck component.

SpellCheckBuilder has one optional attribute:

• custom spellcheck query - A custom expression/query to use when extracting "did you mean" suggestions.

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getSpellCheckBuilder(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
SpellCheck	build() Creates a SpellCheck component instance.
SpellCheckBuilder	setCustomSpellCheckQuery(String aCustomSpellCheckQuery) Sets a custom query/expression spellchecker should use when the extracting result.

Method Detail

setCustomSpellCheckQuery

SpellCheckBuilder setCustomSpellCheckQuery(String aCustomSpellCheckQuery)

Sets a custom query/expression spellchecker should use when the extracting result.

The display query is used by Searcher as default spellcheck query (i.e. if no custom value is set via this method).

Solr note: this is the 'spellcheck.q' param

Parameters:

aCustomSpellCheckQuery - the custom query/expression (Note that a null or whitespace-only value will be ignored by Searcher).

Returns:

this builder

Since:

Sitevision 4.0

build

SpellCheck build()

Creates a SpellCheck component instance.

Specified by:

build in interface Builder<SpellCheck>

Returns:

a SpellCheck component.