FileDocCategorySizeDatePackage
FilterDefinition.javaAPI DocHibernate 3.2.51860Tue Apr 18 20:45:08 BST 2006org.hibernate.engine

FilterDefinition

public class FilterDefinition extends Object implements 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

Fields Summary
private final String
filterName
private final String
defaultFilterCondition
private final Map
parameterTypes
Constructors Summary
public FilterDefinition(String name, String defaultCondition, Map parameterTypes)
Construct a new FilterDefinition instance.

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


	                   	 
	       
		this.filterName = name;
		this.defaultFilterCondition = defaultCondition;
		this.parameterTypes.putAll( parameterTypes );
	
Methods Summary
public java.lang.StringgetDefaultFilterCondition()

		return defaultFilterCondition;
	
public java.lang.StringgetFilterName()
Get the name of the filter this configuration defines.

return
The filter name for this configuration.

		return filterName;
	
public java.util.SetgetParameterNames()
Get a set of the parameters defined by this configuration.

return
The parameters named by this configuration.

		return parameterTypes.keySet();
	
public org.hibernate.type.TypegetParameterType(java.lang.String parameterName)
Retreive the type of the named parameter defined for this filter.

param
parameterName The name of the filter parameter for which to return the type.
return
The type of the named parameter.

	    return (Type) parameterTypes.get(parameterName);
    
public java.util.MapgetParameterTypes()

		return parameterTypes;