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

Class MongoPagingItemReaderBuilder<T>

java.lang.Object

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

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

Type Parameters:

T - type of items to read.

public class MongoPagingItemReaderBuilder<T>
extends MongoItemReaderBuilder<T>

Builder for MongoPagingItemReader.

Since:

5.1

Author:

Glenn Renfro, Mahmoud Ben Hassine, Drummond Dawson, Parikshit Dutta

Field Summary

Fields inherited from class org.springframework.batch.item.data.builder.MongoItemReaderBuilder

collection, currentItemCount, fields, hint, jsonQuery, maxItemCount, name, pageSize, parameterValues, query, saveState, sorts, targetType, template

Constructor Summary

Constructors

Constructor	Description
MongoPagingItemReaderBuilder()

Method Summary

Modifier and Type	Method	Description
MongoPagingItemReader<T>	build()	Validates and builds a MongoItemReader.
MongoPagingItemReaderBuilder<T>	collection(String collection)	Establish an optional collection that can be queried.
MongoPagingItemReaderBuilder<T>	currentItemCount(int currentItemCount)	Index for the current item.
MongoPagingItemReaderBuilder<T>	fields(String fields)	JSON defining the fields to be returned from the matching documents by MongoDB.
MongoPagingItemReaderBuilder<T>	hint(String hint)	JSON String telling MongoDB what index to use.
MongoPagingItemReaderBuilder<T>	jsonQuery(String query)	A JSON formatted MongoDB jsonQuery.
MongoPagingItemReaderBuilder<T>	maxItemCount(int maxItemCount)	Configure the max number of items to be read.
MongoPagingItemReaderBuilder<T>	name(String name)	The name used to calculate the key within the ExecutionContext.
MongoPagingItemReaderBuilder<T>	pageSize(int pageSize)	The number of items to be read with each page.
MongoPagingItemReaderBuilder<T>	parameterValues(Object... parameterValues)	Values to be substituted in for each of the parameters in the query.
MongoPagingItemReaderBuilder<T>	parameterValues(List<Object> parameterValues)	List of values to be substituted in for each of the parameters in the query.
MongoPagingItemReaderBuilder<T>	query(org.springframework.data.mongodb.core.query.Query query)	Provide a Spring Data Mongo Query.
MongoPagingItemReaderBuilder<T>	saveState(boolean saveState)	Configure if the state of the ItemStreamSupport should be persisted within the ExecutionContext for restart purposes.
MongoPagingItemReaderBuilder<T>	sorts(Map<String,org.springframework.data.domain.Sort.Direction> sorts)	Map of property names/Sort.Direction values to sort the input by.
MongoPagingItemReaderBuilder<T>	targetType(Class<? extends T> targetType)	The type of object to be returned for each AbstractItemCountingItemStreamItemReader.read() call.
MongoPagingItemReaderBuilder<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

MongoPagingItemReaderBuilder

public MongoPagingItemReaderBuilder()

Method Details

saveState

public MongoPagingItemReaderBuilder<T> saveState(boolean saveState)

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

Overrides:

saveState in class MongoItemReaderBuilder<T>

Parameters:

saveState - defaults to true

Returns:

The current instance of the builder.

name

public MongoPagingItemReaderBuilder<T> name(String name)

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

Overrides:

name in class MongoItemReaderBuilder<T>

Parameters:

name - name of the reader instance

Returns:

The current instance of the builder.

See Also:

• ItemStreamSupport.setName(String)

maxItemCount

public MongoPagingItemReaderBuilder<T> maxItemCount(int maxItemCount)

Configure the max number of items to be read.

Overrides:

maxItemCount in class MongoItemReaderBuilder<T>

Parameters:

maxItemCount - the max items to be read

Returns:

The current instance of the builder.

See Also:

• AbstractItemCountingItemStreamItemReader.setMaxItemCount(int)

currentItemCount

public MongoPagingItemReaderBuilder<T> currentItemCount(int currentItemCount)

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

Overrides:

currentItemCount in class MongoItemReaderBuilder<T>

Parameters:

currentItemCount - current index

Returns:

this instance for method chaining

See Also:

• AbstractItemCountingItemStreamItemReader.setCurrentItemCount(int)

template

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

Overrides:

template in class MongoItemReaderBuilder<T>

Parameters:

template - the MongoOperations instance to use

Returns:

The current instance of the builder

See Also:

• MongoOperations
• MongoItemReader.setTemplate(MongoOperations)

jsonQuery

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

Overrides:

jsonQuery in class MongoItemReaderBuilder<T>

Parameters:

query - JSON formatted Mongo jsonQuery

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setQuery(String)

targetType

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

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

Overrides:

targetType in class MongoItemReaderBuilder<T>

Parameters:

targetType - the type of object to return

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setTargetType(Class)

parameterValues

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

List of values to be substituted in for each of the parameters in the query.

Overrides:

parameterValues in class MongoItemReaderBuilder<T>

Parameters:

parameterValues - values

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setParameterValues(List)

parameterValues

public MongoPagingItemReaderBuilder<T> parameterValues(Object... parameterValues)

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

Overrides:

parameterValues in class MongoItemReaderBuilder<T>

Parameters:

parameterValues - values

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setParameterValues(List)

fields

public MongoPagingItemReaderBuilder<T> fields(String fields)

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

Overrides:

fields in class MongoItemReaderBuilder<T>

Parameters:

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

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setFields(String)

sorts

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

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

Overrides:

sorts in class MongoItemReaderBuilder<T>

Parameters:

sorts - map of properties and direction to sort each.

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setSort(Map)

collection

public MongoPagingItemReaderBuilder<T> collection(String collection)

Establish an optional collection that can be queried.

Overrides:

collection in class MongoItemReaderBuilder<T>

Parameters:

collection - Mongo collection to be queried.

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setCollection(String)

hint

public MongoPagingItemReaderBuilder<T> hint(String hint)

JSON String telling MongoDB what index to use.

Overrides:

hint in class MongoItemReaderBuilder<T>

Parameters:

hint - string indicating what index to use.

Returns:

The current instance of the builder

See Also:

• MongoItemReader.setHint(String)

pageSize

public MongoPagingItemReaderBuilder<T> pageSize(int pageSize)

The number of items to be read with each page.

Overrides:

pageSize in class MongoItemReaderBuilder<T>

Parameters:

pageSize - the number of items

Returns:

this instance for method chaining

See Also:

• AbstractPaginatedDataItemReader.setPageSize(int)

query

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

Overrides:

query in class MongoItemReaderBuilder<T>

Parameters:

query - Query to execute

Returns:

this instance for method chaining

See Also:

• MongoItemReader.setQuery(Query)

build

public MongoPagingItemReader<T> build()

Description copied from class: MongoItemReaderBuilder

Validates and builds a MongoItemReader.

Overrides:

build in class MongoItemReaderBuilder<T>

Returns:

a MongoItemReader