spring-orm

org.springframework.orm.hibernate3
Class FilterDefinitionFactoryBean

java.lang.Object
  extended by org.springframework.orm.hibernate3.FilterDefinitionFactoryBean
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.FactoryBean<org.hibernate.engine.FilterDefinition>, org.springframework.beans.factory.InitializingBean

public class FilterDefinitionFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<org.hibernate.engine.FilterDefinition>, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Convenient FactoryBean for defining Hibernate FilterDefinitions. Exposes a corresponding Hibernate FilterDefinition object.

Typically defined as an inner bean within a LocalSessionFactoryBean definition, as the list element for the "filterDefinitions" bean property. For example:

 <bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
   ...
   <property name="filterDefinitions">
     <list>
       <bean class="org.springframework.orm.hibernate3.FilterDefinitionFactoryBean">
         <property name="filterName" value="myFilter"/>
         <property name="parameterTypes">
           <map>
             <entry key="myParam" value="string"/>
             <entry key="myOtherParam" value="long"/>
           </map>
         </property>
       </bean>
     </list>
   </property>
   ...
 </bean>
Alternatively, specify a bean id (or name) attribute for the inner bean, instead of the "filterName" property.

Since:
1.2
Author:
Juergen Hoeller
See Also:
FilterDefinition, LocalSessionFactoryBean.setFilterDefinitions(org.hibernate.engine.FilterDefinition[])

Constructor Summary
FilterDefinitionFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
           
 org.hibernate.engine.FilterDefinition getObject()
           
 java.lang.Class<org.hibernate.engine.FilterDefinition> getObjectType()
           
 boolean isSingleton()
           
 void setBeanName(java.lang.String name)
          If no explicit filter name has been specified, the bean name of the FilterDefinitionFactoryBean will be used.
 void setDefaultFilterCondition(java.lang.String defaultFilterCondition)
          Specify a default filter condition for the filter, if any.
 void setFilterName(java.lang.String filterName)
          Set the name of the filter.
 void setParameterTypes(java.util.Map<java.lang.String,java.lang.String> parameterTypes)
          Set the parameter types for the filter, with parameter names as keys and type names as values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterDefinitionFactoryBean

public FilterDefinitionFactoryBean()
Method Detail

setFilterName

public void setFilterName(java.lang.String filterName)
Set the name of the filter.


setParameterTypes

public void setParameterTypes(java.util.Map<java.lang.String,java.lang.String> parameterTypes)
Set the parameter types for the filter, with parameter names as keys and type names as values.

See Also:
TypeFactory.heuristicType(String)

setDefaultFilterCondition

public void setDefaultFilterCondition(java.lang.String defaultFilterCondition)
Specify a default filter condition for the filter, if any.


setBeanName

public void setBeanName(java.lang.String name)
If no explicit filter name has been specified, the bean name of the FilterDefinitionFactoryBean will be used.

Specified by:
setBeanName in interface org.springframework.beans.factory.BeanNameAware
See Also:
setFilterName(java.lang.String)

afterPropertiesSet

public void afterPropertiesSet()
Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getObject

public org.hibernate.engine.FilterDefinition getObject()
Specified by:
getObject in interface org.springframework.beans.factory.FactoryBean<org.hibernate.engine.FilterDefinition>

getObjectType

public java.lang.Class<org.hibernate.engine.FilterDefinition> getObjectType()
Specified by:
getObjectType in interface org.springframework.beans.factory.FactoryBean<org.hibernate.engine.FilterDefinition>

isSingleton

public boolean isSingleton()
Specified by:
isSingleton in interface org.springframework.beans.factory.FactoryBean<org.hibernate.engine.FilterDefinition>

spring-orm