Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.crawler

public Class Crawler

extends Object
Class Inheritance
Imports
java.io.IOException, java.nio.file.Path, java.util.List, org.jabref.logic.JabRefException, org.jabref.logic.exporter.SaveException, org.jabref.logic.git.SlrGitHandler, org.jabref.logic.importer.ParseException, org.jabref.logic.preferences.CliPreferences, org.jabref.model.entry.BibEntryTypesManager, org.jabref.model.study.QueryResult, org.jabref.model.util.FileUpdateMonitor, org.eclipse.jgit.api.errors.GitAPIException
This class provides a service for SLR support by conducting an automated search and persistance of studies using the queries and E-Libraries specified in the provided study definition file.

It composes a StudyRepository for repository management, and a StudyFetcher that manages the crawling over the selected E-Libraries.

Field Summary

Modifier and TypeField and Description
public static final String
FILENAME_STUDY_RESULT_BIB

private final StudyFetcher
studyFetcher

private final StudyRepository
studyRepository

Constructor Summary

AccessConstructor and Description
public
Crawler(Path
The path to the study repository
studyRepositoryRoot, SlrGitHandler gitHandler, CliPreferences preferences, BibEntryTypesManager bibEntryTypesManager, FileUpdateMonitor fileUpdateMonitor)

Creates a crawler for retrieving studies from E-Libraries

Method Summary

Modifier and TypeMethod and Description
public void
performCrawl()

This methods performs the crawling of the active libraries defined in the study definition file.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FILENAME_STUDY_RESULT_BIBback to summary
public static final String FILENAME_STUDY_RESULT_BIB
studyFetcherback to summary
private final StudyFetcher studyFetcher
studyRepositoryback to summary
private final StudyRepository studyRepository

Constructor Detail

Crawlerback to summary
public Crawler(Path studyRepositoryRoot, SlrGitHandler gitHandler, CliPreferences preferences, BibEntryTypesManager bibEntryTypesManager, FileUpdateMonitor fileUpdateMonitor) throws IllegalArgumentException, IOException, ParseException, JabRefException

Creates a crawler for retrieving studies from E-Libraries

Parameters
studyRepositoryRoot:Path

The path to the study repository

Method Detail

performCrawlback to summary
public void performCrawl() throws IOException, GitAPIException, SaveException, JabRefException

This methods performs the crawling of the active libraries defined in the study definition file. This method also persists the results in the same folder the study definition file is stored in.

The whole process works as follows:

  1. Then the search is executed
  2. The repository changes to the search branch
  3. Afterwards, the results are persisted on the search branch.
  4. Finally, the changes are merged into the work branch
Exceptions
IOException:
Thrown if a problem occurred during the persistence of the result.