public Class PdfXmpImporter

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

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

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

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

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

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.

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

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

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.