Verified Owner
Top Inners Fields Constructors Methods
org.jabref.gui.ai.summary

public Class AiSummaryViewModel

extends AbstractViewModel
Class Inheritance
Imports
java.nio.file.Path, java.util.List, .Map, .Optional, java.util.function.Function, javafx.beans.property.ObjectProperty, .ReadOnlyObjectProperty, .SimpleObjectProperty, javafx.beans.value.ChangeListener, org.jabref.gui.AbstractViewModel, .DialogService, org.jabref.gui.util.BindingsHelper, .UiTaskExecutor, org.jabref.logic.FilePreferences, org.jabref.logic.ai.chatting.ChatModel, org.jabref.logic.ai.chatting.util.ChatModelFactory, org.jabref.logic.ai.ingestion.logic.parsing.UniversalContentParser, org.jabref.logic.ai.preferences.AiPreferences, org.jabref.logic.ai.summarization.InMemorySummaryCache, .SummarizationTaskAggregator, org.jabref.logic.ai.summarization.logic.summarizationalgorithms.Summarizator, org.jabref.logic.ai.summarization.repositories.SummariesRepository, org.jabref.logic.ai.summarization.tasks.GenerateSummaryTask, .GenerateSummaryTaskRequest, org.jabref.logic.ai.summarization.util.SummarizatorFactory, org.jabref.logic.ai.util.TrackedBackgroundTask, org.jabref.logic.util.ObservablesHelper, org.jabref.model.ai.identifiers.FullBibEntry, org.jabref.model.ai.summarization.AiSummary, org.jabref.model.entry.BibEntry, com.tobiasdiez.easybind.EasyBind, org.jspecify.annotations.Nullable

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
AiSummaryViewModel.State

Field Summary

Modifier and TypeField and Description
private final AiPreferences
aiPreferences

private final ObjectProperty<ChatModel>
chatModel

private final ObjectProperty<GenerateSummaryTask>
currentTask

private final DialogService
dialogService

private final ObjectProperty<FullBibEntry>
entry

private final ObjectProperty<Exception>
error

private final FilePreferences
filePreferences

private final InMemorySummaryCache
inMemoryCache

private final ObjectProperty<AiSummaryViewModel.State>
state

private final SummariesRepository
summariesRepository

private final SummarizationTaskAggregator
summarizationTaskAggregator

private final ObjectProperty<Summarizator>
summarizator

private final ObjectProperty<AiSummary>
summary

private final ChangeListener<Status>
taskStateListener

Constructor Summary

AccessConstructor and Description
public
AiSummaryViewModel(AiPreferences aiPreferences, FilePreferences filePreferences, SummariesRepository summariesRepository, InMemorySummaryCache inMemoryCache, SummarizationTaskAggregator summarizationTaskAggregator, DialogService dialogService)

Method Summary

Modifier and TypeMethod and Description
public void
cancel()

public ObjectProperty<ChatModel>
chatModelProperty()

public void
clearSummary(FullBibEntry fullEntry)

private void
clearTask()

public ObjectProperty<FullBibEntry>
entryProperty()

public ObjectProperty<Exception>
errorProperty()

public void
generate()

private void
generate(FullBibEntry identifier)

public FullBibEntry
getEntry()

private void
prepareForEntry()

private void
processEntry(FullBibEntry fullEntry)

public void
regenerate()

private void
regenerate(FullBibEntry identifier)

public void
regenerateCustom()

private void
regenerateCustom(FullBibEntry identifier)

private void
setDefaultModels()

Resets the chat model and summarizator to the default values from AI preferences.

public void
setEntry(FullBibEntry entry)

private void
setupBindings()

private void
setupListeners()

private void
setupSummarizatorBinding()

private void
startSummarization(FullBibEntry fullEntry)

public ObjectProperty<AiSummaryViewModel.State>
stateProperty()

public ObjectProperty<Summarizator>
summarizatorProperty()

public ObjectProperty<AiSummary>
summaryProperty()

private void
updateByTaskState(Status value)

Field Detail

aiPreferencesback to summary
private final AiPreferences aiPreferences
chatModelback to summary
private final ObjectProperty<ChatModel> chatModel
currentTaskback to summary
private final ObjectProperty<GenerateSummaryTask> currentTask
dialogServiceback to summary
private final DialogService dialogService
entryback to summary
private final ObjectProperty<FullBibEntry> entry
errorback to summary
private final ObjectProperty<Exception> error
filePreferencesback to summary
private final FilePreferences filePreferences
inMemoryCacheback to summary
private final InMemorySummaryCache inMemoryCache
stateback to summary
private final ObjectProperty<AiSummaryViewModel.State> state
summariesRepositoryback to summary
private final SummariesRepository summariesRepository
summarizationTaskAggregatorback to summary
private final SummarizationTaskAggregator summarizationTaskAggregator
summarizatorback to summary
private final ObjectProperty<Summarizator> summarizator
summaryback to summary
private final ObjectProperty<AiSummary> summary
taskStateListenerback to summary
private final ChangeListener<Status> taskStateListener

