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

Interface LuceneAnalysisOptionalComponentsStep

All Known Subinterfaces:

LuceneAnalysisComponentParametersStep, LuceneAnalyzerOptionalComponentsStep, LuceneNormalizerOptionalComponentsStep

public interface LuceneAnalysisOptionalComponentsStep

The step in an analyzer/normalizer definition where optional components such as char filters or token filters can be added.

Method Summary

Modifier and Type	Method	Description
LuceneAnalysisComponentParametersStep	charFilter(Class<? extends org.apache.lucene.analysis.util.CharFilterFactory> factoryType)	Add a char filter that the analyzer will use.
LuceneAnalysisComponentParametersStep	charFilter(String factoryName)	Add a char filter that the analyzer will use.
LuceneAnalysisComponentParametersStep	tokenFilter(Class<? extends org.apache.lucene.analysis.util.TokenFilterFactory> factoryType)	Add a token filter that the analyzer will use.
LuceneAnalysisComponentParametersStep	tokenFilter(String factoryName)	Add a token filter that the analyzer will use.

Method Detail

charFilter

LuceneAnalysisComponentParametersStep charFilter(String factoryName)

Add a char filter that the analyzer will use.

Parameters:

factoryName - The name of the factory that will create the char filter. The list of available names can be looked up with LuceneAnalysisConfigurationContext.availableCharFilters().

Returns:

The next step.

charFilter

LuceneAnalysisComponentParametersStep charFilter(Class<? extends org.apache.lucene.analysis.util.CharFilterFactory> factoryType)

Add a char filter that the analyzer will use.

Parameters:

factoryType - The type of the factory that will create the char filter.

Returns:

The next step.

tokenFilter

LuceneAnalysisComponentParametersStep tokenFilter(String factoryName)

Add a token filter that the analyzer will use.

Parameters:

factoryName - The name of the factory that will create the token filter. The list of available names can be looked up with LuceneAnalysisConfigurationContext.availableTokenFilters().

Returns:

The next step.

tokenFilter

LuceneAnalysisComponentParametersStep tokenFilter(Class<? extends org.apache.lucene.analysis.util.TokenFilterFactory> factoryType)

Add a token filter that the analyzer will use.

Parameters:

factoryType - The type of the factory that will create the token filter.

Returns:

The next step.