org.hibernate.search.backend.lucene.analysis.LuceneAnalysisConfigurationContext Maven / Gradle / Ivy
Show all versions of hibernate-search-backend-lucene Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.search.backend.lucene.analysis;
import java.util.Set;
import org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalyzerTypeStep;
import org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneNormalizerTypeStep;
import org.apache.lucene.search.similarities.Similarity;
/**
* A context allowing the definition of named analyzers and normalizers in a Lucene backend.
*/
public interface LuceneAnalysisConfigurationContext {
/**
* Start a new analyzer definition.
*
* @param name The name used to reference this analyzer in Hibernate Search.
* @return The initial step of a DSL where the analyzer can be defined.
*/
LuceneAnalyzerTypeStep analyzer(String name);
/**
* Start a new normalizer definition.
*
* @param name The name used to reference this normalizer in Hibernate Search.
* @return The initial step of a DSL where the normalizer can be defined.
*/
LuceneNormalizerTypeStep normalizer(String name);
/**
* Set the {@link Similarity}.
*
* Defaults to {@link org.apache.lucene.search.similarities.BM25Similarity}.
*
* @param similarity The {@link Similarity} to use when indexing and when searching.
*/
void similarity(Similarity similarity);
/**
* @return A list of all possible values that can be passed to
* {@link org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalyzerTokenizerStep#tokenizer(String)}.
*/
Set availableTokenizers();
/**
* @return A list of all possible values that can be passed to
* {@link org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalysisOptionalComponentsStep#charFilter(String)}.
*/
Set availableCharFilters();
/**
* @return A list of all possible values that can be passed to
* {@link org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalysisOptionalComponentsStep#tokenFilter(String)}.
*/
Set availableTokenFilters();
}