/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
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;
import org.apache.lucene.analysis.util.TokenizerFactory;
/**
* Define a <code>TokenizerFactory</code> and its parameters.
*
* @author Emmanuel Bernard
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
@Documented
public @interface TokenizerDef {
/**
* @return the name of this tokenizer definition. Optional when using an embedded Lucene
* instance, but should be provided to avoid conflicts when using a remote indexing service
* such as Elasticsearch.
*/
String name() default "";
/**
* @return the <code>TokenizerFactory</code> class which shall be instantiated.
*/
Class<? extends TokenizerFactory> factory();
/**
* @return Optional parameters passed to the <code>TokenizerFactory</code>.
*/
Parameter[] params() default { };
}