org.springframework.orm.ibatis
Class SqlMapFactoryBean

java.lang.Object
  org.springframework.orm.ibatis.SqlMapFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class SqlMapFactoryBean
extends Object
implements FactoryBean, InitializingBean

FactoryBean that creates an iBATIS Database Layer SqlMap as singleton in the current bean factory, possibly for use with SqlMapTemplate.

NOTE: The SqlMap/MappedStatement API is the one to use with iBATIS SQL Maps 1.x. The SqlMapClient/SqlMapSession API is only available with SQL Maps 2.

Since:

28.11.2003

Author:

Juergen Hoeller

See Also:

SqlMapTemplate.setSqlMap(com.ibatis.db.sqlmap.SqlMap)

Constructor Summary

SqlMapFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setConfigLocation(Resource configLocation) Set the location of the iBATIS SqlMap config file.
void	setSqlMapProperties(Properties sqlMapProperties) Set optional properties to be passed into the XmlSqlMapBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlMapFactoryBean

public SqlMapFactoryBean()

Method Detail

setConfigLocation

public void setConfigLocation(Resource configLocation)

Set the location of the iBATIS SqlMap config file. A typical value is "WEB-INF/sql-map-config.xml".

setSqlMapProperties

public void setSqlMapProperties(Properties sqlMapProperties)

Set optional properties to be passed into the XmlSqlMapBuilder.

See Also:

XmlSqlMapBuilder.buildSqlMap(java.io.Reader, java.util.Properties)

afterPropertiesSet

public void afterPropertiesSet()
                        throws IOException

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

IOException

getObject

public Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

See Also:

FactoryBean.getObject()