程序包 org.hibernate
接口 Filter
-
- 所有已知实现类:
FilterImpl
public interface FilterType definition of Filter. Filter defines the user's view into enabled dynamic filters, allowing them to set filter parameter values.- 作者:
- Steve Ebersole
-
-
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 FilterDefinitiongetFilterDefinition()Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).StringgetName()Get the name of this filter.FiltersetParameter(String name, Object value)Set the named parameter's value for this filter.FiltersetParameterList(String name, Object[] values)Set the named parameter's value list for this filter.FiltersetParameterList(String name, Collection values)Set the named parameter's value list for this filter.voidvalidate()Perform validation of the filter state.
-
-
-
方法详细资料
-
getName
String getName()
Get the name of this filter.- 返回:
- This filter's name.
-
getFilterDefinition
FilterDefinition getFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).- 返回:
- The filter definition
-
setParameter
Filter setParameter(String name, Object value)
Set the named parameter's value for this filter.- 参数:
name- The parameter's name.value- The value to be applied.- 返回:
- This FilterImpl instance (for method chaining).
-
setParameterList
Filter setParameterList(String name, Collection values)
Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.- 参数:
name- The parameter's name.values- The values to be expanded into an SQL IN list.- 返回:
- This FilterImpl instance (for method chaining).
-
setParameterList
Filter setParameterList(String name, Object[] values)
Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.- 参数:
name- The parameter's name.values- The values to be expanded into an SQL IN list.- 返回:
- This FilterImpl instance (for method chaining).
-
validate
void validate() throws HibernateExceptionPerform validation of the filter state. This is used to verify the state of the filter after its enablement and before its use.- 抛出:
HibernateException- If the state is not currently valid.
-
-