org.anvilpowered.anvil.api.datastore

Interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>

All Superinterfaces:

Component<TKey,TDataStore>, Repository<TKey,T,TDataStore>, StorageService<TKey,T,TDataStore>

All Known Subinterfaces:

BaseMongoCachedRepository<T,C>, BaseXodusCachedRepository<T,C>

All Known Implementing Classes:

BaseCachedRepository

public interface CachedRepository<TKey,T extends ObjectWithId<TKey>,C extends CacheService<TKey,T,TDataStore>,TDataStore>
extends Repository<TKey,T,TDataStore>

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
default java.util.Optional<C>	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

Method Detail

getRepositoryCacheService

default java.util.Optional<C> getRepositoryCacheService()

applyFromDBToCache

<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

toCache will run if and only if:

• - Cache is present

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

<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

toCache will run if and only if:

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

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

<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

cacheTransformer will run if and only if:

• - Cache is present

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

<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

cacheTransformer will run if and only if:

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

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

<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

cacheTransformer will run if and only if:

• - Cache is present

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

<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

cacheTransformer will run if and only if:

• - Cache is present

dbTransformer will run if and only if:

• - Optional result from cacheTransformer is present

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

<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

cacheTransformer will run if and only if:

• - Cache is present

dbTransformer will run if and only if:

• - Optional result from cacheTransformer is not present

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