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

/**
 * While extracting values from the index might be faster than extracting
 * them from a Database, it might still involve costly IO operations.
 * Depending on the type of performed queries, it's often needed to extract
 * at least the entity type. Caches which aren't needed won't be used, but used
 * caches might take a significant amount of memory.
 *
 * @author Sanne Grinovero  (C) 2011 Red Hat Inc.
 */
@Retention( RetentionPolicy.RUNTIME )
@Target({ ElementType.TYPE })
@Documented
public @interface CacheFromIndex {

	/**
	 * @return Returns a {@code FieldCache} enum type indicating what kind of caching we should use for index stored metadata. Defaults to {@code FieldCache.CLASS}.
	 */
	FieldCacheType[] value() default { FieldCacheType.CLASS };

}