Modifier and Type	Class and Description
pack-priv static record	BSTCitationOOAdapter.StyleOrderAndLabels

Modifier and Type	Field and Description
private static final Pattern	BIBITEM_PATTERN Matches a rendered `\\bibitem`, capturing its optional display label and required key.
private final com.sun.star.uno.XComponentContext	componentContext
private final com.sun.star.text.XTextDocument	document
private Map<String, String>	identifierToLabelMap
private final BSTReferenceMarkManager	markManager
private final OpenOfficePreferences	openOfficePreferences
private final PandocLatexConverter	pandoc

Access	Constructor and Description
public	BSTCitationOOAdapter(com.sun.star.text.XTextDocument document, com.sun.star.uno.XComponentContext componentContext, OpenOfficePreferences openOfficePreferences)

Method Summary

Modifier and Type	Method and Description
pack-priv static String	buildAuthorYearCitation(List<BibEntry> entries, BibDatabaseContext ctx)
private String	buildNumericCitation(List<BibEntry> entries)
pack-priv static String	buildNumericCitationText(List<String> identifiers, Map<String, Integer> identifierToNumberMap)
private String	buildStyleDefinedCitation(List<BibEntry> entries, BibDatabaseContext ctx)
pack-priv static String	buildStyleDefinedCitationText(List<String> identifiers, Map<String, String> identifierToLabelMap)
pack-priv static BSTCitationOOAdapter.StyleOrderAndLabels	computeStyleOrderAndLabels(BstVM bstVM, List<BibEntry> entries, BibDatabase database)
pack-priv static BSTCitationOOAdapter.StyleOrderAndLabels	computeStyleOrderAndLabels(String renderedBibliography, Map<String, String> keyToIdentifier)
private boolean	currentStyleUsesStyleDefinedNumericOrder()
private void	ensureStyleDefinedLabels(List<BibEntry> entries, BibDatabase database)
pack-priv static String	extractFirstAuthorLastName(BibEntry entry)
private List<BibEntry>	getCitedEntriesIncluding(List<BibEntry> entries, BibDatabase database)
public List<String>	getCitedIdentifiers()
pack-priv static String	getStyleDefinedLabelOrThrow(String identifier, Map<String, String> identifierToLabelMap)
public void	insertBibliography(com.sun.star.text.XTextCursor cursor, BstStyle style, List<BibEntry> entries, BibDatabaseContext ctx) Inserts the bibliography by rendering each cited entry through BST → pandoc → OOText.
public void	insertCitation(com.sun.star.text.XTextCursor cursor, List<BibEntry> entries, BibDatabaseContext ctx) Inserts an in-text citation mark.
private void	invalidateStyleDefinedLabels()
public boolean	isCitedEntry(BibEntry entry) Returns `true` if the given entry has already been cited in the document.
pack-priv static boolean	isSupportedStyleDefinedLabel(String label)
pack-priv static String	keyOrId(BibEntry entry)
public void	refreshCitationState()
private void	updateNumericCitationTexts(BibDatabase database)
private void	updateStyleDefinedCitationTexts(BibDatabase database)

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

Field Detail

BIBITEM_PATTERN back to summary

BIBITEM_PATTERN	back to summary
private static final Pattern BIBITEM_PATTERN Matches a rendered `\\bibitem`, capturing its optional display label and required key. Examples: `\\bibitem{smith2020}` → label absent, key `smith2020` `\\bibitem[SG20]{smith2020}` → label `SG20`, key `smith2020`

private static final Pattern BIBITEM_PATTERN

Matches a rendered \\bibitem, capturing its optional display label and required key.

Examples:

\\bibitem{smith2020} → label absent, key smith2020
\\bibitem[SG20]{smith2020} → label SG20, key smith2020

componentContext	back to summary
private final com.sun.star.uno.XComponentContext componentContext

document	back to summary
private final com.sun.star.text.XTextDocument document

identifierToLabelMap	back to summary
private Map<String, String> identifierToLabelMap

