Class DataLoaderHelper<K,V>

java.lang.Object

org.dataloader.DataLoaderHelper<K,V>

Type Parameters:

K - the type of keys

V - the type of values

class DataLoaderHelper<K,V>
extends Object

This helps break up the large DataLoader class functionality and it contains the logic to dispatch the promises on behalf of its peer dataloader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DataLoaderHelper.LoaderQueueEntry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final Try<V>	ALWAYS_FAILED
private final Object	batchLoadFunction
private final Clock	clock
private final DataLoader<K,V>	dataLoader
private final CacheMap<Object,V>	futureCache
private final AtomicReference<Instant>	lastDispatchTime
private final DataLoaderOptions	loaderOptions
private final List<DataLoaderHelper.LoaderQueueEntry<K, CompletableFuture<V>>>	loaderQueue
private final CompletableFuture<List<Try<V>>>	NOT_SUPPORTED
private final List<Try<V>>	NOT_SUPPORTED_LIST
private final StatisticsCollector	stats
private final ValueCache<K,V>	valueCache

Constructor Summary

Constructors

Constructor	Description
DataLoaderHelper(DataLoader<K,V> dataLoader, Object batchLoadFunction, DataLoaderOptions loaderOptions, CacheMap<Object,V> futureCache, ValueCache<K,V> valueCache, StatisticsCollector stats, Clock clock)

Method Summary

Modifier and Type	Method	Description
private void	assertResultSize(List<K> keys, List<V> values)
(package private) DispatchResult<V>	dispatch()
(package private) int	dispatchDepth()
private CompletableFuture<List<V>>	dispatchQueueBatch(List<K> keys, List<Object> callContexts, List<CompletableFuture<V>> queuedFutures)
(package private) Object	getCacheKey(K key)
(package private) Object	getCacheKeyWithContext(K key, Object context)
private CompletableFuture<List<Try<V>>>	getFromValueCache(List<K> keys)
(package private) Optional<CompletableFuture<V>>	getIfCompleted(K key)
(package private) Optional<CompletableFuture<V>>	getIfPresent(K key)
Instant	getLastDispatchTime()
private CompletableFuture<List<V>>	invokeListBatchLoader(List<K> keys, BatchLoaderEnvironment environment)
(package private) CompletableFuture<List<V>>	invokeLoader(List<K> keys, List<Object> keyContexts)
(package private) CompletableFuture<List<V>>	invokeLoader(List<K> keys, List<Object> keyContexts, boolean cachingEnabled)
(package private) CompletableFuture<V>	invokeLoaderImmediately(K key, Object keyContext, boolean cachingEnabled)
private CompletableFuture<List<V>>	invokeMapBatchLoader(List<K> keys, BatchLoaderEnvironment environment)
private boolean	isMapLoader()
(package private) CompletableFuture<V>	load(K key, Object loadContext)
private CompletableFuture<V>	loadFromCache(K key, Object loadContext, boolean batchingEnabled)
(package private) Instant	now()
private void	possiblyClearCacheEntriesOnExceptions(List<K> keys)
private CompletableFuture<V>	queueOrInvokeLoader(K key, Object loadContext, boolean batchingEnabled, boolean cachingEnabled)
private CompletableFuture<List<V>>	setToValueCache(List<V> assembledValues, List<K> missedKeys, List<V> missedValues)
private CompletableFuture<List<V>>	sliceIntoBatchesOfBatches(List<K> keys, List<CompletableFuture<V>> queuedFutures, List<Object> callContexts, int maxBatchSize)

Methods inherited from class Object

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

Field Details

dataLoader

private final DataLoader<K,V> dataLoader

batchLoadFunction

private final Object batchLoadFunction

loaderOptions

private final DataLoaderOptions loaderOptions

futureCache

private final CacheMap<Object,V> futureCache

valueCache

private final ValueCache<K,V> valueCache

loaderQueue

private final List<DataLoaderHelper.LoaderQueueEntry<K, CompletableFuture<V>>> loaderQueue

stats

private final StatisticsCollector stats

clock

private final Clock clock

lastDispatchTime

private final AtomicReference<Instant> lastDispatchTime

NOT_SUPPORTED_LIST

private final List<Try<V>> NOT_SUPPORTED_LIST

NOT_SUPPORTED

private final CompletableFuture<List<Try<V>>> NOT_SUPPORTED

ALWAYS_FAILED

private final Try<V> ALWAYS_FAILED

Constructor Details

DataLoaderHelper

DataLoaderHelper(DataLoader<K,V> dataLoader,
 Object batchLoadFunction,
 DataLoaderOptions loaderOptions,
 CacheMap<Object,V> futureCache,
 ValueCache<K,V> valueCache,
 StatisticsCollector stats,
 Clock clock)

Method Details

now

Instant now()

getLastDispatchTime

public Instant getLastDispatchTime()

getIfPresent

Optional<CompletableFuture<V>> getIfPresent(K key)

getIfCompleted

Optional<CompletableFuture<V>> getIfCompleted(K key)

load

CompletableFuture<V> load(K key,
 Object loadContext)

getCacheKey

Object getCacheKey(K key)

getCacheKeyWithContext

Object getCacheKeyWithContext(K key,
 Object context)

dispatch

DispatchResult<V> dispatch()

sliceIntoBatchesOfBatches

private CompletableFuture<List<V>> sliceIntoBatchesOfBatches(List<K> keys,
 List<CompletableFuture<V>> queuedFutures,
 List<Object> callContexts,
 int maxBatchSize)

dispatchQueueBatch

private CompletableFuture<List<V>> dispatchQueueBatch(List<K> keys,
 List<Object> callContexts,
 List<CompletableFuture<V>> queuedFutures)

assertResultSize

private void assertResultSize(List<K> keys,
 List<V> values)

possiblyClearCacheEntriesOnExceptions

private void possiblyClearCacheEntriesOnExceptions(List<K> keys)

loadFromCache

private CompletableFuture<V> loadFromCache(K key,
 Object loadContext,
 boolean batchingEnabled)

queueOrInvokeLoader

private CompletableFuture<V> queueOrInvokeLoader(K key,
 Object loadContext,
 boolean batchingEnabled,
 boolean cachingEnabled)

invokeLoaderImmediately

CompletableFuture<V> invokeLoaderImmediately(K key,
 Object keyContext,
 boolean cachingEnabled)

invokeLoader

CompletableFuture<List<V>> invokeLoader(List<K> keys,
 List<Object> keyContexts,
 boolean cachingEnabled)

invokeLoader

CompletableFuture<List<V>> invokeLoader(List<K> keys,
 List<Object> keyContexts)

invokeListBatchLoader

private CompletableFuture<List<V>> invokeListBatchLoader(List<K> keys,
 BatchLoaderEnvironment environment)

invokeMapBatchLoader

private CompletableFuture<List<V>> invokeMapBatchLoader(List<K> keys,
 BatchLoaderEnvironment environment)

isMapLoader

private boolean isMapLoader()

dispatchDepth

int dispatchDepth()

getFromValueCache

private CompletableFuture<List<Try<V>>> getFromValueCache(List<K> keys)

setToValueCache

private CompletableFuture<List<V>> setToValueCache(List<V> assembledValues,
 List<K> missedKeys,
 List<V> missedValues)