Package de.uni_trier.wi2.procake.similarity.wf

Class AbstractSimilarityCache

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CaffeineSimilarityCache, SimpleSimilarityCache

public abstract class AbstractSimilarityCache
extends Object
implements SimilarityCache

Field Summary

Fields

Modifier and Type	Field	Description
protected long	lastTimeNanosForGetSimilarity
protected List<SimCacheListener>	listeners
protected boolean	readOnly
protected boolean	recordStats

Constructor Summary

Constructors

Constructor	Description
AbstractSimilarityCache()

Method Summary

Modifier and Type	Method	Description
void	addListener(SimCacheListener listener)	Adds a listener to the cache
void	forEach(Consumer<? super Map.Entry<DataObjectPair,Similarity>> action)
protected abstract Similarity	get(DataObject queryObject, DataObject caseObject)
Map.Entry<DataObjectPair,Similarity>	getCacheEntry(DataObjectPair dataObjects)
long	getLastTimeNanosForGetSimilarity()
Similarity	getSimilarity(DataObject queryObject, DataObject caseObject)
boolean	isEmpty()
protected void	notifyListeners(DataObjectPair key, Similarity similarity, SimCacheListener.NotificationType notificationType)
protected abstract void	remove(String queryId, String caseId)
void	removeEntriesById(String id)	Removes all entries with a query- and/or case id represented by the given id
void	removeEntryByIds(String queryId, String caseId)	Removes the first entry found with the given queryId and caseId from the cache, if such an entry exists
void	removeListener(SimCacheListener listener)	Removes a listener from the cache
protected void	resetStats(DataObjectPair dataObjects, Similarity similarity)
protected void	setSimilarity(Map<DataObjectPair,Similarity> cache, DataObject queryObject, DataObject caseObject, Similarity similarity)
protected void	updateStats(DataObjectPair dataObjects, Similarity similarity)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

iterator, spliterator

Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityCache

clear, containsSimilarity, getSimilarities, setSimilarity, size

Field Details

listeners

protected List<SimCacheListener> listeners

lastTimeNanosForGetSimilarity

protected long lastTimeNanosForGetSimilarity

recordStats

protected boolean recordStats

readOnly

protected boolean readOnly

Constructor Details

AbstractSimilarityCache

public AbstractSimilarityCache()

Method Details

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface SimilarityCache

Returns:

whether the cache holds no entries

addListener

public void addListener(SimCacheListener listener)

Description copied from interface: SimilarityCache

Adds a listener to the cache

Specified by:

addListener in interface SimilarityCache

Parameters:

listener - the listener to be attached to the cache

removeListener

public void removeListener(SimCacheListener listener)

Description copied from interface: SimilarityCache

Removes a listener from the cache

Specified by:

removeListener in interface SimilarityCache

Parameters:

listener - the listener to be detached from the cache

notifyListeners

protected void notifyListeners(DataObjectPair key,
 Similarity similarity,
 SimCacheListener.NotificationType notificationType)

forEach

public void forEach(Consumer<? super Map.Entry<DataObjectPair,Similarity>> action)

Specified by:

forEach in interface Iterable<Map.Entry<DataObjectPair,Similarity>>

getSimilarity

public Similarity getSimilarity(DataObject queryObject,
 DataObject caseObject)

Specified by:

getSimilarity in interface SimilarityCache

Parameters:

queryObject - data object

caseObject - data object

Returns:

the similarity of queryObject and caseObject (if the cache contains such an entry), null (otherwise)

get

protected abstract Similarity get(DataObject queryObject,
 DataObject caseObject)

setSimilarity

protected void setSimilarity(Map<DataObjectPair,Similarity> cache,
 DataObject queryObject,
 DataObject caseObject,
 Similarity similarity)

removeEntryByIds

public void removeEntryByIds(String queryId,
 String caseId)

Removes the first entry found with the given queryId and caseId from the cache, if such an entry exists

Parameters:

queryId - the id of the query object

caseId - the id of the case object

removeEntriesById

public void removeEntriesById(String id)

Removes all entries with a query- and/or case id represented by the given id

Parameters:

id - a query- or case id

remove

protected abstract void remove(String queryId,
 String caseId)

getCacheEntry

public Map.Entry<DataObjectPair,Similarity> getCacheEntry(DataObjectPair dataObjects)

Parameters:

dataObjects - a pair of data objects representing the key of the entry to be retrieved

Returns:

the entry with the given key (if such an entry exists), null (otherwise)

updateStats

protected void updateStats(DataObjectPair dataObjects,
 Similarity similarity)

resetStats

protected void resetStats(DataObjectPair dataObjects,
 Similarity similarity)

getLastTimeNanosForGetSimilarity

public long getLastTimeNanosForGetSimilarity()

Specified by:

getLastTimeNanosForGetSimilarity in interface SimilarityCache

Returns:

last time in nanoseconds for reading the cache