Constructor Detail

AiSummaryViewModelback to summary
public AiSummaryViewModel(AiPreferences aiPreferences, FilePreferences filePreferences, SummariesRepository summariesRepository, InMemorySummaryCache inMemoryCache, SummarizationTaskAggregator summarizationTaskAggregator, DialogService dialogService)

Method Detail

cancelback to summary
public void cancel()
chatModelPropertyback to summary
public ObjectProperty<ChatModel> chatModelProperty()
clearSummaryback to summary
public void clearSummary(FullBibEntry fullEntry)
clearTaskback to summary
private void clearTask()
entryPropertyback to summary
public ObjectProperty<FullBibEntry> entryProperty()
errorPropertyback to summary
public ObjectProperty<Exception> errorProperty()
generateback to summary
public void generate()
generateback to summary
private void generate(FullBibEntry identifier)
getEntryback to summary
public FullBibEntry getEntry()
prepareForEntryback to summary
private void prepareForEntry()
processEntryback to summary
private void processEntry(FullBibEntry fullEntry)
regenerateback to summary
public void regenerate()
regenerateback to summary
private void regenerate(FullBibEntry identifier)
regenerateCustomback to summary
public void regenerateCustom()
regenerateCustomback to summary
private void regenerateCustom(FullBibEntry identifier)
setDefaultModelsback to summary
private void setDefaultModels()

Resets the chat model and summarizator to the default values from AI preferences. Called before generating a summary to ensure default models are used (as opposed to a custom summarizator set by regenerateCustom()).

setEntryback to summary
public void setEntry(FullBibEntry entry)
setupBindingsback to summary
private void setupBindings()
setupListenersback to summary
private void setupListeners()
setupSummarizatorBindingback to summary
private void setupSummarizatorBinding()
startSummarizationback to summary
private void startSummarization(FullBibEntry fullEntry)
statePropertyback to summary
public ObjectProperty<AiSummaryViewModel.State> stateProperty()
summarizatorPropertyback to summary
public ObjectProperty<Summarizator> summarizatorProperty()
summaryPropertyback to summary
public ObjectProperty<AiSummary> summaryProperty()
updateByTaskStateback to summary
private void updateByTaskState(Status value)
org.jabref.gui.ai.summary back to summary

public final Enum AiSummaryViewModel.State

extends Enum<AiSummaryViewModel.State>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final AiSummaryViewModel.State
AI_TURNED_OFF

public static final AiSummaryViewModel.State
CANCELLED

public static final AiSummaryViewModel.State
DONE

public static final AiSummaryViewModel.State
ERROR_WHILE_GENERATING

public static final AiSummaryViewModel.State
NO_FILES

public static final AiSummaryViewModel.State
NO_SUPPORTED_FILE_TYPES

public static final AiSummaryViewModel.State
PROCESSING

public static final AiSummaryViewModel.State
READY

public static final AiSummaryViewModel.State
RESTART_NEEDED

Constructor Summary

AccessConstructor and Description
private
State()

Method Summary

Modifier and TypeMethod and Description
public static AiSummaryViewModel.State
valueOf(String name)

public static AiSummaryViewModel.State[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AI_TURNED_OFFback to summary
public static final AiSummaryViewModel.State AI_TURNED_OFF
CANCELLEDback to summary
public static final AiSummaryViewModel.State CANCELLED
DONEback to summary
public static final AiSummaryViewModel.State DONE
ERROR_WHILE_GENERATINGback to summary
public static final AiSummaryViewModel.State ERROR_WHILE_GENERATING
NO_FILESback to summary
public static final AiSummaryViewModel.State NO_FILES
NO_SUPPORTED_FILE_TYPESback to summary
public static final AiSummaryViewModel.State NO_SUPPORTED_FILE_TYPES
PROCESSINGback to summary
public static final AiSummaryViewModel.State PROCESSING
READYback to summary
public static final AiSummaryViewModel.State READY
RESTART_NEEDEDback to summary
public static final AiSummaryViewModel.State RESTART_NEEDED

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static AiSummaryViewModel.State valueOf(String name)
valuesback to summary
public static AiSummaryViewModel.State[] values()