com.linkedin.parseq.batching

Class SimpleBatchingStrategy<K,T>

java.lang.Object

com.linkedin.parseq.batching.BatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

com.linkedin.parseq.batching.SimpleBatchingStrategy<K,T>

Type Parameters:

K - Type of a Key

T - Type of a Value

public abstract class SimpleBatchingStrategy<K,T>
extends BatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

A simple BatchingStrategy that groups all keys into one batch.

Author:

Jaroslaw Odzga (jodzga@linkedin.com)

Field Summary

Fields inherited from class com.linkedin.parseq.batching.BatchingStrategy

DEFAULT_MAX_BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
SimpleBatchingStrategy()

Method Summary

Modifier and Type	Method and Description
com.linkedin.parseq.batching.SimpleBatchingStrategy.Group	classify(K key) Classify the K Key and by doing so assign it to a G group.
abstract void	executeBatch(Batch<K,T> batch) This method will be called for a Batch.
void	executeBatch(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group, Batch<K,T> batch) This method will be called for every Batch.
String	getBatchName(Batch<K,T> batch) Overriding this method allows providing custom name for a batch.
String	getBatchName(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group, Batch<K,T> batch) Overriding this method allows providing custom name for a batch.

Methods inherited from class com.linkedin.parseq.batching.BatchingStrategy

batchable, batchable, executeBatchWithContext, getBatchAggregationTimeMetric, getBatchSizeMetric, keySize, maxBatchSizeForGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBatchingStrategy

public SimpleBatchingStrategy()

Method Detail

classify

public final com.linkedin.parseq.batching.SimpleBatchingStrategy.Group classify(K key)

Description copied from class: BatchingStrategy

Classify the K Key and by doing so assign it to a G group. If two keys are classified by the same group then they will belong to the same Batch. This method needs to be thread safe.

Specified by:

classify in class BatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

Parameters:

key - key to be classified

Returns:

Group that represents a batch the key will belong to

executeBatch

public final void executeBatch(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group,
                               Batch<K,T> batch)

Description copied from class: BatchingStrategy

This method will be called for every Batch. Implementation of this method must make sure that all SettablePromise contained in the Batch will eventually be resolved - typically asynchronously. Failing to eventually resolve any of the promises may lead to plan that never completes i.e. appears to hung and may lead to a memory leak.

Specified by:

executeBatch in class BatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

Parameters:

group - group that represents the batch

batch - batch contains collection of SettablePromise that eventually need to be resolved - typically asynchronously

getBatchName

public final String getBatchName(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group,
                                 Batch<K,T> batch)

Description copied from class: BatchingStrategy

Overriding this method allows providing custom name for a batch. Name will appear in the ParSeq trace as a description of the task that executes the batch.

Overrides:

getBatchName in class BatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

Parameters:

group - group to be described

batch - batch to be described

Returns:

name for the batch and group

getBatchName

public String getBatchName(Batch<K,T> batch)

Overriding this method allows providing custom name for a batch. Name will appear in the ParSeq trace as a description of the task that executes the batch.

Parameters:

batch - batch to be described

Returns:

name for the batch

executeBatch

public abstract void executeBatch(Batch<K,T> batch)

This method will be called for a Batch. Implementation of this method must make sure that all SettablePromise contained in the Batch will eventually be resolved - typically asynchronously. Failing to eventually resolve any of the promises may lead to plan that never completes i.e. appears to hung and may lead to a memory leak.

Parameters:

batch - batch contains collection of SettablePromise that eventually need to be resolved - typically asynchronously