JabRef 6.0-beta.1 · org.jabref.gui.frame.JabRefFrameViewModel

Field Summary

Modifier and Type	Field and Description
private final AiService	aiService
private final ClipBoardManager	clipBoardManager
private final DialogService	dialogService
private final BibEntryTypesManager	entryTypesManager
private final FileUpdateMonitor	fileUpdateMonitor
private static final Logger	LOGGER
private final Supplier<OpenDatabaseAction>	openDatabaseAction
private final GuiPreferences	preferences
private final StateManager	stateManager
private final LibraryTabContainer	tabContainer
private final TaskExecutor	taskExecutor

Constructor Summary

Access	Constructor and Description
public	JabRefFrameViewModel(GuiPreferences preferences, AiService aiService, StateManager stateManager, DialogService dialogService, LibraryTabContainer tabContainer, Supplier<OpenDatabaseAction> openDatabaseAction, BibEntryTypesManager entryTypesManager, FileUpdateMonitor fileUpdateMonitor, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addParserResult(ParserResult parserResult)
pack-priv void	addParserResult(ParserResult parserResult, @Nullable String optional group the imported entries are assigned to (e.g. the REST `?group=` parameter). It pre-selects/falls back to that group in the import dialog, which creates it (top-level) on confirm if missing. An explicit pick in the dialog overrides it; cancelling imports nothing. targetGroup)
private void	appendToCurrentLibrary(List<Path> libraries) Supports both BibTeX and non-BibTeX
private void	appendToCurrentLibrary(Reader library) Imports a single library, BibTeX and non-BibTeX Similar code as `org.jabref.gui.importer.actions.ImportCommand`
private void	checkForBibInUpperDir()
public boolean	Returns: true if the user chose to quit; false otherwise close() Quit JabRef
private static SequencedMap<String, DatabaseConnectionProperties>	collectSharedDatabases(List<LibraryTab> tabs) Shared databases that are backed by a local file are reopened through that file (it carries the shared database id).
private void	directImportEntries(ParserResult parserResult, @Nullable String targetGroup)
private Optional<Path>	firstBibFile() Use case: User starts `JabRef.bat` or `JabRef.exe`.
public void	handleUiCommands(List<UiCommand> to be handled uiCommands) Handles commands submitted by the command line or by the remote host to be executed in the ui Needs to run in a certain order.
private void	importBibtexStringAndOpen(String importStr, @Nullable String targetGroup) Deprecated used by the browser extension only
private void	importFromFileAndOpen(String location) Deprecated used by the browser extension only
private ImportHandler	newImportHandler(BibDatabaseContext databaseContext)
private ParserResult	parseBibtexEntries(String importStr)
private void	selectEntries(List<String> entryKeys)
private void	selectLibraryTab(Optional<Path> library) Selects the tab whose library lives at `library` so that the subsequent append targets it instead of the previously active tab.
pack-priv void	storeLastOpenedFiles(List<Path> filenames, Path focusedDatabase, List<String> sharedDatabaseIds)
private void	waitForLoadingFinished(Runnable runnable)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

aiService	back to summary
private final AiService aiService

clipBoardManager	back to summary
private final ClipBoardManager clipBoardManager

dialogService	back to summary
private final DialogService dialogService

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

fileUpdateMonitor	back to summary
private final FileUpdateMonitor fileUpdateMonitor

LOGGER	back to summary
private static final Logger LOGGER

openDatabaseAction	back to summary
private final Supplier<OpenDatabaseAction> openDatabaseAction

preferences	back to summary
private final GuiPreferences preferences

stateManager	back to summary
private final StateManager stateManager

tabContainer	back to summary
private final LibraryTabContainer tabContainer

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

JabRefFrameViewModel	back to summary
public JabRefFrameViewModel(GuiPreferences preferences, AiService aiService, StateManager stateManager, DialogService dialogService, LibraryTabContainer tabContainer, Supplier<OpenDatabaseAction> openDatabaseAction, BibEntryTypesManager entryTypesManager, FileUpdateMonitor fileUpdateMonitor, ClipBoardManager clipBoardManager, TaskExecutor taskExecutor)

Method Detail

addParserResult	back to summary
pack-priv void addParserResult(ParserResult parserResult) Annotations @VisibleForTesting

addParserResult back to summary

addParserResult	back to summary
pack-priv void addParserResult(ParserResult parserResult, @Nullable String targetGroup) Parameters targetGroup:@Nullable String optional group the imported entries are assigned to (e.g. the REST `?group=` parameter). It pre-selects/falls back to that group in the import dialog, which creates it (top-level) on confirm if missing. An explicit pick in the dialog overrides it; cancelling imports nothing.

pack-priv void addParserResult(ParserResult parserResult, @Nullable String targetGroup)

Parameters

targetGroup:@Nullable String: optional group the imported entries are assigned to (e.g. the REST ?group= parameter). It pre-selects/falls back to that group in the import dialog, which creates it (top-level) on confirm if missing. An explicit pick in the dialog overrides it; cancelling imports nothing.

appendToCurrentLibrary	back to summary
private void appendToCurrentLibrary(List<Path> libraries) Supports both BibTeX and non-BibTeX

appendToCurrentLibrary back to summary

appendToCurrentLibrary	back to summary
private void appendToCurrentLibrary(Reader library) Imports a single library, BibTeX and non-BibTeX Similar code as `org.jabref.gui.importer.actions.ImportCommand`

private void appendToCurrentLibrary(Reader library)

Imports a single library, BibTeX and non-BibTeX

checkForBibInUpperDir	back to summary
private void checkForBibInUpperDir()

close	back to summary
public boolean close() Quit JabRef Returns:boolean true if the user chose to quit; false otherwise

back to summary

public boolean close()

Quit JabRef

Returns:boolean: true if the user chose to quit; false otherwise

collectSharedDatabases	back to summary
private static SequencedMap<String, DatabaseConnectionProperties> collectSharedDatabases(List<LibraryTab> tabs) Shared databases that are backed by a local file are reopened through that file (it carries the shared database id). The others only live in the connection, so their connection properties are collected here, keyed by a generated id. Nothing is written yet: the user may still cancel the quit, and a credential must not land in the keyring for a database that then stays open.

collectSharedDatabases

back to summary

private static SequencedMap<String, DatabaseConnectionProperties> collectSharedDatabases(List<LibraryTab> tabs)

Shared databases that are backed by a local file are reopened through that file (it carries the shared database id). The others only live in the connection, so their connection properties are collected here, keyed by a generated id. Nothing is written yet: the user may still cancel the quit, and a credential must not land in the keyring for a database that then stays open.

directImportEntries	back to summary
private void directImportEntries(ParserResult parserResult, @Nullable String targetGroup)

firstBibFile back to summary

firstBibFile	back to summary
private Optional<Path> firstBibFile() Use case: User starts `JabRef.bat` or `JabRef.exe`. JabRef should open a "close by" bib file. By "close by" a `.bib` file in the current folder or one level up of `JabRef.exe`is meant. Paths: `...\{example-dir}\JabRef\JabRef.exe` (Windows) `.../{example-dir}/JabRef/bin/JabRef` (Linux) `...\{example-dir}\JabRef\runtime\bin\JabRef.bat` (Windows) In the example, `...\{example-dir}\example.bib` should be found. We do NOT go up another level (i.e., everything in `...` is not found)

private Optional<Path> firstBibFile()

Use case: User starts JabRef.bat or JabRef.exe. JabRef should open a "close by" bib file. By "close by" a .bib file in the current folder or one level up of JabRef.exeis meant.

Paths:

...\{example-dir}\JabRef\JabRef.exe (Windows)
.../{example-dir}/JabRef/bin/JabRef (Linux)
...\{example-dir}\JabRef\runtime\bin\JabRef.bat (Windows)

In the example, ...\{example-dir}\example.bib should be found.

We do NOT go up another level (i.e., everything in ... is not found)

handleUiCommands	back to summary
public void handleUiCommands(List<UiCommand> uiCommands) Handles commands submitted by the command line or by the remote host to be executed in the ui Needs to run in a certain order. E.g. databases have to be loaded before selecting an entry. Does NOT handle focus - this is done in JabRefFrame Parameters uiCommands:List<UiCommand> to be handled

handleUiCommands

back to summary

public void handleUiCommands(List<UiCommand> uiCommands)

Handles commands submitted by the command line or by the remote host to be executed in the ui Needs to run in a certain order. E.g. databases have to be loaded before selecting an entry.

Does NOT handle focus - this is done in JabRefFrame

Parameters

uiCommands:List<UiCommand>: to be handled

importBibtexStringAndOpen	back to summary
private void importBibtexStringAndOpen(String importStr, @Nullable String targetGroup) Deprecated used by the browser extension only

importFromFileAndOpen	back to summary
private void importFromFileAndOpen(String location) Deprecated used by the browser extension only

newImportHandler	back to summary
private ImportHandler newImportHandler(BibDatabaseContext databaseContext)

parseBibtexEntries	back to summary
private ParserResult parseBibtexEntries(String importStr) throws org.jabref.logic.importer.ParseException

selectEntries	back to summary
private void selectEntries(List<String> entryKeys) Annotations @NullMarked

selectLibraryTab back to summary

selectLibraryTab	back to summary
private void selectLibraryTab(Optional<Path> library) Selects the tab whose library lives at `library` so that the subsequent append targets it instead of the previously active tab. An empty Optional leaves the current tab unchanged. If the library is not open yet, it is opened in a new (raised) tab; the actual loading happens in the background, so callers must run the append via `waitForLoadingFinished(Runnable)` to let the new tab finish loading first. A path that does not exist (or is not a .bib file) is silently ignored by `OpenDatabaseAction#openFile(Path)` and the current tab is kept (the server side already rejects unknown ids with 404, so this is only a defensive fallback).

private void selectLibraryTab(Optional<Path> library)

Selects the tab whose library lives at library so that the subsequent append targets it instead of the previously active tab. An empty Optional leaves the current tab unchanged. If the library is not open yet, it is opened in a new (raised) tab; the actual loading happens in the background, so callers must run the append via waitForLoadingFinished(Runnable) to let the new tab finish loading first. A path that does not exist (or is not a .bib file) is silently ignored by OpenDatabaseAction#openFile(Path) and the current tab is kept (the server side already rejects unknown ids with 404, so this is only a defensive fallback).

storeLastOpenedFiles	back to summary
pack-priv void storeLastOpenedFiles(List<Path> filenames, Path focusedDatabase, List<String> sharedDatabaseIds)

waitForLoadingFinished	back to summary
private void waitForLoadingFinished(Runnable runnable)

public Class JabRefFrameViewModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail