Verified Owner
Top Fields Constructors Methods
org.jabref.gui.cleanup

public Class CleanupDialogViewModel

extends AbstractViewModel
Class Inheritance
Imports
java.util.ArrayList, .EnumSet, .List, .Objects, java.util.function.Consumer, .Supplier, java.util.stream.Collectors, javafx.application.Platform, javafx.collections.FXCollections, .ObservableList, org.jabref.gui.AbstractViewModel, .DialogService, .LibraryTab, .StateManager, org.jabref.gui.util.UiTaskExecutor, org.jabref.logic.JabRefException, org.jabref.logic.cleanup.CleanupPreferences, .CleanupTabSelection, .CleanupWorker, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.l10n.Localization, org.jabref.logic.preferences.CliPreferences, org.jabref.logic.undo.UndoManager, org.jabref.logic.util.BackgroundTask, .TaskExecutor, org.jabref.model.FieldChange, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntry, org.jabref.model.undo.CompoundEdit, org.jspecify.annotations.NullMarked, .Nullable

Field Summary

Modifier and TypeField and Description
private final BibDatabaseContext
private final DialogService
private final JournalAbbreviationRepository
private int
private final CliPreferences
private final StateManager
private final @Nullable Supplier<LibraryTab>
private final ObservableList<BibEntry>
private final @Nullable TaskExecutor
private final UndoManager

Constructor Summary

AccessConstructor and Description
public
CleanupDialogViewModel(BibDatabaseContext databaseContext, CliPreferences preferences, DialogService dialogService, StateManager stateManager, UndoManager undoManager, @Nullable Supplier<LibraryTab> tabSupplier, @Nullable TaskExecutor taskExecutor, JournalAbbreviationRepository journalAbbreviationRepository)

Method Summary

Modifier and TypeMethod and Description
public void
public void
apply(CleanupTabSelection selectedTab, boolean showFeedback)

private void
cleanup(CleanupPreferences cleanupPreferences, List<BibEntry> entries)

private void
cleanupWithProgress(CleanupPreferences cleanupPreferences, List<BibEntry> entries, org.jabref.logic.util.BackgroundTask<?> task)

private boolean

Returns:

true iff entry was modified
doCleanup
(CleanupPreferences preset, BibEntry entry, CompoundEdit compoundEdit, List<JabRefException> failures, Consumer<Runnable>
routes BibEntry field mutations to the correct thread
mutationScheduler
)

Runs the cleanup on the entry and records the change.

public void
private void
private void

Field Detail

databaseContextback to summary
private final BibDatabaseContext databaseContext
dialogServiceback to summary
private final DialogService dialogService
journalAbbreviationRepositoryback to summary
private final JournalAbbreviationRepository journalAbbreviationRepository
modifiedEntriesCountback to summary
private int modifiedEntriesCount
preferencesback to summary
private final CliPreferences preferences
stateManagerback to summary
private final StateManager stateManager
tabSupplierback to summary
private final @Nullable Supplier<LibraryTab> tabSupplier
targetEntriesback to summary
private final ObservableList<BibEntry> targetEntries
taskExecutorback to summary
private final @Nullable TaskExecutor taskExecutor
undoManagerback to summary
private final UndoManager undoManager

Constructor Detail

CleanupDialogViewModelback to summary
public CleanupDialogViewModel(BibDatabaseContext databaseContext, CliPreferences preferences, DialogService dialogService, StateManager stateManager, UndoManager undoManager, @Nullable Supplier<LibraryTab> tabSupplier, @Nullable TaskExecutor taskExecutor, JournalAbbreviationRepository journalAbbreviationRepository)
Annotations
@NullMarked

Method Detail

applyback to summary
public void apply(CleanupTabSelection selectedTab)
applyback to summary
public void apply(CleanupTabSelection selectedTab, boolean showFeedback)
cleanupback to summary
private void cleanup(CleanupPreferences cleanupPreferences, List<BibEntry> entries)
cleanupWithProgressback to summary
private void cleanupWithProgress(CleanupPreferences cleanupPreferences, List<BibEntry> entries, org.jabref.logic.util.BackgroundTask<?> task)
doCleanupback to summary
private boolean doCleanup(CleanupPreferences preset, BibEntry entry, CompoundEdit compoundEdit, List<JabRefException> failures, Consumer<Runnable> mutationScheduler)

Runs the cleanup on the entry and records the change.

Parameters
mutationScheduler:Consumer<Runnable>

routes BibEntry field mutations to the correct thread

Returns:boolean

true iff entry was modified

setTargetEntriesback to summary
public void setTargetEntries(List<BibEntry> entries)
showFailuresback to summary
private void showFailures(List<JabRefException> failures)
showResultsback to summary
private void showResults()