JabRef 5.15 · org.jabref.logic.exporter.Exporter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final String	displayName
private final FileType	fileType
private final String	id

Access	Constructor and Description
public	Exporter(String id, String displayName, FileType extension)

Method Summary

Modifier and Type	Method and Description
public abstract void	export(BibDatabaseContext the database to export from databaseContext, Path the file to write to file, List<BibEntry> a list containing all entries that should be exported entries) Performs the export.
public void	export(BibDatabaseContext databaseContext, Path file, List<BibEntry> entries, List<Path> fileDirForDatabase, JournalAbbreviationRepository abbreviationRepository)
public boolean	Returns: whether any file was written on exportToAllFilesOfEntry(BibDatabaseContext the database to export from databaseContext, FilePreferences the filePreferences to use for resolving paths filePreferences, BibEntry the entry for which we want to write on all linked pdfs entryToWriteOn, List<BibEntry> the content that we want to export to the pdfs entriesToWrite, JournalAbbreviationRepository the opened repository of journal abbreviations abbreviationRepository) Exports to all files linked to a given entry
public boolean	Returns: whether the file was written on at least once exportToFileByPath(BibDatabaseContext the database-context to export from databaseContext, FilePreferences the filePreferences to use for resolving paths filePreferences, Path the path to the file we want to write on filePath, JournalAbbreviationRepository the opened repository of journal abbreviations abbreviationRepository) Exports bib-entries a file is linked to Behaviour in case the file is linked to different bib-entries depends on the implementation of `export`.
public FileType	getFileType() Returns the type of files this exporter creates.
public String	getId() Returns a one-word ID (used, for example, to identify the exporter in the console).
public String	getName() Returns the name of the exporter (to display to the user).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

displayName	back to summary
private final String displayName

fileType	back to summary
private final FileType fileType

id	back to summary
private final String id

Exporter	back to summary
public Exporter(String id, String displayName, FileType extension)

Method Detail

export	back to summary
public abstract void export(BibDatabaseContext databaseContext, Path file, List<BibEntry> entries) throws Exception Performs the export. Parameters databaseContext:BibDatabaseContext the database to export from file:Path the file to write to entries:List<BibEntry> a list containing all entries that should be exported

export

back to summary

public abstract void export(BibDatabaseContext databaseContext, Path file, List<BibEntry> entries) throws Exception

Performs the export.

Parameters

databaseContext:BibDatabaseContext: the database to export from
file:Path: the file to write to
entries:List<BibEntry>: a list containing all entries that should be exported

export	back to summary
public void export(BibDatabaseContext databaseContext, Path file, List<BibEntry> entries, List<Path> fileDirForDatabase, JournalAbbreviationRepository abbreviationRepository) throws Exception

exportToAllFilesOfEntry	back to summary
public boolean exportToAllFilesOfEntry(BibDatabaseContext databaseContext, FilePreferences filePreferences, BibEntry entryToWriteOn, List<BibEntry> entriesToWrite, JournalAbbreviationRepository abbreviationRepository) throws Exception Exports to all files linked to a given entry Parameters databaseContext:BibDatabaseContext the database to export from filePreferences:FilePreferences the filePreferences to use for resolving paths entryToWriteOn:BibEntry the entry for which we want to write on all linked pdfs entriesToWrite:List<BibEntry> the content that we want to export to the pdfs abbreviationRepository:JournalAbbreviationRepository the opened repository of journal abbreviations Returns:boolean whether any file was written on Exceptions Exception: if the writing fails

exportToAllFilesOfEntry

back to summary

public boolean exportToAllFilesOfEntry(BibDatabaseContext databaseContext, FilePreferences filePreferences, BibEntry entryToWriteOn, List<BibEntry> entriesToWrite, JournalAbbreviationRepository abbreviationRepository) throws Exception

Exports to all files linked to a given entry

Parameters

databaseContext:BibDatabaseContext: the database to export from
filePreferences:FilePreferences: the filePreferences to use for resolving paths
entryToWriteOn:BibEntry: the entry for which we want to write on all linked pdfs
entriesToWrite:List<BibEntry>: the content that we want to export to the pdfs
abbreviationRepository:JournalAbbreviationRepository: the opened repository of journal abbreviations

Returns:boolean

whether any file was written on

Exceptions

Exception:: if the writing fails

exportToFileByPath back to summary

exportToFileByPath	back to summary
public boolean exportToFileByPath(BibDatabaseContext databaseContext, FilePreferences filePreferences, Path filePath, JournalAbbreviationRepository abbreviationRepository) throws Exception Exports bib-entries a file is linked to Behaviour in case the file is linked to different bib-entries depends on the implementation of `export`. If it overwrites any existing information, only the last found bib-entry will be exported (as the previous exports are overwritten). If it extends existing information, all found bib-entries will be exported. Parameters databaseContext:BibDatabaseContext the database-context to export from filePreferences:FilePreferences the filePreferences to use for resolving paths filePath:Path the path to the file we want to write on abbreviationRepository:JournalAbbreviationRepository the opened repository of journal abbreviations Returns:boolean whether the file was written on at least once Exceptions Exception: if the writing fails

public boolean exportToFileByPath(BibDatabaseContext databaseContext, FilePreferences filePreferences, Path filePath, JournalAbbreviationRepository abbreviationRepository) throws Exception

Exports bib-entries a file is linked to Behaviour in case the file is linked to different bib-entries depends on the implementation of export. If it overwrites any existing information, only the last found bib-entry will be exported (as the previous exports are overwritten). If it extends existing information, all found bib-entries will be exported.

Parameters

databaseContext:BibDatabaseContext: the database-context to export from
filePreferences:FilePreferences: the filePreferences to use for resolving paths
filePath:Path: the path to the file we want to write on
abbreviationRepository:JournalAbbreviationRepository: the opened repository of journal abbreviations

Returns:boolean

whether the file was written on at least once

Exceptions

Exception:: if the writing fails

getFileType	back to summary
public FileType getFileType() Returns the type of files this exporter creates.

getId	back to summary
public String getId() Returns a one-word ID (used, for example, to identify the exporter in the console).

getName	back to summary
public String getName() Returns the name of the exporter (to display to the user).

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class Exporter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail