Top Description Fields Constructors Methods
org.jabref.logic.importer.fileformat

public Class PdfGrobidImporter

extends Importer
Class Inheritance
Imports
java.io.BufferedReader, .IOException, java.nio.file.Path, java.util.List, .Objects, .Optional, org.jabref.logic.importer.ImportFormatPreferences, .Importer, .ParserResult, org.jabref.logic.importer.util.GrobidService, org.jabref.logic.util.StandardFileType, org.jabref.logic.util.io.FileUtil, org.jabref.model.entry.BibEntry, .LinkedFile
Wraps the GrobidService function to be used as an Importer.

Field Summary

Modifier and TypeField and Description
private final GrobidService
grobidService

private final ImportFormatPreferences
importFormatPreferences

Constructor Summary

AccessConstructor and Description
public
PdfGrobidImporter(ImportFormatPreferences importFormatPreferences)

Method Summary

Modifier and TypeMethod and Description
public String
getDescription()

Implements abstract org.jabref.logic.importer.Importer.getDescription.

Returns the description of the import format.

public StandardFileType
getFileType()

Implements abstract org.jabref.logic.importer.Importer.getFileType.

Returns the type of files that this importer can read

public String
getId()

Overrides org.jabref.logic.importer.Importer.getId.

Returns a one-word ID which identifies this importer.

public String
getName()

Implements abstract org.jabref.logic.importer.Importer.getName.

Returns the name of this import format.

public ParserResult
importDatabase(BufferedReader
the input to read from
reader)

Implements abstract org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the source.

public ParserResult
importDatabase(String
the string which should be imported
data)

Overrides org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the specified string.

public ParserResult
importDatabase(Path
the path to the file which should be imported
filePath)

Overrides org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the specified file.

public boolean
isRecognizedFormat(BufferedReader reader)

Implements abstract org.jabref.logic.importer.Importer.isRecognizedFormat.

Check whether the source is in the correct format for this importer.

public boolean
isRecognizedFormat(Path
the path of the file to check
filePath)

Overrides org.jabref.logic.importer.Importer.isRecognizedFormat.

Returns whether the given stream contains data that is a.) a pdf and b.) contains at least one BibEntry.

Inherited from org.jabref.logic.importer.Importer:
compareToequalsgetCharsetgetReadergetReaderhashCodeisRecognizedFormattoString

Field Detail

grobidServiceback to summary
private final GrobidService grobidService
importFormatPreferencesback to summary
private final ImportFormatPreferences importFormatPreferences

Constructor Detail

PdfGrobidImporterback to summary
public PdfGrobidImporter(ImportFormatPreferences importFormatPreferences)

Method Detail

getDescriptionback to summary
public String getDescription()

Implements abstract org.jabref.logic.importer.Importer.getDescription.

Doc from org.jabref.logic.importer.Importer.getDescription.

Returns the description of the import format.

The description should specify

  • what kind of entries from what sources and based on what specification it is able to import
  • by what criteria it recognizes an import format
Returns:String

description of the import format

Annotations
@Override
getFileTypeback to summary
public StandardFileType getFileType()

Implements abstract org.jabref.logic.importer.Importer.getFileType.

Doc from org.jabref.logic.importer.Importer.getFileType.

Returns the type of files that this importer can read

Returns:StandardFileType

FileType corresponding to the importer

Annotations
@Override
getIdback to summary
public String getId()

Overrides org.jabref.logic.importer.Importer.getId.

Doc from org.jabref.logic.importer.Importer.getId.

Returns a one-word ID which identifies this importer. Used for example, to identify the importer when used from the command line.

Returns:String

ID, must be unique and not null

Annotations
@Override
getNameback to summary
public String getName()

Implements abstract org.jabref.logic.importer.Importer.getName.

Doc from org.jabref.logic.importer.Importer.getName.

Returns the name of this import format.

The name must be unique.

Returns:String

format name, must be unique and not null

Annotations
@Override
importDatabaseback to summary
public ParserResult importDatabase(BufferedReader reader) throws IOException

Implements abstract org.jabref.logic.importer.Importer.importDatabase.

Doc from org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the source.

This method can be called in two different contexts - either when importing in a specified format, or when importing in unknown format. In the latter case, JabRef cycles through all available import formats. No error messages or feedback is displayed from individual import formats in this case.

If importing in a specified format and an empty library is returned, JabRef reports that no entries were found.

This method should never return null.

Parameters
reader:BufferedReader

the input to read from

Annotations
@Override
importDatabaseback to summary
public ParserResult importDatabase(String data) throws IOException

Overrides org.jabref.logic.importer.Importer.importDatabase.

Doc from org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the specified string.

Importer having the facilities to detect the correct encoding of a string should overwrite this method, determine the encoding and then call importDatabase(BufferedReader).

Parameters
data:String

the string which should be imported

Returns:ParserResult

the parsed result

Annotations
@Override
Exceptions
IOException:
Signals that an I/O exception has occurred.
importDatabaseback to summary
public ParserResult importDatabase(Path filePath)

Overrides org.jabref.logic.importer.Importer.importDatabase.

Doc from org.jabref.logic.importer.Importer.importDatabase.

Parse the database in the specified file.

Parameters
filePath:Path

the path to the file which should be imported

Annotations
@Override
isRecognizedFormatback to summary
public boolean isRecognizedFormat(BufferedReader reader) throws IOException

Implements abstract org.jabref.logic.importer.Importer.isRecognizedFormat.

Doc from org.jabref.logic.importer.Importer.isRecognizedFormat.

Check whether the source is in the correct format for this importer.

The effect of this method is primarily to avoid unnecessary processing of files when searching for a suitable import format. If this method returns false, the import routine will move on to the next import format.

Thus, the correct behaviour is to return false if it is certain that the file is not of the suitable type, and true otherwise. Returning true is the safe choice if not certain.

Annotations
@Override
isRecognizedFormatback to summary
public boolean isRecognizedFormat(Path filePath) throws IOException

Overrides org.jabref.logic.importer.Importer.isRecognizedFormat.

Returns whether the given stream contains data that is a.) a pdf and b.) contains at least one BibEntry.

Parameters
filePath:Path

Doc from org.jabref.logic.importer.Importer.isRecognizedFormat.

the path of the file to check

Returns:boolean

Doc from org.jabref.logic.importer.Importer.isRecognizedFormat.

true, if the file is in a recognized format

Annotations
@Override
Exceptions
IOException:

Doc from org.jabref.logic.importer.Importer.isRecognizedFormat.

Signals that an I/O exception has occurred.