Package org.mybatis.spring.batch.builder

Class MyBatisCursorItemReaderBuilder<T>

java.lang.Object

org.mybatis.spring.batch.builder.MyBatisCursorItemReaderBuilder<T>

public class MyBatisCursorItemReaderBuilder<T>
extends Object

A builder for the MyBatisCursorItemReader.

Since:

2.0.0

Author:

Kazuki Shimizu

See Also:

MyBatisCursorItemReader

Constructor Summary

Constructors

Constructor	Description
MyBatisCursorItemReaderBuilder()

Method Summary

Modifier and Type	Method	Description
MyBatisCursorItemReader<T>	build()	Returns a fully built MyBatisCursorItemReader.
MyBatisCursorItemReaderBuilder<T>	maxItemCount(int maxItemCount)	Configure the max number of items to be read.
MyBatisCursorItemReaderBuilder<T>	parameterValues(Map<String,Object> parameterValues)	Set the parameter values to be used for the query execution.
MyBatisCursorItemReaderBuilder<T>	parameterValuesSupplier(Supplier<Map<String,Object>> parameterValuesSupplier)	Set the parameter supplier to be used to get parameters for the query execution.
MyBatisCursorItemReaderBuilder<T>	queryId(String queryId)	Set the query id identifying the statement in the SqlMap configuration file.
MyBatisCursorItemReaderBuilder<T>	saveState(boolean saveState)	Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.
MyBatisCursorItemReaderBuilder<T>	sqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)	Set the SqlSessionFactory to be used by reader for database access.

Methods inherited from class java.lang.Object

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

Constructor Details

MyBatisCursorItemReaderBuilder

public MyBatisCursorItemReaderBuilder()

Method Details

sqlSessionFactory

public MyBatisCursorItemReaderBuilder<T> sqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)

Set the SqlSessionFactory to be used by reader for database access.

Parameters:

sqlSessionFactory - the SqlSessionFactory to be used by writer for database access

Returns:

this instance for method chaining

See Also:

MyBatisCursorItemReader.setSqlSessionFactory(SqlSessionFactory)

queryId

public MyBatisCursorItemReaderBuilder<T> queryId(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:

MyBatisCursorItemReader.setQueryId(String)

parameterValues

public MyBatisCursorItemReaderBuilder<T> parameterValues(Map<String,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:

MyBatisCursorItemReader.setParameterValues(Map)

parameterValuesSupplier

public MyBatisCursorItemReaderBuilder<T> parameterValuesSupplier(Supplier<Map<String,Object>> parameterValuesSupplier)

Set the parameter supplier to be used to get parameters for the query execution.

Parameters:

parameterValuesSupplier - the parameter supplier to be used to get parameters for the query execution

Returns:

this instance for method chaining

Since:

2.1.0

See Also:

MyBatisCursorItemReader.setParameterValuesSupplier(Supplier)

saveState

public MyBatisCursorItemReaderBuilder<T> saveState(boolean saveState)

Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.

Parameters:

saveState - defaults to true

Returns:

The current instance of the builder.

See Also:

AbstractItemCountingItemStreamItemReader.setSaveState(boolean)

maxItemCount

public MyBatisCursorItemReaderBuilder<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 MyBatisCursorItemReader<T> build()

Returns a fully built MyBatisCursorItemReader.

Returns:

the reader