org.hibernate.engine

Class FilterDefinition

java.lang.Object

org.hibernate.engine.FilterDefinition

All Implemented Interfaces:

java.io.Serializable

public class FilterDefinition
extends java.lang.Object
implements java.io.Serializable

A FilterDefinition defines the global attributes of a dynamic filter. This information includes its name as well as its defined parameters (name and type).

Author:

Steve Ebersole

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterDefinition(java.lang.String name, java.lang.String defaultCondition, java.util.Map parameterTypes) Construct a new FilterDefinition instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultFilterCondition()
java.lang.String	getFilterName() Get the name of the filter this configuration defines.
java.util.Set	getParameterNames() Get a set of the parameters defined by this configuration.
Type	getParameterType(java.lang.String parameterName) Retreive the type of the named parameter defined for this filter.
java.util.Map	getParameterTypes()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterDefinition

public FilterDefinition(java.lang.String name,
                java.lang.String defaultCondition,
                java.util.Map parameterTypes)

Construct a new FilterDefinition instance.

Parameters:

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

Method Detail

getFilterName

public java.lang.String getFilterName()

Get the name of the filter this configuration defines.

Returns:

The filter name for this configuration.

getParameterNames

public java.util.Set getParameterNames()

Get a set of the parameters defined by this configuration.

Returns:

The parameters named by this configuration.

getParameterType

public Type getParameterType(java.lang.String parameterName)

Retreive 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 java.lang.String getDefaultFilterCondition()

getParameterTypes

public java.util.Map getParameterTypes()