Top Fields Constructors Methods

org.jabref.toolkit.service

public Class ExportService

Class Inheritance

extends Object

java.lang.Object
org.jabref.toolkit.service.ExportService

Annotations

@NullMarked

Imports

java.io.IOException, .OutputStreamWriter, java.nio.charset.StandardCharsets, java.nio.file.Files, .Path, java.util.List, .Optional, java.util.stream.Stream, javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException, javafx.util.Pair, org.jabref.logic.citationkeypattern.CitationKeyGenerator, .CitationKeyPatternPreferences, org.jabref.logic.exporter.AtomicFileWriter, .BibDatabaseWriter, .BibWriter, .Exporter, .ExporterFactory, .SaveException, .SelfContainedSaveConfiguration, org.jabref.logic.importer.ParserResult, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.l10n.Localization, org.jabref.logic.os.OS, org.jabref.logic.preferences.CliPreferences, org.jabref.logic.util.StandardFileType, org.jabref.logic.util.io.FileUtil, org.jabref.model.database.BibDatabase, .BibDatabaseContext, org.jabref.model.entry.BibEntry, .BibEntryTypesManager, org.jabref.toolkit.exception.ExportServiceException, com.airhacks.afterburner.injection.Injector, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory, picocli.CommandLine

Field Summary

Modifier and Type	Field and Description
private final Exporter	bibtexExporter
private final CliPreferences	cliPreferences
private final BibEntryTypesManager	entryTypesManager
private final ExporterFactory	exporterFactory
private static final Logger	LOGGER
private final boolean	porcelain

Constructor Summary

Access	Constructor and Description
public	ExportService(CliPreferences cliPreferences, boolean porcelain)

Method Summary

Modifier and Type	Method and Description
public static ExportService	create(CliPreferences cliPreferences, boolean porcelain)
private Exporter	createBibtexExporter()
public void	exportBibDatabaseContextToFile(BibDatabaseContext databaseContext, List<BibEntry> matches, Path outputFile, String outputFormat)
public void	exportEntriesToFile(List<BibEntry> entries, Path outputFile, String outputFormat)
public void	exportParserResultToFile(ParserResult parserResult, Path outputFile, String format)
public void	exportParserResultToStdOut(ParserResult parserResult, String format)
private static void	generateCitationKeys(BibDatabaseContext databaseContext, CitationKeyPatternPreferences citationKeyPatternPreferences) Generates a citation key if there is no key existing
public List<Pair<String, String>>	getAvailableExportFormats()
private Exporter	getExporterByName(String exporterId)
private void	internalSaveDatabaseContext(BibDatabaseContext bibDatabaseContext, Path outputFile)
public void	printBibEntriesToStdOut(List<BibEntry> entries)
public void	printDatabaseContextToStdOut(BibDatabaseContext bibDatabaseContext)
private void	printErr(String s)
private void	printOut(String s)
public void	saveBibEntries(List<BibEntry> matches, Path outputFile)
public void	saveDatabase(BibDatabase newBase, Path outputFile)
public void	saveDatabaseContext(BibDatabaseContext bibDatabaseContext, Path outputFile)
private void	tryExportWithExporter(Exporter exporter, Path outputFile, BibDatabaseContext databaseContext, List<BibEntry> entries, List<Path> fileDirForDatabase)

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

Field Detail

bibtexExporter	back to summary
private final Exporter bibtexExporter

cliPreferences	back to summary
private final CliPreferences cliPreferences

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

exporterFactory	back to summary
private final ExporterFactory exporterFactory

LOGGER	back to summary
private static final Logger LOGGER

porcelain	back to summary
private final boolean porcelain

Constructor Detail

ExportService	back to summary
public ExportService(CliPreferences cliPreferences, boolean porcelain)

Method Detail

create	back to summary
public static ExportService create(CliPreferences cliPreferences, boolean porcelain)

createBibtexExporter	back to summary
private Exporter createBibtexExporter()

exportBibDatabaseContextToFile	back to summary
public void exportBibDatabaseContextToFile(BibDatabaseContext databaseContext, List<BibEntry> matches, Path outputFile, String outputFormat) throws ExportServiceException

exportEntriesToFile	back to summary
public void exportEntriesToFile(List<BibEntry> entries, Path outputFile, String outputFormat) throws ExportServiceException

exportParserResultToFile	back to summary
public void exportParserResultToFile(ParserResult parserResult, Path outputFile, String format) throws ExportServiceException

exportParserResultToStdOut	back to summary
public void exportParserResultToStdOut(ParserResult parserResult, String format) throws ExportServiceException

generateCitationKeys	back to summary
private static void generateCitationKeys(BibDatabaseContext databaseContext, CitationKeyPatternPreferences citationKeyPatternPreferences) Generates a citation key if there is no key existing

getAvailableExportFormats	back to summary
public List<Pair<String, String>> getAvailableExportFormats()

getExporterByName	back to summary
private Exporter getExporterByName(String exporterId) throws ExportServiceException

internalSaveDatabaseContext	back to summary
private void internalSaveDatabaseContext(BibDatabaseContext bibDatabaseContext, Path outputFile) throws IOException

printBibEntriesToStdOut	back to summary
public void printBibEntriesToStdOut(List<BibEntry> entries) throws ExportServiceException

printDatabaseContextToStdOut	back to summary
public void printDatabaseContextToStdOut(BibDatabaseContext bibDatabaseContext) throws ExportServiceException

printErr	back to summary
private void printErr(String s)

printOut	back to summary
private void printOut(String s)

saveBibEntries	back to summary
public void saveBibEntries(List<BibEntry> matches, Path outputFile) throws ExportServiceException

saveDatabase	back to summary
public void saveDatabase(BibDatabase newBase, Path outputFile) throws ExportServiceException

saveDatabaseContext	back to summary
public void saveDatabaseContext(BibDatabaseContext bibDatabaseContext, Path outputFile) throws ExportServiceException

tryExportWithExporter	back to summary
private void tryExportWithExporter(Exporter exporter, Path outputFile, BibDatabaseContext databaseContext, List<BibEntry> entries, List<Path> fileDirForDatabase) throws ExportServiceException