org.hibernate.search.analyzer.definition.LuceneAnalysisDefinitionProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation

Core of the Object/Lucene mapper, query engine and index management

There is a newer version: 5.11.12.Final

Show newest version

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.analyzer.definition;

import org.hibernate.search.analyzer.definition.spi.LuceneAnalysisDefinitionSourceService;
import org.hibernate.search.cfg.Environment;

/**
 * A provider of analysis-related definitions that can be referenced from the mapping,
 * e.g. with {@literal @Analyzer(definition = "some-name")}
 * or {@literal @Normalizer(definition = "some-other-name")}.
 * 
 * Users can select a definition provider through the
 * {@link Environment#ANALYSIS_DEFINITION_PROVIDER configuration properties}, while
 * framework integrators also have the option to inject an alternative implementation
 * of a {@link LuceneAnalysisDefinitionSourceService}.
 *
 * @author Yoann Rodiere
 *
 * @hsearch.experimental This interface is a prototype.
 * Please let us know what you like and what you don't like, and bear in mind
 * that this will likely change in any future version.
 */
public interface LuceneAnalysisDefinitionProvider {

	void register(LuceneAnalysisDefinitionRegistryBuilder builder);

}