org.hibernate.search.analyzer.spi

Interface AnalyzerStrategy<T extends AnalyzerReference>

All Known Implementing Classes:

LuceneEmbeddedAnalyzerStrategy

public interface AnalyzerStrategy<T extends AnalyzerReference>

A strategy for applying analyzers.

Author:

Gunnar Morling, Yoann Rodiere

Experimental

This type is under active development as part of the Elasticsearch integration. You should be prepared for incompatible changes in future releases.

Method Summary

Modifier and Type	Method and Description
ScopedAnalyzer.Builder	buildScopedAnalyzer(T initialGlobalAnalyzerReference)
T	createAnalyzerReference(Class<?> analyzerClass)
T	createDefaultAnalyzerReference()
T	createNamedAnalyzerReference(String name)
T	createPassThroughAnalyzerReference()
void	initializeNamedAnalyzerReferences(Map<String,T> references, Map<String,AnalyzerDef> analyzerDefinitions) Initializes named references created by this strategy, i.e.

Method Detail

createDefaultAnalyzerReference

T createDefaultAnalyzerReference()

Returns:

a reference to the default analyzer, the one to be used when no specific configuration is set on a given field.

createPassThroughAnalyzerReference

T createPassThroughAnalyzerReference()

Returns:

a reference to an analyzer that applies no operation whatsoever to the flux. This is useful for queries operating on non-tokenized fields.

createNamedAnalyzerReference

T createNamedAnalyzerReference(String name)

Parameters:

name - The name of the analyzer to be referenced.

Returns:

a reference that will be initialized later.

createAnalyzerReference

T createAnalyzerReference(Class<?> analyzerClass)

Returns:

a reference to an instance of the given analyzer class.

initializeNamedAnalyzerReferences

void initializeNamedAnalyzerReferences(Map<String,T> references,
                                       Map<String,AnalyzerDef> analyzerDefinitions)

Initializes named references created by this strategy, i.e. make them point to the actual analyzer definition.

Parameters:

references - The references to initialize, mapped by name.

analyzerDefinitions - The analyzer definitions gathered through the Hibernate Search mappings. It is guaranteed to contain one analyzer definition for each reference name.

buildScopedAnalyzer

ScopedAnalyzer.Builder buildScopedAnalyzer(T initialGlobalAnalyzerReference)

Returns:

A ScopedAnalyzer builder.