Package org.mybatis.spring.batch.builder
Class MyBatisPagingItemReaderBuilder<T>
- java.lang.Object
-
- org.mybatis.spring.batch.builder.MyBatisPagingItemReaderBuilder<T>
-
public class MyBatisPagingItemReaderBuilder<T> extends java.lang.Object
A builder for theMyBatisPagingItemReader
.- Since:
- 2.0.0
- Author:
- Kazuki Shimizu
- See Also:
MyBatisPagingItemReader
-
-
Constructor Summary
Constructors Constructor Description MyBatisPagingItemReaderBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MyBatisPagingItemReader<T>
build()
Returns a fully builtMyBatisPagingItemReader
.MyBatisPagingItemReaderBuilder<T>
maxItemCount(int maxItemCount)
Configure the max number of items to be read.MyBatisPagingItemReaderBuilder<T>
pageSize(int pageSize)
The number of records to request per page/query.MyBatisPagingItemReaderBuilder<T>
parameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
Set the parameter values to be used for the query execution.MyBatisPagingItemReaderBuilder<T>
queryId(java.lang.String queryId)
Set the query id identifying the statement in the SqlMap configuration file.MyBatisPagingItemReaderBuilder<T>
saveState(boolean saveState)
Configure if the state of theItemStreamSupport
should be persisted within theExecutionContext
for restart purposes.MyBatisPagingItemReaderBuilder<T>
sqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
Set theSqlSessionFactory
to be used by writer for database access.
-
-
-
Method Detail
-
sqlSessionFactory
public MyBatisPagingItemReaderBuilder<T> sqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
Set theSqlSessionFactory
to be used by writer for database access.- Parameters:
sqlSessionFactory
- theSqlSessionFactory
to be used by writer for database access- Returns:
- this instance for method chaining
- See Also:
MyBatisPagingItemReader.setSqlSessionFactory(SqlSessionFactory)
-
queryId
public MyBatisPagingItemReaderBuilder<T> queryId(java.lang.String queryId)
Set the query id identifying the statement in the SqlMap configuration file.- Parameters:
queryId
- the id for the query- Returns:
- this instance for method chaining
- See Also:
MyBatisPagingItemReader.setQueryId(String)
-
parameterValues
public MyBatisPagingItemReaderBuilder<T> parameterValues(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
Set the parameter values to be used for the query execution.- Parameters:
parameterValues
- the parameter values to be used for the query execution- Returns:
- this instance for method chaining
- See Also:
MyBatisPagingItemReader.setParameterValues(Map)
-
pageSize
public MyBatisPagingItemReaderBuilder<T> pageSize(int pageSize)
The number of records to request per page/query. Defaults to 10. Must be greater than zero.- Parameters:
pageSize
- number of items- Returns:
- this instance for method chaining
- See Also:
AbstractPagingItemReader.setPageSize(int)
-
saveState
public MyBatisPagingItemReaderBuilder<T> saveState(boolean saveState)
Configure if the state of theItemStreamSupport
should be persisted within theExecutionContext
for restart purposes.- Parameters:
saveState
- defaults to true- Returns:
- The current instance of the builder.
- See Also:
AbstractItemCountingItemStreamItemReader.setSaveState(boolean)
-
maxItemCount
public MyBatisPagingItemReaderBuilder<T> maxItemCount(int maxItemCount)
Configure the max number of items to be read.- Parameters:
maxItemCount
- the max items to be read- Returns:
- The current instance of the builder.
- See Also:
AbstractItemCountingItemStreamItemReader.setMaxItemCount(int)
-
build
public MyBatisPagingItemReader<T> build()
Returns a fully builtMyBatisPagingItemReader
.- Returns:
- the reader
-
-