Verified Owner
Top Description Inners Fields Constructors Methods
org.jabref.logic.ai.summarization

public Class InMemorySummaryCache

extends Object
Class Inheritance
Imports
java.util.Collections, .IdentityHashMap, .Map, .Optional, org.jabref.logic.ai.summarization.repositories.SummariesRepository, org.jabref.model.ai.identifiers.FullBibEntry, org.jabref.model.ai.summarization.AiSummary, org.jabref.model.entry.BibEntry
Session-scoped RAM cache for AI summaries.

Keyed by BibEntry reference identity (using IdentityHashMap), so it works even for entries that have no citation key or a non-unique one.

On close(), entries whose BibEntry has a present and unique citation key and a valid AI library ID are flushed to the persistent SummariesRepository.

Thread-safe: all map operations are protected by a synchronized wrapper.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record
InMemorySummaryCache.CachedEntry

Field Summary

Modifier and TypeField and Description
private final Map<BibEntry, InMemorySummaryCache.CachedEntry>
cache

private final SummariesRepository
repository

Constructor Summary

AccessConstructor and Description
public
InMemorySummaryCache(SummariesRepository repository)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Writes all cached summaries to the persistent repository for entries whose citation key is present and unique and whose database has a valid AI library ID. Entries that do not satisfy both conditions are silently skipped.

public Optional<AiSummary>
get(BibEntry entry)

Returns the cached summary for entry, or Optional#empty() if none exists.

public void
put(FullBibEntry fullEntry, AiSummary summary)

Stores summary for fullEntry.

public void
remove(BibEntry entry)

Removes the cached summary for entry.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheback to summary
private final Map<BibEntry, InMemorySummaryCache.CachedEntry> cache
repositoryback to summary
private final SummariesRepository repository

Constructor Detail

InMemorySummaryCacheback to summary
public InMemorySummaryCache(SummariesRepository repository)

Method Detail

closeback to summary
public void close()

Writes all cached summaries to the persistent repository for entries whose citation key is present and unique and whose database has a valid AI library ID. Entries that do not satisfy both conditions are silently skipped.

Call this when the library or application is closing so that valid summaries survive the next restart.

getback to summary
public Optional<AiSummary> get(BibEntry entry)

Returns the cached summary for entry, or Optional#empty() if none exists.

putback to summary
public void put(FullBibEntry fullEntry, AiSummary summary)

Stores summary for fullEntry. Overwrites any previously cached summary for the same object reference.

removeback to summary
public void remove(BibEntry entry)

Removes the cached summary for entry. No-op if none was present.

org.jabref.logic.ai.summarization back to summary

private final Record InMemorySummaryCache.CachedEntry

extends Record
Class Inheritance
Record Components
summary:AiSummary 
fullEntry:FullBibEntry 

Field Summary

Modifier and TypeField and Description
private final FullBibEntry
fullEntry

Record Component accessed by fullEntry().

private final AiSummary
summary

Record Component accessed by summary().

Constructor Summary

AccessConstructor and Description
private
CachedEntry(AiSummary summary, FullBibEntry fullEntry)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public FullBibEntry
fullEntry()

Record Component getter of fullEntry.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public AiSummary
summary()

Record Component getter of summary.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

fullEntryback to summary
private final FullBibEntry fullEntry

Record Component accessed by fullEntry().

summaryback to summary
private final AiSummary summary

Record Component accessed by summary().

Constructor Detail

CachedEntryback to summary
private CachedEntry(AiSummary summary, FullBibEntry fullEntry)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
fullEntryback to summary
public FullBibEntry fullEntry()

Record Component getter of fullEntry.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

summaryback to summary
public AiSummary summary()

Record Component getter of summary.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.