JabRef 6.0-beta.1 · org.jabref.logic.citationstyle.CSLAdapter

Thread-safe wrapper around the CSL engine that caches the engine.

The creation of a CSL instance is expensive, so the first call to makeBibliography would take some amount of time. For this reason the class stores the instance and reuses it if the style does not change.

It is recommended to use this class when you need to generate many bibliographies in one style. Changing the output format is inexpensive.

Field Summary

Modifier and Type	Field and Description
private @Nullable CSL	currentCslInstance
private @Nullable CitationStyleOutputFormat	currentFormat
private @Nullable String	currentStyle
private final JabRefItemDataProvider	dataProvider

Constructor Summary

Access	Constructor and Description
public	CSLAdapter()

Method Summary

Modifier and Type	Method and Description
public synchronized List<String>	getBibliographyEntryIds(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager)
private CSL	Returns: the initialized CSL instance (or a cached one) getCslInstance(String journal style of the output newStyle, CitationStyleOutputFormat usually HTML or RTF. newFormat) Return the stored CSL instance (if the same style is used) or reinitialize it.
public synchronized List<String>	makeBibliography(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext `BibDatabaseContext` is used to be able to resolve fields and their aliases databaseContext, BibEntryTypesManager entryTypesManager) Creates the bibliography of the provided items.
public synchronized Bibliography	makeBibliographyObject(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager)
public synchronized Citation	makeCitation(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager)

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

Field Detail

currentCslInstance	back to summary
private @Nullable CSL currentCslInstance

currentFormat	back to summary
private @Nullable CitationStyleOutputFormat currentFormat

currentStyle	back to summary
private @Nullable String currentStyle

dataProvider	back to summary
private final JabRefItemDataProvider dataProvider

Constructor Detail

CSLAdapter	back to summary
public CSLAdapter()

Method Detail

getBibliographyEntryIds	back to summary
public synchronized List<String> getBibliographyEntryIds(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager) throws IOException, IllegalArgumentException

getCslInstance	back to summary
private CSL getCslInstance(String newStyle, CitationStyleOutputFormat newFormat) throws IOException Return the stored CSL instance (if the same style is used) or reinitialize it. Parameters newStyle:String journal style of the output newFormat:CitationStyleOutputFormat usually HTML or RTF. Returns:CSL the initialized CSL instance (or a cached one) Exceptions IOException: An error occurred in the underlying framework

getCslInstance

back to summary

private CSL getCslInstance(String newStyle, CitationStyleOutputFormat newFormat) throws IOException

Return the stored CSL instance (if the same style is used) or reinitialize it.

Parameters

newStyle:String: journal style of the output
newFormat:CitationStyleOutputFormat: usually HTML or RTF.

Returns:CSL

the initialized CSL instance (or a cached one)

Exceptions

IOException:: An error occurred in the underlying framework

makeBibliography back to summary

makeBibliography	back to summary
public synchronized List<String> makeBibliography(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager) throws IOException, IllegalArgumentException Creates the bibliography of the provided items. Parameters databaseContext:BibDatabaseContext `BibDatabaseContext` is used to be able to resolve fields and their aliases

public synchronized List<String> makeBibliography(List<BibEntry> bibEntries, String style, CitationStyleOutputFormat outputFormat, BibDatabaseContext databaseContext, BibEntryTypesManager entryTypesManager) throws IOException, IllegalArgumentException

Creates the bibliography of the provided items.