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

public abstract Class TrackedBackgroundTask<V>

extends BackgroundTask<V>
Class Inheritance
Known Direct Subclasses
org.jabref.logic.ai.summarization.tasks.GenerateSummaryTask, org.jabref.logic.ai.ingestion.tasks.generateembeddings.GenerateEmbeddingsTask
Imports
javafx.beans.property.ObjectProperty, .ReadOnlyObjectProperty, .SimpleObjectProperty, org.jabref.logic.util.BackgroundTask, .ProgressCounter
An extension to the BackgroundTask that stores the result (or exception) of the task inside.

Useful for the Ai features with task aggregators (org.jabref.logic.ai.ingestion.IngestionTaskAggregator, org.jabref.logic.ai.summarization.SummarizationTaskAggregator), because it allows to use the task object as a temporary storage.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TrackedBackgroundTask.Status

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<Exception>
exception

protected final ProgressCounter
progressCounter

private final ObjectProperty<V>
result

private final ObjectProperty<TrackedBackgroundTask.Status>
status

Constructor Summary

AccessConstructor and Description
public
TrackedBackgroundTask()

Method Summary

Modifier and TypeMethod and Description
public V
call()

Implements abstract org.jabref.logic.util.BackgroundTask.call.

public void
cancel()

Overrides org.jabref.logic.util.BackgroundTask.cancel.

public ReadOnlyObjectProperty<Exception>
exceptionProperty()

public Exception
getException()

public V
getResult()

public TrackedBackgroundTask.Status
getStatus()

protected abstract V
perform()

public ReadOnlyObjectProperty<V>
resultProperty()

public ReadOnlyObjectProperty<TrackedBackgroundTask.Status>
statusProperty()

private void
updateProgress()

Inherited from org.jabref.logic.util.BackgroundTask:
cancelconsumeOnRunningexecuteWithgetOnExceptiongetOnRunninggetOnSuccessgetProgressgetWorkDonePercentageisCancelledisCancelledPropertymayInterruptIfRunningPropertymessagePropertyonFailureonFinishedonRunningonSuccessprogressPropertyscheduleWithsetTitleshowToUsershowToUsershowToUserPropertythenthenRunthenRuntitlePropertyupdateMessageupdateProgressupdateProgresswillBeRecoveredAutomaticallywillBeRecoveredAutomaticallywithInitialMessageworkDonePercentagePropertywrapwrap

Field Detail

exceptionback to summary
private final ObjectProperty<Exception> exception
progressCounterback to summary
protected final ProgressCounter progressCounter
resultback to summary
private final ObjectProperty<V> result
statusback to summary
private final ObjectProperty<TrackedBackgroundTask.Status> status

Constructor Detail

TrackedBackgroundTaskback to summary
public TrackedBackgroundTask()

Method Detail

callback to summary
public V call() throws Exception

Implements abstract org.jabref.logic.util.BackgroundTask.call.

cancelback to summary
public void cancel()

Overrides org.jabref.logic.util.BackgroundTask.cancel.

Annotations
@Override
exceptionPropertyback to summary
public ReadOnlyObjectProperty<Exception> exceptionProperty()
getExceptionback to summary
public Exception getException()
getResultback to summary
public V getResult()
getStatusback to summary
public TrackedBackgroundTask.Status getStatus()
performback to summary
protected abstract V perform() throws Exception
resultPropertyback to summary
public ReadOnlyObjectProperty<V> resultProperty()
statusPropertyback to summary
public ReadOnlyObjectProperty<TrackedBackgroundTask.Status> statusProperty()
updateProgressback to summary
private void updateProgress()
org.jabref.logic.ai.util back to summary

public final Enum TrackedBackgroundTask.Status

extends Enum<TrackedBackgroundTask.Status>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final TrackedBackgroundTask.Status
CANCELLED

public static final TrackedBackgroundTask.Status
ERROR

public static final TrackedBackgroundTask.Status
PENDING

public static final TrackedBackgroundTask.Status
PROCESSING

public static final TrackedBackgroundTask.Status
SUCCESS

Constructor Summary

AccessConstructor and Description
private
Status()

Method Summary

Modifier and TypeMethod and Description
public boolean
isFinished()

public static TrackedBackgroundTask.Status
valueOf(String name)

public static TrackedBackgroundTask.Status[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CANCELLEDback to summary
public static final TrackedBackgroundTask.Status CANCELLED
ERRORback to summary
public static final TrackedBackgroundTask.Status ERROR
PENDINGback to summary
public static final TrackedBackgroundTask.Status PENDING
PROCESSINGback to summary
public static final TrackedBackgroundTask.Status PROCESSING
SUCCESSback to summary
public static final TrackedBackgroundTask.Status SUCCESS

Constructor Detail

Statusback to summary
private Status()

Method Detail

isFinishedback to summary
public boolean isFinished()
valueOfback to summary
public static TrackedBackgroundTask.Status valueOf(String name)
valuesback to summary
public static TrackedBackgroundTask.Status[] values()