Package org.hibernate.search.backend.lucene.analysis

Interface LuceneAnalysisConfigurationContext

All Known Implementing Classes:

LuceneAnalysisConfigurationContextImpl

public interface LuceneAnalysisConfigurationContext

A context allowing the definition of named analyzers and normalizers in a Lucene backend.

Method Summary

Modifier and Type	Method	Description
LuceneAnalyzerTypeStep	analyzer(String name)	Start a new analyzer definition.
Set<String>	availableCharFilters()
Set<String>	availableTokenFilters()
Set<String>	availableTokenizers()
LuceneNormalizerTypeStep	normalizer(String name)	Start a new normalizer definition.
void	similarity(org.apache.lucene.search.similarities.Similarity similarity)	Set the Similarity.

Method Detail

analyzer

LuceneAnalyzerTypeStep analyzer(String name)

Start a new analyzer definition.

Parameters:

name - The name used to reference this analyzer in Hibernate Search.

Returns:

The initial step of a DSL where the analyzer can be defined.

normalizer

LuceneNormalizerTypeStep normalizer(String name)

Start a new normalizer definition.

Parameters:

name - The name used to reference this normalizer in Hibernate Search.

Returns:

The initial step of a DSL where the normalizer can be defined.

similarity

void similarity(org.apache.lucene.search.similarities.Similarity similarity)

Set the Similarity.

Defaults to BM25Similarity.

Parameters:

similarity - The Similarity to use when indexing and when searching.

availableTokenizers

Set<String> availableTokenizers()

Returns:

A list of all possible values that can be passed to LuceneAnalyzerTokenizerStep.tokenizer(String).

availableCharFilters

Set<String> availableCharFilters()

Returns:

A list of all possible values that can be passed to LuceneAnalysisOptionalComponentsStep.charFilter(String).

availableTokenFilters

Set<String> availableTokenFilters()

Returns:

A list of all possible values that can be passed to LuceneAnalysisOptionalComponentsStep.tokenFilter(String).