Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.importer.fileformat.pdf

public Class PdfXmpImporter

extends PdfImporter
Class Inheritance
Imports
java.io.IOException, java.nio.file.Path, org.jabref.logic.importer.ParserResult, org.jabref.logic.l10n.Localization, org.jabref.logic.xmp.XmpPreferences, .XmpUtilReader, org.apache.pdfbox.pdmodel.PDDocument
Wraps the XMPUtility function to be used as an Importer.

Field Summary

Modifier and TypeField and Description
private final XmpPreferences
xmpPreferences

private final XmpUtilReader
xmpUtilReader

Constructor Summary

AccessConstructor and Description
public
PdfXmpImporter(XmpPreferences xmpPreferences)

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 String
getId()

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

Returns a slug, 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(Path filePath, PDDocument document)

Implements abstract org.jabref.logic.importer.fileformat.pdf.PdfImporter.importDatabase.

Note

The "throws" clause is for "developer convenience" - it is turned into a ParserResult at importDatabase(Path).

Inherited from org.jabref.logic.importer.fileformat.pdf.PdfImporter:
getFileTypeimportDatabaseimportDatabaseimportDatabaseisRecognizedFormatisRecognizedFormat

Field Detail

xmpPreferencesback to summary
private final XmpPreferences xmpPreferences
xmpUtilReaderback to summary
private final XmpUtilReader xmpUtilReader

Constructor Detail

PdfXmpImporterback to summary
public PdfXmpImporter(XmpPreferences xmpPreferences)

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 isRecognizedFormat(BufferedReader) recognizes an import format

Annotations
@Override
getIdback to summary
public String getId()

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

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

Returns a slug, which identifies this importer. Used, for example, to identify the importer in CLI.

Typically, this name should be short, in English, and should not contain special characters like #, %, etc.

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. Typically, this is a string that denotes file type or format. It can also be localized, like "XMP-annotated PDF".

Annotations
@Override
importDatabaseback to summary
public ParserResult importDatabase(Path filePath, PDDocument document) throws IOException

Implements abstract org.jabref.logic.importer.fileformat.pdf.PdfImporter.importDatabase.

Doc from org.jabref.logic.importer.fileformat.pdf.PdfImporter.importDatabase.

Note

The "throws" clause is for "developer convenience" - it is turned into a ParserResult at importDatabase(Path).

Annotations
@Override