Package org.hibernate.annotations

Annotation Interface Filter

@Target({TYPE,METHOD,FIELD})@Retention(RUNTIME)@Repeatable(Filters.class)public @interfaceFilter
Specifies that an entity or collection is affected by a named filter declared using@FilterDef, and allows thedefault filter condition to be overridden for the annotated entity or collection role.

For example, we might apply a filter namedCurrent to an entity like this:

 @Entity @Filter(name = "Current",         deduceAliasInjectionPoints = false,         condition = "{alias}.year = extract(year from current_date)") class Course {     @Id @GeneratedValue Long id;     int year;     ... }

If an entity or collection has no@Filter annotation with the name of a given filter, it is not affected by that filter.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The name of the filter declared usingFilterDef.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Explicitly specifies how aliases are interpolated into thecondition() SQL expression.
    The filter condition, a SQL expression used for filtering the rows returned by a query when the filter is enabled.
    boolean
    Determines how tables aliases are interpolated into thecondition() SQL expression.

  • Element Details

    • condition

      String condition
      The filter condition, a SQL expression used for filtering the rows returned by a query when the filter is enabled. If not specified, the default filter condition given byFilterDef.defaultCondition() is used.

      By default, aliases of filtered tables are automatically interpolated into the filter condition, before any token that looks like a column name. Occasionally, when the interpolation algorithm encounters ambiguity, the process of alias interpolation produces broken SQL. In such cases, alias interpolation may be controlled explicitly using eitherdeduceAliasInjectionPoints() oraliases().

      Default:
      ""

    • deduceAliasInjectionPoints

      boolean deduceAliasInjectionPoints
      Determines how tables aliases are interpolated into thecondition() SQL expression.
      • iftrue, and by default, an alias is added automatically to every column occurring in the SQL expression, but
      • iffalse, aliases are only interpolated where an explicit placeholder of form{alias} occurs in the SQL expression.
      • Finally, ifexplicit aliases are specified, then alias interpolation happens only for the specified aliases.
      Default:
      true

    • aliases

      SqlFragmentAlias[] aliases
      Explicitly specifies how aliases are interpolated into thecondition() SQL expression. EachSqlFragmentAlias specifies a placeholder name and the table whose alias should be interpolated. Placeholders are of form{name} wherename matches aSqlFragmentAlias.alias().
      Default:
      {}