markManager	back to summary
private final BSTReferenceMarkManager markManager

openOfficePreferences	back to summary
private final OpenOfficePreferences openOfficePreferences

pandoc	back to summary
private final PandocLatexConverter pandoc

BSTCitationOOAdapter	back to summary
public BSTCitationOOAdapter(com.sun.star.text.XTextDocument document, com.sun.star.uno.XComponentContext componentContext, OpenOfficePreferences openOfficePreferences) throws com.sun.star.lang.WrappedTargetException, com.sun.star.container.NoSuchElementException

Method Detail

buildAuthorYearCitation	back to summary
pack-priv static String buildAuthorYearCitation(List<BibEntry> entries, BibDatabaseContext ctx) Annotations @VisibleForTesting

buildNumericCitation	back to summary
private String buildNumericCitation(List<BibEntry> entries)

buildNumericCitationText	back to summary
pack-priv static String buildNumericCitationText(List<String> identifiers, Map<String, Integer> identifierToNumberMap) Annotations @VisibleForTesting

buildStyleDefinedCitation	back to summary
private String buildStyleDefinedCitation(List<BibEntry> entries, BibDatabaseContext ctx) throws MissingStyleDefinedCitationLabelException

buildStyleDefinedCitationText	back to summary
pack-priv static String buildStyleDefinedCitationText(List<String> identifiers, Map<String, String> identifierToLabelMap) throws MissingStyleDefinedCitationLabelException Annotations @VisibleForTesting

computeStyleOrderAndLabels	back to summary
pack-priv static BSTCitationOOAdapter.StyleOrderAndLabels computeStyleOrderAndLabels(BstVM bstVM, List<BibEntry> entries, BibDatabase database) Annotations @VisibleForTesting

computeStyleOrderAndLabels	back to summary
pack-priv static BSTCitationOOAdapter.StyleOrderAndLabels computeStyleOrderAndLabels(String renderedBibliography, Map<String, String> keyToIdentifier) Annotations @VisibleForTesting

currentStyleUsesStyleDefinedNumericOrder	back to summary
private boolean currentStyleUsesStyleDefinedNumericOrder()

ensureStyleDefinedLabels	back to summary
private void ensureStyleDefinedLabels(List<BibEntry> entries, BibDatabase database)

extractFirstAuthorLastName	back to summary
pack-priv static String extractFirstAuthorLastName(BibEntry entry) Annotations @VisibleForTesting

getCitedEntriesIncluding	back to summary
private List<BibEntry> getCitedEntriesIncluding(List<BibEntry> entries, BibDatabase database)

getCitedIdentifiers	back to summary
public List<String> getCitedIdentifiers() throws com.sun.star.lang.WrappedTargetException, com.sun.star.container.NoSuchElementException

getStyleDefinedLabelOrThrow	back to summary
pack-priv static String getStyleDefinedLabelOrThrow(String identifier, Map<String, String> identifierToLabelMap) throws MissingStyleDefinedCitationLabelException Annotations @VisibleForTesting

insertBibliography	back to summary
public void insertBibliography(com.sun.star.text.XTextCursor cursor, BstStyle style, List<BibEntry> entries, BibDatabaseContext ctx) throws IOException, InterruptedException, com.sun.star.uno.Exception, CreationException, MissingStyleDefinedCitationLabelException Inserts the bibliography by rendering each cited entry through BST → pandoc → OOText. Entries are sorted by first-appearance (citation-number) order or BST style order.

insertBibliography

back to summary

public void insertBibliography(com.sun.star.text.XTextCursor cursor, BstStyle style, List<BibEntry> entries, BibDatabaseContext ctx) throws IOException, InterruptedException, com.sun.star.uno.Exception, CreationException, MissingStyleDefinedCitationLabelException

Inserts the bibliography by rendering each cited entry through BST → pandoc → OOText. Entries are sorted by first-appearance (citation-number) order or BST style order.

insertCitation back to summary

