|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hibernate.impl.FilterImpl
Implementation of FilterImpl. FilterImpl implements the user's view into enabled dynamic filters, allowing them to set filter parameter values.
Field Summary | |
static String |
MARKER
|
Constructor Summary | |
FilterImpl(FilterDefinition configuration)
Constructs a new FilterImpl. |
Method Summary | |
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 |
public static final String MARKER
Constructor Detail |
public FilterImpl(FilterDefinition configuration)
configuration
- The filter's global configuration.Method Detail |
public FilterDefinition getFilterDefinition()
Filter
getFilterDefinition
in interface Filter
public String getName()
getName
in interface Filter
public Map getParameters()
public Filter setParameter(String name, Object value) throws IllegalArgumentException
setParameter
in interface Filter
name
- The parameter's name.value
- The value to be applied.
IllegalArgumentException
- Indicates that either the parameter was undefined or that the type
of the passed value did not match the configured type.public Filter setParameterList(String name, Collection values) throws HibernateException
setParameterList
in interface Filter
name
- The parameter's name.values
- The values to be expanded into an SQL IN list.
HibernateException
public Filter setParameterList(String name, Object[] values) throws IllegalArgumentException
setParameterList
in interface Filter
name
- The parameter's name.values
- The values to be expanded into an SQL IN list.
IllegalArgumentException
public Object getParameter(String name)
name
- The name of the parameter for which to return the value.
public void validate() throws HibernateException
validate
in interface Filter
HibernateException
- If the state is not currently valid.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |