FilterImpl (Hibernate Core Aggregator 3.6.10.Final API)

java.lang.Object
- org.hibernate.impl.FilterImpl

All Implemented Interfaces:

Serializable, Filter
```
public class FilterImpl
extends Object
implements Filter, Serializable
```
Implementation of FilterImpl. FilterImpl implements the user's view into enabled dynamic filters, allowing them to set filter parameter values.

Author:

Steve Ebersole

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String MARKER

Fields
Modifier and Type	Field and Description
`static String`	`MARKER`

Constructor Summary

Constructors
Constructor and Description

FilterImpl(FilterDefinition configuration)
Constructs a new FilterImpl.

Constructors
Constructor and Description
`FilterImpl(FilterDefinition configuration)` Constructs a new FilterImpl.

Method Summary

Methods
Modifier and Type	Method and Description
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MARKER
```
public static final String MARKER
```
    See Also:
    Constant Field Values
- Constructor Detail
  - FilterImpl
```
public FilterImpl(FilterDefinition configuration)
```
    Constructs a new FilterImpl.
    
    Parameters:
    configuration - The filter's global configuration.
- Method Detail
  - getFilterDefinition
```
public FilterDefinition getFilterDefinition()
```
    Description copied from interface: Filter
    
    Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).
    
    Specified by:
    
    getFilterDefinition in interface Filter
    
    Returns:
    The filter definition
  - getName
```
public String getName()
```
    Get the name of this filter.
    
    Specified by:
    
    getName in interface Filter
    
    Returns:
    This filter's name.
  - getParameters
```
public Map getParameters()
```
  - setParameter
```
public Filter setParameter(String name,
                  Object value)
                    throws IllegalArgumentException
```
    Set the named parameter's value for this filter.
    
    Specified by:
    
    setParameter in interface Filter
    
    Parameters:
    name - The parameter's name.
    value - The value to be applied.
    
    Returns:
    This FilterImpl instance (for method chaining).
    
    Throws:
    
    IllegalArgumentException - Indicates that either the parameter was undefined or that the type of the passed value did not match the configured type.
  - 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.
    
    Specified by:
    
    setParameterList in interface Filter
    
    Parameters:
    name - The parameter's name.
    values - The values to be expanded into an SQL IN list.
    
    Returns:
    This FilterImpl instance (for method chaining).
    
    Throws:
    
    HibernateException
  - 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.
    
    Specified by:
    
    setParameterList in interface Filter
    
    Parameters:
    name - The parameter's name.
    values - The values to be expanded into an SQL IN list.
    
    Returns:
    This FilterImpl instance (for method chaining).
    
    Throws:
    
    IllegalArgumentException
  - getParameter
```
public Object getParameter(String name)
```
    Get the value of the named parameter for the current filter.
    
    Parameters:
    name - The name of the parameter for which to return the value.
    
    Returns:
    The value of the named parameter.
  - 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.
    
    Specified by:
    
    validate in interface Filter
    
    Throws:
    
    HibernateException - If the state is not currently valid.

Class FilterImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARKER

Constructor Detail

FilterImpl

Method Detail

getFilterDefinition

getName

getParameters

setParameter

setParameterList

setParameterList

getParameter

validate