JabRef 6.0-beta.1 · org.jabref.logic.importer.fileformat.MsBibImporter

Modifier and Type	Field and Description
private static final String	DISABLEDTD
private static final String	DISABLEEXTERNALDTD
private static final DocumentBuilderFactory	DOCUMENT_BUILDER_FACTORY
private static final Logger	LOGGER Hides org.jabref.logic.importer.Importer.LOGGER.

Access	Constructor and Description
public	MsBibImporter()

Method Summary

Modifier and Type	Method 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() 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(@NonNull BufferedReader reader) Implements abstract org.jabref.logic.importer.Importer.importDatabase. Parse the database in the source.
public boolean	isRecognizedFormat(Reader reader) Overrides org.jabref.logic.importer.Importer.isRecognizedFormat. The correct behavior is to return false if it is certain that the file is not of the MsBib type, and true otherwise.
private static DocumentBuilderFactory	Returns: If supported, XXE safe DocumentBuilderFactory. Else, returns original builder given makeSafeDocBuilderFactory(DocumentBuilderFactory \| DocumentBuilderFactory to be made XXE safe. dBuild) DocumentBuilderFactory makes a XXE safe Builder factory from dBuild.

Inherited from org.jabref.logic.importer.Importer:: compareTo equals getCharset getReader getReader hashCode importDatabase importDatabase isRecognizedFormat isRecognizedFormat isRecognizedFormat supportsFileExtension toString

DISABLEDTD	back to summary
private static final String DISABLEDTD

DISABLEEXTERNALDTD	back to summary
private static final String DISABLEEXTERNALDTD

DOCUMENT_BUILDER_FACTORY	back to summary
private static final DocumentBuilderFactory DOCUMENT_BUILDER_FACTORY

LOGGER	back to summary
private static final Logger LOGGER Hides org.jabref.logic.importer.Importer.LOGGER.

MsBibImporter	back to summary
public MsBibImporter()

Method Detail

getDescription back to summary

getDescription	back 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

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

getFileType	back 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 Annotations @Override

getFileType

back 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

Annotations

@Override

getId	back 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

getId

back 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

getName	back 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

getName

back 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

importDatabase back to summary

importDatabase	back to summary
public ParserResult importDatabase(@NonNull 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. If your format is binary-based (PDF, ZIP-based, or others), then you should not solely override this method. For binary formats do this: Throw `UnsupportedOperationException` in this method. Override the method `Importer#importDatabase(Path)`. Example of this workaround is in: `org.jabref.logic.importer.fileformat.pdf.PdfImporter`. Annotations @Override

public ParserResult importDatabase(@NonNull 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.

If your format is binary-based (PDF, ZIP-based, or others), then you should not solely override this method. For binary formats do this:

Throw UnsupportedOperationException in this method.
Override the method Importer#importDatabase(Path). Example of this workaround is in: org.jabref.logic.importer.fileformat.pdf.PdfImporter.

Annotations

@Override

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(Reader reader) throws IOException Overrides org.jabref.logic.importer.Importer.isRecognizedFormat. The correct behavior is to return false if it is certain that the file is not of the MsBib type, and true otherwise. Returning true is the safe choice if not certain. Annotations @Override

isRecognizedFormat

back to summary

public boolean isRecognizedFormat(Reader reader) throws IOException

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

The correct behavior is to return false if it is certain that the file is not of the MsBib type, and true otherwise. Returning true is the safe choice if not certain.

Annotations

@Override

makeSafeDocBuilderFactory	back to summary
private static DocumentBuilderFactory makeSafeDocBuilderFactory(DocumentBuilderFactory dBuild) DocumentBuilderFactory makes a XXE safe Builder factory from dBuild. If not supported by current XML then returns original builder given and logs error. Parameters dBuild:DocumentBuilderFactory \| DocumentBuilderFactory to be made XXE safe. Returns:DocumentBuilderFactory If supported, XXE safe DocumentBuilderFactory. Else, returns original builder given

makeSafeDocBuilderFactory

back to summary

private static DocumentBuilderFactory makeSafeDocBuilderFactory(DocumentBuilderFactory dBuild)

DocumentBuilderFactory makes a XXE safe Builder factory from dBuild. If not supported by current XML then returns original builder given and logs error.

Parameters

dBuild:DocumentBuilderFactory: | DocumentBuilderFactory to be made XXE safe.

Returns:DocumentBuilderFactory

If supported, XXE safe DocumentBuilderFactory. Else, returns original builder given

public Class MsBibImporter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

The description should specify

what kind of entries from what sources and based on what specification it is able to import