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 a filter. 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, @Nullable Map<String,JdbcMapping> explicitParamJaMappings)	Construct a new FilterDefinition instance.
FilterDefinition(String name, String defaultCondition, @Nullable Map<String,JdbcMapping> explicitParamJaMappings, Map<String,ManagedBean<? extends Supplier<?>>> parameterResolverMap, boolean autoEnabled, boolean applyToLoadByKey)

Method Summary

Modifier and Type	Method	Description
String	getDefaultFilterCondition()
String	getFilterName()	Get the name of the filter this configuration defines.
@Nullable 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.
@Nullable Supplier<?>	getParameterResolver(String parameterName)
boolean	isAppliedToLoadByKey()	Get a flag that defines if the filter should be applied on direct fetches or not.
boolean	isAutoEnabled()	Get a flag that defines if the filter should be enabled by default.
Object	processArgument(Object value)	Called before binding a JDBC parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterDefinition

public FilterDefinition(String name,
                        String defaultCondition,
                        @Nullable Map<String,JdbcMapping> explicitParamJaMappings)

Construct a new FilterDefinition instance.

Parameters:

name - The name of the filter for which this configuration is in effect.

FilterDefinition

public FilterDefinition(String name,
                        String defaultCondition,
                        @Nullable Map<String,JdbcMapping> explicitParamJaMappings,
                        Map<String,ManagedBean<? extends Supplier<?>>> parameterResolverMap,
                        boolean autoEnabled,
                        boolean applyToLoadByKey)

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 @Nullable 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.

getParameterResolver

public @Nullable Supplier<?> getParameterResolver(String parameterName)

getDefaultFilterCondition

public String getDefaultFilterCondition()

isAppliedToLoadByKey

public boolean isAppliedToLoadByKey()

Get a flag that defines if the filter should be applied on direct fetches or not.

Returns:

The flag value.

processArgument

public Object processArgument(Object value)

Called before binding a JDBC parameter

Parameters:

value - the argument to the parameter, as set via Filter.setParameter(String, Object)

Returns:

the argument that will actually be bound to the parameter

isAutoEnabled

public boolean isAutoEnabled()

Get a flag that defines if the filter should be enabled by default.

Returns:

The flag value.