Interface IterationManager

All Known Implementing Classes:

DefaultIterationManager, ExternalSourceIterationManager

public interface IterationManager

Since:

9.0

Author:

wburns

Method Summary

Modifier and Type	Method	Description
int	activeIterations()
void	addKeyValueFilterConverterFactory(String name, KeyValueFilterConverterFactory factory)
IterationState	close(String iterationId)
IterableIterationResult	next(String iterationId, int batch)	Reds the next batch from the iterator associated with .
void	removeKeyValueFilterConverterFactory(String name)
IterationState	start(AdvancedCache cache, BitSet segments, String filterConverterFactory, List<byte[]> filterConverterParams, MediaType valueMediaType, int batch, boolean metadata, DeliveryGuarantee guarantee, IterationInitializationContext ctx)

Method Details

start

IterationState start(AdvancedCache cache,
 BitSet segments,
 String filterConverterFactory,
 List<byte[]> filterConverterParams,
 MediaType valueMediaType,
 int batch,
 boolean metadata,
 DeliveryGuarantee guarantee,
 IterationInitializationContext ctx)

next

IterableIterationResult next(String iterationId,
 int batch)

Reds the next batch from the iterator associated with .

Warning: This method can block.

Parameters:

iterationId - : The iterator identifier.

batch - : The maximum number of entries to include in the batch.

Returns:

An IterableIterationResult object with the current data and metadata about the iterator.

close

IterationState close(String iterationId)

addKeyValueFilterConverterFactory

void addKeyValueFilterConverterFactory(String name,
 KeyValueFilterConverterFactory factory)

removeKeyValueFilterConverterFactory

void removeKeyValueFilterConverterFactory(String name)

activeIterations

int activeIterations()