Red Hat Training

A Red Hat training course is available for Red Hat JBoss Web Server

17.3. Using Hibernate Filters

In order to use filters, they must first be defined and then attached to the appropriate mapping elements. To define a filter, use the <filter-def/> element within a <hibernate-mapping/> element:
<filter-def name="myFilter">
    <filter-param name="myFilterParam" type="string"/>
This filter can then be attached to a class:
<class name="myClass" ...>
    <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/>
Or, to a collection:
<set ...>
    <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/>
Or, to both or multiples of each at the same time.
The methods on Session are: enableFilter(String filterName), getEnabledFilter(String filterName), and disableFilter(String filterName). By default, filters are not enabled for a given session. Filters must be enabled through use of the Session.enableFilter() method, which returns an instance of the Filter interface. If you used the simple filter defined above, it would look like this:
session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");
Methods on the org.hibernate.Filter interface do allow the method-chaining common to much of Hibernate.