org.anvilpowered.anvil.base.datastore

Class BaseCachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

java.lang.Object

org.anvilpowered.anvil.base.datastore.BaseComponent<TKey,TDataStore>

org.anvilpowered.anvil.base.datastore.BaseRepository<TKey,T,TDataStore>

org.anvilpowered.anvil.base.datastore.BaseCachedRepository<TKey,T,C,TDataStore>

All Implemented Interfaces:

CachedRepository<TKey,T,C,TDataStore>, Component<TKey,TDataStore>, Repository<TKey,T,TDataStore>, StorageService<TKey,T,TDataStore>, BaseStorageService<TKey,T,TDataStore>

public abstract class BaseCachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>
extends BaseRepository<TKey,T,TDataStore>
implements CachedRepository<TKey,T,C,TDataStore>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseCachedRepository(DataStoreContext<TKey,TDataStore> dataStoreContext)

Method Summary

Modifier and Type	Method and Description
<K> java.util.concurrent.CompletableFuture<K>	applyFromDBThroughCache(java.util.function.Supplier<K> fromDB, java.util.function.BiFunction<C,K,K> cacheTransformer) Usually used for editing model data
<K> java.util.concurrent.CompletableFuture<java.util.Optional<K>>	applyFromDBThroughCacheConditionally(java.util.function.Supplier<java.util.Optional<K>> fromDB, java.util.function.BiFunction<C,K,java.util.Optional<K>> cacheTransformer) Usually used for editing model data
<K> java.util.concurrent.CompletableFuture<K>	applyFromDBToCache(java.util.function.Supplier<K> fromDB, java.util.function.BiConsumer<C,K> toCache) Usually used when (updated) data from DB needs to be applied to cache
<K> java.util.concurrent.CompletableFuture<java.util.Optional<K>>	applyFromDBToCacheConditionally(java.util.function.Supplier<java.util.Optional<K>> fromDB, java.util.function.BiConsumer<C,K> toCache) Usually used when (updated) data from DB needs to be applied to cache
<K> java.util.concurrent.CompletableFuture<K>	applyThroughBoth(java.util.function.Function<C,K> cacheTransformer, java.util.function.Function<java.util.Optional<K>,K> dbTransformer) Usually used for editing model data
<K> java.util.concurrent.CompletableFuture<java.util.Optional<K>>	applyThroughBothConditionally(java.util.function.Function<C,java.util.Optional<K>> cacheTransformer, java.util.function.Function<K,K> dbTransformer) Usually used for retrieving or editing model data
<K> java.util.concurrent.CompletableFuture<java.util.Optional<K>>	applyToBothConditionally(java.util.function.Function<C,java.util.Optional<K>> cacheTransformer, java.util.function.Supplier<java.util.Optional<K>> dbSupplier) Usually used for retrieving or editing model data

Methods inherited from class org.anvilpowered.anvil.base.datastore.BaseRepository

getCreatedUtc

Methods inherited from class org.anvilpowered.anvil.base.datastore.BaseComponent

getDataStoreContext, getTKeyClass, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anvilpowered.anvil.api.datastore.CachedRepository

getRepositoryCacheService

Methods inherited from interface org.anvilpowered.anvil.api.datastore.Repository

getCreatedUtc

Methods inherited from interface org.anvilpowered.anvil.api.datastore.StorageService

deleteOne, deleteOne, generateEmpty, getAll, getAllIds, getOne, getOne, getTClass, insert, insertOne, parseAndDeleteOne, parseAndGetOne

Methods inherited from interface org.anvilpowered.anvil.api.datastore.Component

getDataStoreContext, getTKeyClass, parse, parseUnsafe

Methods inherited from interface org.anvilpowered.anvil.base.datastore.BaseStorageService

generateEmpty, parseAndDeleteOne, parseAndGetOne

Constructor Detail

BaseCachedRepository

protected BaseCachedRepository(DataStoreContext<TKey,TDataStore> dataStoreContext)

Method Detail

applyFromDBToCache

public <K> java.util.concurrent.CompletableFuture<K> applyFromDBToCache(java.util.function.Supplier<K> fromDB,
                                                                        java.util.function.BiConsumer<C,K> toCache)

Description copied from interface: CachedRepository

Usually used when (updated) data from DB needs to be applied to cache

toCache will run if and only if:

• - Cache is present

Specified by:

applyFromDBToCache in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned from the cache and database

Parameters:

fromDB - Supplier retrieving data from DB

