Package org.mybatis.spring.batch
Class MyBatisPagingItemReader<T>
- java.lang.Object
-
- org.springframework.batch.item.ItemStreamSupport
-
- org.springframework.batch.item.support.AbstractItemStreamItemReader<T>
-
- org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>
-
- org.springframework.batch.item.database.AbstractPagingItemReader<T>
-
- org.mybatis.spring.batch.MyBatisPagingItemReader<T>
-
- All Implemented Interfaces:
org.springframework.batch.item.ItemReader<T>
,org.springframework.batch.item.ItemStream
,org.springframework.batch.item.ItemStreamReader<T>
,org.springframework.beans.factory.InitializingBean
public class MyBatisPagingItemReader<T> extends org.springframework.batch.item.database.AbstractPagingItemReader<T>
org.springframework.batch.item.ItemReader
for reading database records using MyBatis in a paging fashion.Provided to facilitate the migration from Spring-Batch iBATIS 2 page item readers to MyBatis 3.
- Since:
- 1.1.0
- Author:
- Eduardo Macarron
-
-
Constructor Summary
Constructors Constructor Description MyBatisPagingItemReader()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Check mandatory properties.protected void
doJumpToPage(int itemIndex)
protected void
doReadPage()
void
setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
The parameter values to be used for the query execution.void
setQueryId(java.lang.String queryId)
Public setter for the statement id identifying the statement in the SqlMap configuration file.void
setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
Public setter forSqlSessionFactory
for injection purposes.-
Methods inherited from class org.springframework.batch.item.database.AbstractPagingItemReader
doClose, doOpen, doRead, getPage, getPageSize, jumpToItem, setPageSize
-
Methods inherited from class org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader
close, getCurrentItemCount, isSaveState, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, update
-
-
-
-
Method Detail
-
setSqlSessionFactory
public void setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
Public setter forSqlSessionFactory
for injection purposes.- Parameters:
sqlSessionFactory
- a factory object for theSqlSession
.
-
setQueryId
public void setQueryId(java.lang.String queryId)
Public setter for the statement id identifying the statement in the SqlMap configuration file.- Parameters:
queryId
- the id for the statement
-
setParameterValues
public void setParameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
The parameter values to be used for the query execution.- Parameters:
parameterValues
- the values keyed by the parameter named used in the query string.
-
afterPropertiesSet
public void afterPropertiesSet() throws java.lang.Exception
Check mandatory properties.- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Overrides:
afterPropertiesSet
in classorg.springframework.batch.item.database.AbstractPagingItemReader<T>
- Throws:
java.lang.Exception
- See Also:
InitializingBean.afterPropertiesSet()
-
doReadPage
protected void doReadPage()
- Specified by:
doReadPage
in classorg.springframework.batch.item.database.AbstractPagingItemReader<T>
-
doJumpToPage
protected void doJumpToPage(int itemIndex)
- Specified by:
doJumpToPage
in classorg.springframework.batch.item.database.AbstractPagingItemReader<T>
-
-