com.linkedin.parseq.batching

Class SimpleTaskBatchingStrategy<K,T>

java.lang.Object

com.linkedin.parseq.batching.BatchingStrategy<G,K,T>

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

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

Type Parameters:

K - Type of a Key

T - Type of a Value

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

A simple TaskBatchingStrategy 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
SimpleTaskBatchingStrategy()

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.
String	getBatchName(Set<K> batch) Overriding this method allows providing custom name for a batch.
String	getBatchName(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group, Set<K> keys) Overriding this method allows providing custom name for a batch.
abstract com.linkedin.parseq.Task<Map<K,com.linkedin.parseq.function.Try<T>>>	taskForBatch(Set<K> keys) This method will be called for every batch.
com.linkedin.parseq.Task<Map<K,com.linkedin.parseq.function.Try<T>>>	taskForBatch(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group, Set<K> keys) This method will be called for every batch.

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

executeBatch, executeBatchWithContext, getBatchName

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

batchable, batchable, getBatchAggregationTimeMetric, getBatchSizeMetric, keySize, maxBatchSizeForGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTaskBatchingStrategy

public SimpleTaskBatchingStrategy()

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

taskForBatch

public com.linkedin.parseq.Task<Map<K,com.linkedin.parseq.function.Try<T>>> taskForBatch(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group,
                                                                                         Set<K> keys)

Description copied from class: TaskBatchingStrategy

This method will be called for every batch. It returns a map that for every key contains either a success with a value or a failure. If returned map does not contain results for some keys the tasks for which results are missing will fail.

Specified by:

taskForBatch in class TaskBatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

Parameters:

group - group that represents the batch

keys - set of keys belonging to the batch

Returns:

A map that for every key contains either a success with a value or a failure. If returned map does not contain results for some keys the tasks for which results are missing will fail.

getBatchName

public final String getBatchName(com.linkedin.parseq.batching.SimpleBatchingStrategy.Group group,
                                 Set<K> keys)

Description copied from class: TaskBatchingStrategy

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 TaskBatchingStrategy<com.linkedin.parseq.batching.SimpleBatchingStrategy.Group,K,T>

Parameters:

group - group to be described

keys - set of keys belonging to the batch that needs to be described

Returns:

name for the batch

getBatchName

public String getBatchName(Set<K> 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 - set of keys belonging to the batch that needs to be described

Returns:

name for the batch

taskForBatch

public abstract com.linkedin.parseq.Task<Map<K,com.linkedin.parseq.function.Try<T>>> taskForBatch(Set<K> keys)

This method will be called for every batch. It returns a map that for every key contains either a success with a value or a failure. If returned map does not contain results for some keys the tasks for which results are missing will fail.

Parameters:

keys - set of keys belonging to the batch

Returns:

A map that for every key contains either a success with a value or a failure. If returned map does not contain results for some keys the tasks for which results are missing will fail.