insertCitation	back to summary
public void insertCitation(com.sun.star.text.XTextCursor cursor, List<BibEntry> entries, BibDatabaseContext ctx) throws CreationException, com.sun.star.uno.Exception, MissingStyleDefinedCitationLabelException Inserts an in-text citation mark. Format depends on `OpenOfficePreferences#getBstCitationFormat`: `BstCitationFormat#NUMERIC`: `[1]`, `[1, 3]`, ... `BstCitationFormat#AUTHOR_YEAR`: `(Cooper et al., 2007)`, ... `BstCitationFormat#STYLE_DEFINED`: `[ABC20]`, `[ABC20a]`, ...

public void insertCitation(com.sun.star.text.XTextCursor cursor, List<BibEntry> entries, BibDatabaseContext ctx) throws CreationException, com.sun.star.uno.Exception, MissingStyleDefinedCitationLabelException

Inserts an in-text citation mark. Format depends on OpenOfficePreferences#getBstCitationFormat:

BstCitationFormat#NUMERIC: [1], [1, 3], ...
BstCitationFormat#AUTHOR_YEAR: (Cooper et al., 2007), ...
BstCitationFormat#STYLE_DEFINED: [ABC20], [ABC20a], ...

invalidateStyleDefinedLabels	back to summary
private void invalidateStyleDefinedLabels()

isCitedEntry	back to summary
public boolean isCitedEntry(BibEntry entry) Returns `true` if the given entry has already been cited in the document.

isSupportedStyleDefinedLabel	back to summary
pack-priv static boolean isSupportedStyleDefinedLabel(String label) Annotations @VisibleForTesting

keyOrId	back to summary
pack-priv static String keyOrId(BibEntry entry) Annotations @VisibleForTesting

refreshCitationState	back to summary
public void refreshCitationState() throws com.sun.star.lang.WrappedTargetException, com.sun.star.container.NoSuchElementException

updateNumericCitationTexts	back to summary
private void updateNumericCitationTexts(BibDatabase database) throws CreationException, com.sun.star.uno.Exception

updateStyleDefinedCitationTexts	back to summary
private void updateStyleDefinedCitationTexts(BibDatabase database) throws CreationException, com.sun.star.uno.Exception, MissingStyleDefinedCitationLabelException

org.jabref.logic.openoffice.oocsltext back to summary

pack-priv final Record BSTCitationOOAdapter.StyleOrderAndLabels

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.openoffice.oocsltext.BSTCitationOOAdapter.StyleOrderAndLabels

Annotations

@VisibleForTesting

Record Components

identifierToNumberMap:Map<String, Integer>
identifierToLabelMap:Map<String, String>

Field Summary

Modifier and Type	Field and Description
private final Map<String, String>	identifierToLabelMap Record Component accessed by identifierToLabelMap().
private final Map<String, Integer>	identifierToNumberMap Record Component accessed by identifierToNumberMap().

Constructor Summary

Access	Constructor and Description
pack-priv	StyleOrderAndLabels(Map<String, Integer> identifierToNumberMap, Map<String, String> identifierToLabelMap)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Map<String, String>	identifierToLabelMap() Record Component getter of identifierToLabelMap.
public Map<String, Integer>	identifierToNumberMap() Record Component getter of identifierToNumberMap.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

identifierToLabelMap	back to summary
private final Map<String, String> identifierToLabelMap Record Component accessed by identifierToLabelMap().

identifierToNumberMap	back to summary
private final Map<String, Integer> identifierToNumberMap Record Component accessed by identifierToNumberMap().

Constructor Detail

StyleOrderAndLabels	back to summary
pack-priv StyleOrderAndLabels(Map<String, Integer> identifierToNumberMap, Map<String, String> identifierToLabelMap)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

identifierToLabelMap	back to summary
public Map<String, String> identifierToLabelMap() Record Component getter of identifierToLabelMap.

identifierToNumberMap	back to summary
public Map<String, Integer> identifierToNumberMap() Record Component getter of identifierToNumberMap.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class BSTCitationOOAdapter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Record BSTCitationOOAdapter.StyleOrderAndLabels

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail