Top Description Fields Constructors Methods
org.jabref.gui.slr

public Class ManageStudyDefinitionViewModel

extends Object
Class Inheritance
Imports
java.io.IOException, java.nio.file.InvalidPathException, .Path, java.util.List, .Objects, .Optional, .Set, java.util.stream.Collectors, javafx.beans.property.Property, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, org.jabref.gui.DialogService, org.jabref.logic.crawler.StudyRepository, .StudyYamlParser, org.jabref.logic.git.GitHandler, org.jabref.logic.importer.ImportFormatPreferences, .ImporterPreferences, .SearchBasedFetcher, .WebFetchers, org.jabref.logic.importer.fetcher.ACMPortalFetcher, .CompositeSearchBasedFetcher, .DBLPFetcher, .IEEE, .SpringerFetcher, org.jabref.logic.l10n.Localization, org.jabref.model.study.Study, .StudyDatabase, .StudyQuery, org.slf4j.Logger, .LoggerFactory
This class provides a model for managing study definitions. To visualize the model one can bind the properties to UI elements.

Field Summary

Modifier and TypeField and Description
private final ObservableList<String>
authors

private final ObservableList<StudyCatalogItem>
databases

private static final Set<String>
DEFAULT_SELECTION

private final DialogService
dialogService

private final SimpleStringProperty
directory

private static final Logger
LOGGER

private final ObservableList<String>
queries

private final ObservableList<String>
researchQuestions

private final StringProperty
title

Constructor Summary

AccessConstructor and Description
public
ManageStudyDefinitionViewModel(ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences, DialogService dialogService)

Constructor for a new study

public
ManageStudyDefinitionViewModel(Study
The study to initialize the UI from
study, Path
The path where the study resides
studyDirectory, ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences, DialogService dialogService)

Constructor for an existing study

Method Summary

Modifier and TypeMethod and Description
public void
addAuthor(String author)

public void
addQuery(String query)

public void
addResearchQuestion(String researchQuestion)

public void
deleteAuthor(String item)

public void
deleteQuery(String item)

public void
deleteQuestion(String item)

public ObservableList<String>
getAuthors()

public ObservableList<StudyCatalogItem>
getCatalogs()

public StringProperty
getDirectory()

public ObservableList<String>
getQueries()

public ObservableList<String>
getResearchQuestions()

public StringProperty
getTitle()

public SlrStudyAndDirectory
saveStudy()

public void
setStudyDirectory(Optional<Path> studyRepositoryRoot)

public Property<String>
titleProperty()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

authorsback to summary
private final ObservableList<String> authors
databasesback to summary
private final ObservableList<StudyCatalogItem> databases
DEFAULT_SELECTIONback to summary
private static final Set<String> DEFAULT_SELECTION
dialogServiceback to summary
private final DialogService dialogService
directoryback to summary
private final SimpleStringProperty directory
LOGGERback to summary
private static final Logger LOGGER
queriesback to summary
private final ObservableList<String> queries
researchQuestionsback to summary
private final ObservableList<String> researchQuestions
titleback to summary
private final StringProperty title

Constructor Detail

ManageStudyDefinitionViewModelback to summary
public ManageStudyDefinitionViewModel(ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences, DialogService dialogService)

Constructor for a new study

ManageStudyDefinitionViewModelback to summary
public ManageStudyDefinitionViewModel(Study study, Path studyDirectory, ImportFormatPreferences importFormatPreferences, ImporterPreferences importerPreferences, DialogService dialogService)

Constructor for an existing study

Parameters
study:Study

The study to initialize the UI from

studyDirectory:Path

The path where the study resides

Method Detail

addAuthorback to summary
public void addAuthor(String author)
addQueryback to summary
public void addQuery(String query)
addResearchQuestionback to summary
public void addResearchQuestion(String researchQuestion)
deleteAuthorback to summary
public void deleteAuthor(String item)
deleteQueryback to summary
public void deleteQuery(String item)
deleteQuestionback to summary
public void deleteQuestion(String item)
getAuthorsback to summary
public ObservableList<String> getAuthors()
getCatalogsback to summary
public ObservableList<StudyCatalogItem> getCatalogs()
getDirectoryback to summary
public StringProperty getDirectory()
getQueriesback to summary
public ObservableList<String> getQueries()
getResearchQuestionsback to summary
public ObservableList<String> getResearchQuestions()
getTitleback to summary
public StringProperty getTitle()
saveStudyback to summary
public SlrStudyAndDirectory saveStudy()
setStudyDirectoryback to summary
public void setStudyDirectory(Optional<Path> studyRepositoryRoot)
titlePropertyback to summary
public Property<String> titleProperty()