org.hibernate.search.annotations.Analyzer 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.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Documented;

/**
 * Define an Analyzer for a given entity, method, field or Field
 * The order of precedence is as such:
 *  - @Field
 *  - field / method
 *  - entity
 *  - default
 *
 * Either describe an explicit implementation through the impl parameter
 * or use an external @AnalyzerDef definition through the def parameter
 *
 * @author Emmanuel Bernard
 */
@Retention( RetentionPolicy.RUNTIME )
@Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
@Documented
public @interface Analyzer {
	/**
	 * @return An {@link org.apache.lucene.analysis.Analyzer} implementation.
	 * @deprecated Support for direct references to analyzer implementations
	 * by class will be removed in Hibernate Search 6.
	 * Use {@link #definition()} instead.
	 */
	@Deprecated
	Class impl() default void.class;

	/**
	 * @return The name of an analyzer defined using
	 * a {@link org.hibernate.search.analyzer.definition.LuceneAnalysisDefinitionProvider},
	 * or a {@code org.hibernate.search.elasticsearch.analyzer.definition.ElasticsearchAnalysisDefinitionProvider},
	 * or the deprecated {@link AnalyzerDef}.
	 */
	String definition() default "";
}