org.springframework.orm.hibernate3.FilterDefinitionFactoryBean Maven / Gradle / Ivy
/*
* Copyright 2002-2006 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.orm.hibernate3;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import org.hibernate.engine.FilterDefinition;
import org.hibernate.type.TypeFactory;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.FactoryBean;
import 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">
* <props>
* <prop key="myParam">string</prop>
* <prop key="myOtherParam">long</prop>
* </props>
* </property>
* </bean>
* </list>
* </property>
* ...
* </bean>
*
* Alternatively, specify a bean id (or name) attribute for the inner bean,
* instead of the "filterName" property.
*
* NOTE: As of Spring 2.0, this FactoryBean uses Hibernate 3.1 API.
* (Unfortunately, Hibernate 3.1 changed its FilterDefinition class in a
* non-backwards-compatible fashion.) Consider defining filters within Hibernate's
* own configuration file instead of through this FactoryBean, if you need to
* keep running on Hibernate 3.0.
*
* @author Juergen Hoeller
* @since 1.2
* @see LocalSessionFactoryBean#setFilterDefinitions(org.hibernate.engine.FilterDefinition[])
*/
public class FilterDefinitionFactoryBean implements FactoryBean, BeanNameAware, InitializingBean {
private String filterName;
private Map parameterTypeMap = new HashMap();
private String defaultFilterCondition;
private FilterDefinition filterDefinition;
/**
* Set the name of the filter.
*/
public void setFilterName(String filterName) {
this.filterName = filterName;
}
/**
* Set the parameter types for the filter,
* with parameter names as keys and type names as values.
* @see org.hibernate.type.TypeFactory#heuristicType(String)
*/
public void setParameterTypes(Properties parameterTypes) {
if (parameterTypes != null) {
this.parameterTypeMap = new HashMap(parameterTypes.size());
for (Enumeration names = parameterTypes.propertyNames(); names.hasMoreElements();) {
String paramName = (String) names.nextElement();
String typeName = parameterTypes.getProperty(paramName);
this.parameterTypeMap.put(paramName, TypeFactory.heuristicType(typeName));
}
}
else {
this.parameterTypeMap = new HashMap();
}
}
/**
* Specify a default filter condition for the filter, if any.
*/
public void setDefaultFilterCondition(String defaultFilterCondition) {
this.defaultFilterCondition = defaultFilterCondition;
}
/**
* If no explicit filter name has been specified, the bean name of
* the FilterDefinitionFactoryBean will be used.
* @see #setFilterName
*/
public void setBeanName(String name) {
if (this.filterName == null) {
this.filterName = name;
}
}
public void afterPropertiesSet() {
this.filterDefinition =
new FilterDefinition(this.filterName, this.defaultFilterCondition, this.parameterTypeMap);
}
public Object getObject() {
return this.filterDefinition;
}
public Class getObjectType() {
return FilterDefinition.class;
}
public boolean isSingleton() {
return true;
}
}