org.hibernate.search.annotations.Indexed 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.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.hibernate.search.indexes.interceptor.EntityIndexingInterceptor;

@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.TYPE )
@Documented
/**
 * Specifies that an entity is to be indexed by Lucene
 */
public @interface Indexed {
	/**
	 * @return The filename of the index. Default to empty string
	 */
	String index() default "";

	/**
	 * Custom converter to change operations upon indexing
	 * Useful for soft deletes and similar patterns
	 *
	 * @return the custom {@link EntityIndexingInterceptor} class. Default to {@link EntityIndexingInterceptor} class
	 */
	Class interceptor() default EntityIndexingInterceptor.class;
}