Package org.springframework.batch.item.data.builder

Class MongoCursorItemReaderBuilder<T>

java.lang.Object

org.springframework.batch.item.data.builder.MongoCursorItemReaderBuilder<T>

public class MongoCursorItemReaderBuilder<T>
extends Object

Since:

5.1

Author:

LEE Juchan, Mahmoud Ben Hassine

See Also:

• MongoCursorItemReader

Constructor Summary

Constructors

Constructor	Description
MongoCursorItemReaderBuilder()

Method Summary

Modifier and Type	Method	Description
MongoCursorItemReaderBuilder<T>	batchSize(int batchSize)	The size of batches to use when iterating over results.
MongoCursorItemReader<T>	build()
MongoCursorItemReaderBuilder<T>	collection(String collection)	Establish an optional collection that can be queried.
MongoCursorItemReaderBuilder<T>	currentItemCount(int currentItemCount)	Index for the current item.
MongoCursorItemReaderBuilder<T>	fields(String fields)	JSON defining the fields to be returned from the matching documents by MongoDB.
MongoCursorItemReaderBuilder<T>	hint(String hint)	JSON String telling MongoDB what index to use.
MongoCursorItemReaderBuilder<T>	jsonQuery(String query)	A JSON formatted MongoDB jsonQuery.
MongoCursorItemReaderBuilder<T>	limit(int limit)	The query limit
MongoCursorItemReaderBuilder<T>	maxItemCount(int maxItemCount)	Configure the max number of items to be read.
MongoCursorItemReaderBuilder<T>	maxTime(Duration maxTime)	The maximum execution time for the query
MongoCursorItemReaderBuilder<T>	name(String name)	The name used to calculate the key within the ExecutionContext.
MongoCursorItemReaderBuilder<T>	parameterValues(List<Object> parameterValues)	Values to be substituted in for each of the parameters in the query.
MongoCursorItemReaderBuilder<T>	query(org.springframework.data.mongodb.core.query.Query query)	Provide a Spring Data Mongo Query.
MongoCursorItemReaderBuilder<T>	saveState(boolean saveState)	Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.
MongoCursorItemReaderBuilder<T>	sorts(Map<String,org.springframework.data.domain.Sort.Direction> sorts)	Map of property names/Sort.Direction values to sort the input by.
MongoCursorItemReaderBuilder<T>	targetType(Class<? extends T> targetType)	The targetType of object to be returned for each AbstractItemCountingItemStreamItemReader.read() call.
MongoCursorItemReaderBuilder<T>	template(org.springframework.data.mongodb.core.MongoOperations template)	Used to perform operations against the MongoDB instance.

Methods inherited from class java.lang.Object

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

Constructor Details

MongoCursorItemReaderBuilder

public MongoCursorItemReaderBuilder()

Method Details

saveState

public MongoCursorItemReaderBuilder<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.

name

public MongoCursorItemReaderBuilder<T> name(String name)

The name used to calculate the key within the ExecutionContext. Required if saveState(boolean) is set to true.

Parameters:

name - name of the reader instance

Returns:

The current instance of the builder.

See Also:

• ItemStreamSupport.setName(String)

maxItemCount

public MongoCursorItemReaderBuilder<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)

currentItemCount

public MongoCursorItemReaderBuilder<T> currentItemCount(int currentItemCount)

Index for the current item. Used on restarts to indicate where to start from.

Parameters:

currentItemCount - current index

Returns:

this instance for method chaining

See Also:

• AbstractItemCountingItemStreamItemReader.setCurrentItemCount(int)

template

public MongoCursorItemReaderBuilder<T> template(org.springframework.data.mongodb.core.MongoOperations template)

Used to perform operations against the MongoDB instance. Also handles the mapping of documents to objects.

Parameters:

template - the MongoOperations instance to use

Returns:

The current instance of the builder

See Also:

• MongoOperations
• MongoCursorItemReader.setTemplate(MongoOperations)

targetType

public MongoCursorItemReaderBuilder<T> targetType(Class<? extends T> targetType)

The targetType of object to be returned for each AbstractItemCountingItemStreamItemReader.read() call.

Parameters:

targetType - the targetType of object to return

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setTargetType(Class)

collection

public MongoCursorItemReaderBuilder<T> collection(String collection)

Establish an optional collection that can be queried.

Parameters:

collection - Mongo collection to be queried.

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setCollection(String)

query

public MongoCursorItemReaderBuilder<T> query(org.springframework.data.mongodb.core.query.Query query)

Provide a Spring Data Mongo Query. This will take precedence over a JSON configured query.

Parameters:

query - Query to execute

Returns:

this instance for method chaining

See Also:

• MongoCursorItemReader.setQuery(Query)

jsonQuery

public MongoCursorItemReaderBuilder<T> jsonQuery(String query)

A JSON formatted MongoDB jsonQuery. Parameterization of the provided jsonQuery is allowed via ?<index> placeholders where the <index> indicates the index of the parameterValue to substitute.

Parameters:

query - JSON formatted Mongo jsonQuery

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setQuery(String)

parameterValues

public MongoCursorItemReaderBuilder<T> parameterValues(List<Object> parameterValues)

Values to be substituted in for each of the parameters in the query.

Parameters:

parameterValues - values

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setParameterValues(List)

fields

public MongoCursorItemReaderBuilder<T> fields(String fields)

JSON defining the fields to be returned from the matching documents by MongoDB.

Parameters:

fields - JSON string that identifies the fields to sort by.

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setFields(String)

sorts

public MongoCursorItemReaderBuilder<T> sorts(Map<String,org.springframework.data.domain.Sort.Direction> sorts)

Map of property names/Sort.Direction values to sort the input by.

Parameters:

sorts - map of properties and direction to sort each.

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setSort(Map)

hint

public MongoCursorItemReaderBuilder<T> hint(String hint)

JSON String telling MongoDB what index to use.

Parameters:

hint - string indicating what index to use.

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setHint(String)

batchSize

public MongoCursorItemReaderBuilder<T> batchSize(int batchSize)

The size of batches to use when iterating over results.

Parameters:

batchSize - string indicating what index to use.

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setHint(String)

limit

public MongoCursorItemReaderBuilder<T> limit(int limit)

The query limit

Parameters:

limit - The limit

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setLimit(int)

maxTime

public MongoCursorItemReaderBuilder<T> maxTime(Duration maxTime)

The maximum execution time for the query

Parameters:

maxTime - The max time

Returns:

The current instance of the builder

See Also:

• MongoCursorItemReader.setMaxTime(Duration)

build

public MongoCursorItemReader<T> build()