toCache - BiConsumer applying DB data to cache

Returns:

Result from DB after it has (optionally) been applied to cache

applyFromDBToCacheConditionally

public <K> java.util.concurrent.CompletableFuture<java.util.Optional<K>> applyFromDBToCacheConditionally(java.util.function.Supplier<java.util.Optional<K>> fromDB,
                                                                                                         java.util.function.BiConsumer<C,K> toCache)

Description copied from interface: CachedRepository

Usually used when (updated) data from DB needs to be applied to cache

toCache will run if and only if:

• - Cache is present
• - Optional result from fromDB is present

Specified by:

applyFromDBToCacheConditionally in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned from the cache and database

Parameters:

fromDB - Supplier retrieving data from DB

toCache - BiConsumer applying DB data to cache.

Returns:

Result from DB after it has (optionally) been applied to cache

applyFromDBThroughCache

public <K> java.util.concurrent.CompletableFuture<K> applyFromDBThroughCache(java.util.function.Supplier<K> fromDB,
                                                                             java.util.function.BiFunction<C,K,K> cacheTransformer)

Description copied from interface: CachedRepository

Usually used for editing model data

cacheTransformer will run if and only if:

• - Cache is present

Specified by:

applyFromDBThroughCache in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned from the cache and database

Parameters:

fromDB - Supplier retrieving data from DB

cacheTransformer - BiFunction applying DB data to cache

Returns:

Result from cache

applyFromDBThroughCacheConditionally

public <K> java.util.concurrent.CompletableFuture<java.util.Optional<K>> applyFromDBThroughCacheConditionally(java.util.function.Supplier<java.util.Optional<K>> fromDB,
                                                                                                              java.util.function.BiFunction<C,K,java.util.Optional<K>> cacheTransformer)

Description copied from interface: CachedRepository

Usually used for editing model data

cacheTransformer will run if and only if:

• - Cache is present
• - Optional result from fromDB is present

Specified by:

applyFromDBThroughCacheConditionally in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned from the cache and database

Parameters:

fromDB - Supplier retrieving data from DB

cacheTransformer - BiFunction applying DB data to cache. Will only be run if Optional is present

Returns:

Result from cache if result and cache are present, otherwise from DB

applyThroughBoth

public <K> java.util.concurrent.CompletableFuture<K> applyThroughBoth(java.util.function.Function<C,K> cacheTransformer,
                                                                      java.util.function.Function<java.util.Optional<K>,K> dbTransformer)

Description copied from interface: CachedRepository

Usually used for editing model data

cacheTransformer will run if and only if:

• - Cache is present

Specified by:

applyThroughBoth in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned by the cache and database

Parameters:

cacheTransformer - Function applying transformation to data in cache and returning new data

dbTransformer - Function retrieving data from db. Optional is the result of the cache function (will be empty if the cache or the result is not present)

Returns:

Result from DB

applyThroughBothConditionally

public <K> java.util.concurrent.CompletableFuture<java.util.Optional<K>> applyThroughBothConditionally(java.util.function.Function<C,java.util.Optional<K>> cacheTransformer,
                                                                                                       java.util.function.Function<K,K> dbTransformer)

Description copied from interface: CachedRepository

Usually used for retrieving or editing model data

cacheTransformer will run if and only if:

• - Cache is present

dbTransformer will run if and only if:

• - Optional result from cacheTransformer is present

Specified by:

applyThroughBothConditionally in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned by the cache and database

Parameters:

cacheTransformer - Function applying transformation to data in cache and returning new data

dbTransformer - Function applying transformation to data in db

Returns:

K result from cache

applyToBothConditionally

public <K> java.util.concurrent.CompletableFuture<java.util.Optional<K>> applyToBothConditionally(java.util.function.Function<C,java.util.Optional<K>> cacheTransformer,
                                                                                                  java.util.function.Supplier<java.util.Optional<K>> dbSupplier)

Description copied from interface: CachedRepository

Usually used for retrieving or editing model data

cacheTransformer will run if and only if:

• - Cache is present

dbTransformer will run if and only if:

• - Optional result from cacheTransformer is not present

Specified by:

applyToBothConditionally in interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

Type Parameters:

K - The type returned by the cache and database

Parameters:

cacheTransformer - Function applying transformation to data in cache and returning new data

dbSupplier - Supplier retrieving data from db. Will only be run if Optional is not present

Returns:

K result from cache if present, otherwise from db