org.springframework.orm.ibatis
Class SqlMapFactoryBean

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

All Implemented Interfaces:

FactoryBean, InitializingBean

public class SqlMapFactoryBean

extends java.lang.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).
java.lang.Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
java.lang.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? That is, will getObject() always return the same object?
void	setConfigLocation(Resource configLocation) Set the location of the iBATIS SqlMap config file.
void	setSqlMapProperties(java.util.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(java.util.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 java.io.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:

java.io.IOException

getObject

public java.lang.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.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

getObjectType

public java.lang.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, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

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?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton