org.hibernate.search.annotations.NormalizerDef 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.Repeatable;
import java.lang.annotation.Documented;

/**
 * Reusable normalizer definition.
 * 
 * A normalizer definition defines one or more filters,
 * but on contrary to analyzer it doesn't include any tokenizer.
 * On top of that, filters should not perform any kind of tokenization.
 * This allows normalizer to be used on fields where we only want a single indexed value,
 * such as sortable fields.
 * 

 * Hibernate Search will try to validate that no tokenization is performed at runtime.
 * 
 * Filters are applied in the order they are defined.
 *
 * @author Emmanuel Bernard
 *
 * @deprecated See {@link AnalyzerDef}
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PACKAGE, ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
@Documented
@Repeatable(NormalizerDefs.class)
@Deprecated
public @interface NormalizerDef {
	/**
	 * @return Reference name to be used on {@link org.hibernate.search.annotations.Normalizer}
	 */
	String name();

	/**
	 * @return CharFilters used. The filters are applied in the defined order
	 */
	CharFilterDef[] charFilters() default { };

	/**
	 * @return Filters used. The filters are applied in the defined order
	 */
	TokenFilterDef[] filters() default { };
}