org.hibernate.annotations

Annotation Type Filter

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=Filters.class)
public @interface Filter

Add filters to an entity or a target entity of a collection.

Author:

Emmanuel Bernard, Matthew Inger, Magnus Sandberg, Rob Worsnop

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The filter name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
SqlFragmentAlias[]	aliases The alias descriptors for injection.
String	condition The filter condition.
boolean	deduceAliasInjectionPoints If true, automatically determine all points within the condition fragment that an alias should be injected.

Element Detail

name

public abstract String name

The filter name.

condition

public abstract String condition

The filter condition. If empty, the default condition from the correspondingly named FilterDef is used.

Default:

""

deduceAliasInjectionPoints

public abstract boolean deduceAliasInjectionPoints

If true, automatically determine all points within the condition fragment that an alias should be injected. Otherwise, injection will only replace instances of explicit "{alias}" instances or

Default:

true

aliases

public abstract SqlFragmentAlias[] aliases

The alias descriptors for injection.

Default:

{}