Package org.hibernate.engine.spi
Class FilterDefinition
- java.lang.Object
-
- org.hibernate.engine.spi.FilterDefinition
-
- All Implemented Interfaces:
Serializable
public class FilterDefinition extends Object implements Serializable
Represents the definition of afilter
. This information includes the name of the filter, along with the names and types of every parameter of the filter. A filter may optionally have a default condition.- See Also:
FilterDef
,Filter
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description FilterDefinition(String name, String defaultCondition, Map<String,JdbcMapping> explicitParamJaMappings)
Construct a new FilterDefinition instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDefaultFilterCondition()
String
getFilterName()
Get the name of the filter this configuration defines.JdbcMapping
getParameterJdbcMapping(String parameterName)
Retrieve the type of the named parameter defined for this filter.Set<String>
getParameterNames()
Get a set of the parameters defined by this configuration.Object
processArgument(Object value)
Called before binding a JDBC parameter
-
-
-
Constructor Detail
-
FilterDefinition
public FilterDefinition(String name, String defaultCondition, Map<String,JdbcMapping> explicitParamJaMappings)
Construct a new FilterDefinition instance.- Parameters:
name
- The name of the filter for which this configuration is in effect.
-
-
Method Detail
-
getFilterName
public String getFilterName()
Get the name of the filter this configuration defines.- Returns:
- The filter name for this configuration.
-
getParameterNames
public Set<String> getParameterNames()
Get a set of the parameters defined by this configuration.- Returns:
- The parameters named by this configuration.
-
getParameterJdbcMapping
public JdbcMapping getParameterJdbcMapping(String parameterName)
Retrieve the type of the named parameter defined for this filter.- Parameters:
parameterName
- The name of the filter parameter for which to return the type.- Returns:
- The type of the named parameter.
-
getDefaultFilterCondition
public String getDefaultFilterCondition()
-
processArgument
public Object processArgument(Object value)
Called before binding a JDBC parameter- Parameters:
value
- the argument to the parameter, as set viaFilter.setParameter(String, Object)
- Returns:
- the argument that will actually be bound to the parameter
-
-