org.hibernate.impl
Class FilterImpl
java.lang.Object
org.hibernate.impl.FilterImpl
- Filter, Serializable
public class FilterImpl
extends java.lang.Object
implements Filter, Serializable
Implementation of FilterImpl. FilterImpl implements the user's
view into enabled dynamic filters, allowing them to set filter parameter values.
FilterDefinition | getFilterDefinition() - Get the filter definition containing additional information about the
filter (such as default-condition and expected parameter names/types).
|
String | getName() - Get the name of this filter.
|
Object | getParameter(String name) - Get the value of the named parameter for the current filter.
|
Map | getParameters()
|
Filter | setParameter(String name, Object value) - Set the named parameter's value for this filter.
|
Filter | setParameterList(String name, Collection values) - Set the named parameter's value list for this filter.
|
Filter | setParameterList(String name, Object[] values) - Set the named parameter's value list for this filter.
|
void | validate() - Perform validation of the filter state.
|
MARKER
public static final String MARKER
FilterImpl
public FilterImpl(FilterDefinition configuration)
Constructs a new FilterImpl.
configuration
- The filter's global configuration.
getFilterDefinition
public FilterDefinition getFilterDefinition()
Get the filter definition containing additional information about the
filter (such as default-condition and expected parameter names/types).
- getFilterDefinition in interface Filter
getName
public String getName()
Get the name of this filter.
- getName in interface Filter
getParameter
public Object getParameter(String name)
Get the value of the named parameter for the current filter.
name
- The name of the parameter for which to return the value.
- The value of the named parameter.
getParameters
public Map getParameters()
setParameter
public Filter setParameter(String name,
Object value)
throws IllegalArgumentException
Set the named parameter's value for this filter.
- setParameter in interface Filter
name
- The parameter's name.value
- The value to be applied.
- This FilterImpl instance (for method chaining).
setParameterList
public Filter setParameterList(String name,
Collection values)
throws HibernateException
Set the named parameter's value list for this filter. Used
in conjunction with IN-style filter criteria.
- setParameterList in interface Filter
name
- The parameter's name.values
- The values to be expanded into an SQL IN list.
- This FilterImpl instance (for method chaining).
setParameterList
public Filter setParameterList(String name,
Object[] values)
throws IllegalArgumentException
Set the named parameter's value list for this filter. Used
in conjunction with IN-style filter criteria.
- setParameterList in interface Filter
name
- The parameter's name.values
- The values to be expanded into an SQL IN list.
- This FilterImpl instance (for method chaining).
validate
public void validate()
throws HibernateException
Perform validation of the filter state. This is used to verify the
state of the filter after its enablement and before its use.
- validate in interface Filter