Package de.uni_trier.wi2.procake.similarity.impl

Class CaffeineSimilarityCache

java.lang.Object

de.uni_trier.wi2.procake.similarity.wf.AbstractSimilarityCache

de.uni_trier.wi2.procake.similarity.impl.CaffeineSimilarityCache

All Implemented Interfaces:

SimilarityCache, Iterable<Map.Entry<DataObjectPair,Similarity>>

Direct Known Subclasses:

FileBasedCaffeineSimilarityCache

public class CaffeineSimilarityCache
extends AbstractSimilarityCache

Stores pairs of data object IDs with their similarity into an asynchronous runtime cache, allowing read- and write operations on its entries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaffeineSimilarityCache.Builder
static class	CaffeineSimilarityCache.GenericBuilder<T extends CaffeineSimilarityCache.GenericBuilder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
protected com.github.benmanes.caffeine.cache.Cache<DataObjectPair,Similarity>	cache	The cache that is used at runtime
protected Duration	expireAfterAccessDuration
protected Duration	expireAfterWriteDuration
protected long	maximumSize	The maximum amount of entries that the cache can hold.
protected long	maximumWeight
protected com.github.benmanes.caffeine.cache.Weigher<DataObjectPair,Similarity>	weigher

Fields inherited from class de.uni_trier.wi2.procake.similarity.wf.AbstractSimilarityCache

lastTimeNanosForGetSimilarity, listeners, readOnly, recordStats

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CaffeineSimilarityCache(CaffeineSimilarityCache.GenericBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
protected com.github.benmanes.caffeine.cache.Caffeine<Object,Object>	buildCache()	This method is invoked by the init method to build the cache.
static CaffeineSimilarityCache.GenericBuilder<?>	builder()
void	clear()	Removes all similarities from the cache
boolean	containsSimilarity(DataObject queryObject, DataObject caseObject)
protected Similarity	get(DataObject queryObject, DataObject caseObject)
ConcurrentMap<DataObjectPair,Similarity>	getAsMap()
Collection<Similarity>	getSimilarities()
@NotNull Iterator<Map.Entry<DataObjectPair,Similarity>>	iterator()
void	print()
protected void	remove(String queryId, String caseId)
void	setSimilarity(DataObject queryObject, DataObject caseObject, Similarity similarity)	Puts a new entry into the cache, the IDs of queryObject and caseObject as the key and similarity as its value.
long	size()
Spliterator<Map.Entry<DataObjectPair,Similarity>>	spliterator()

Methods inherited from class de.uni_trier.wi2.procake.similarity.wf.AbstractSimilarityCache

addListener, forEach, getCacheEntry, getLastTimeNanosForGetSimilarity, getSimilarity, isEmpty, notifyListeners, removeEntriesById, removeEntryByIds, removeListener, resetStats, setSimilarity, updateStats

Methods inherited from class java.lang.Object

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

Field Details

cache

protected com.github.benmanes.caffeine.cache.Cache<DataObjectPair,Similarity> cache

The cache that is used at runtime

maximumSize

protected long maximumSize

The maximum amount of entries that the cache can hold. Note that there is no implicit default bound.

maximumWeight

protected long maximumWeight

weigher

protected com.github.benmanes.caffeine.cache.Weigher<DataObjectPair,Similarity> weigher

expireAfterAccessDuration

protected Duration expireAfterAccessDuration

expireAfterWriteDuration

protected Duration expireAfterWriteDuration

Constructor Details

CaffeineSimilarityCache

protected CaffeineSimilarityCache(CaffeineSimilarityCache.GenericBuilder<?> builder)

Method Details

getAsMap

public ConcurrentMap<DataObjectPair,Similarity> getAsMap()

size

public long size()

Returns:

number of entries in the cache

getSimilarities

public Collection<Similarity> getSimilarities()

Returns:

all similarity objects from the cache

buildCache

protected com.github.benmanes.caffeine.cache.Caffeine<Object,Object> buildCache()

This method is invoked by the init method to build the cache. If specified, builds the cache with the set maximum size of entries it can hold. The cache will automatically remove an entry if an incoming one would exceed the maximum size.

containsSimilarity

public boolean containsSimilarity(DataObject queryObject,
 DataObject caseObject)

Parameters:

queryObject - data object

caseObject - data object

Returns:

whether the cache is holding an entry for queryObject and caseObject

get

protected Similarity get(DataObject queryObject,
 DataObject caseObject)

Specified by:

get in class AbstractSimilarityCache

setSimilarity

public void setSimilarity(DataObject queryObject,
 DataObject caseObject,
 Similarity similarity)

Description copied from interface: SimilarityCache

Puts a new entry into the cache, the IDs of queryObject and caseObject as the key and similarity as its value.

Parameters:

queryObject - data object

caseObject - data object

similarity - the similarity of queryObject and caseObject

clear

public void clear()

Description copied from interface: SimilarityCache

Removes all similarities from the cache

remove

protected void remove(String queryId,
 String caseId)

Specified by:

remove in class AbstractSimilarityCache

print

public void print()

builder

public static CaffeineSimilarityCache.GenericBuilder<?> builder()

iterator

@NotNull
public @NotNull Iterator<Map.Entry<DataObjectPair,Similarity>> iterator()

spliterator

public Spliterator<Map.Entry<DataObjectPair,Similarity>> spliterator()