org.hibernate.search.annotations

Annotation Type FullTextFilterDef

@Retention(value=RUNTIME)
@Target(value=TYPE)
@Documented
public @interface FullTextFilterDef

Defines a FullTextFilter that can be optionally applied to every FullText Queries While not related to a specific indexed entity, the annotation has to be set on one of them

Author:

Emmanuel Bernard

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	impl Either implements Filter or contains a @Factory method returning one.
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
FilterCacheModeType	cache

Element Detail

name

public abstract String name

Returns:

the filter name. Must be unique across all mappings for a given persistence unit

impl

public abstract Class<?> impl

Either implements Filter or contains a @Factory method returning one. The generated Filter must be thread-safe. If the filter accept parameters, an @Key method must be present as well.

Returns:

a class which either implements Filter directly or contains a method annotated with @Factory.

cache

public abstract FilterCacheModeType cache

Returns:

The cache mode for the filter. Default to instance and results caching

Default:

org.hibernate.search.annotations.FilterCacheModeType.INSTANCE_AND_DOCIDSETRESULTS