Top Description Fields Constructors Methods

org.jabref.model.openoffice.style

public Class CitationGroups

Class Inheritance

extends Object

java.lang.Object
org.jabref.model.openoffice.style.CitationGroups

Imports

java.util.ArrayList, .Comparator, .LinkedHashMap, .List, .Map, .Optional, java.util.function.Consumer, org.jabref.model.database.BibDatabase, org.jabref.model.entry.BibEntry, org.jabref.model.openoffice.util.OOListUtil, .OOPair, org.jspecify.annotations.NonNull, org.slf4j.Logger, .LoggerFactory

CitationGroups : the set of citation groups in the document.

This is the main input (as well as output) for creating citation markers and bibliography.

Field Summary

Modifier and Type	Field and Description
private Optional<CitedReferences>	bibliography This is going to be the bibliography
private final Map<CitationGroupId, CitationGroup>	citationGroupsUnordered
private Optional<List<CitationGroupId>>	globalOrder Provides order of appearance for the citation groups.
private static final Logger	LOGGER

Constructor Summary

Access	Constructor and Description
public	CitationGroups(Map<CitationGroupId, CitationGroup> citationGroups) Constructor

Method Summary

Modifier and Type	Method and Description
public void	afterCreateCitationGroup(CitationGroup group)
public void	afterRemoveCitationGroup(CitationGroup group)
public boolean	citationGroupsProvideReferenceMarkNameForLinking() Returns: true if all citation groups have referenceMarkNameForLinking
public void	createNumberedBibliographySortedByComparator(Comparator<BibEntry> entryComparator) Precondition database lookup already performed (otherwise we just sort citation keys)
public void	createNumberedBibliographySortedInOrderOfAppearance()
public void	createPlainBibliographySortedByComparator(Comparator<BibEntry> entryComparator) Precondition database lookup already performed (otherwise we just sort citation keys)
public <T> void	distributeToCitations(List<CitationPath> where, Consumer<OOPair<Citation, T>> fun, T value) For each citation in `where` call `fun.accept(new Pair(citation, value));`
public Optional<CitedReferences>	getBibliography()
public Optional<CitationGroup>	getCitationGroup(CitationGroupId groupId)
public List<CitationGroup>	getCitationGroupsInGlobalOrder() Citation groups in `globalOrder`
public List<CitationGroup>	getCitationGroupsUnordered()
public CitedReferences	getCitedReferencesSortedInOrderOfAppearance() CitedReferences created iterating citations in (globalOrder,localOrder)
public CitedReferences	getCitedReferencesUnordered() Collect citations into a list of cited sources using neither CitationGroup.globalOrder or Citation.localOrder
public List<String>	getUnresolvedKeys() Returns: Citation keys where lookupCitations() failed.
public boolean	hasGlobalOrder()
public void	imposeLocalOrder(Comparator<BibEntry> entryComparator) Impose an order for citations within each group.
public void	lookupCitations(List<BibDatabase> databases)
public int	numberOfCitationGroups()
public void	setGlobalOrder(@NonNull List<CitationGroupId> globalOrder) Impose an order of citation groups by providing the order of their citation group idendifiers.

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

Field Detail

bibliography	back to summary
private Optional<CitedReferences> bibliography This is going to be the bibliography

citationGroupsUnordered	back to summary
private final Map<CitationGroupId, CitationGroup> citationGroupsUnordered

globalOrder	back to summary
private Optional<List<CitationGroupId>> globalOrder Provides order of appearance for the citation groups.

LOGGER	back to summary
private static final Logger LOGGER

Constructor Detail

CitationGroups	back to summary
public CitationGroups(Map<CitationGroupId, CitationGroup> citationGroups) Constructor

Method Detail

afterCreateCitationGroup	back to summary
public void afterCreateCitationGroup(CitationGroup group)

afterRemoveCitationGroup	back to summary
public void afterRemoveCitationGroup(CitationGroup group)

citationGroupsProvideReferenceMarkNameForLinking	back to summary
public boolean citationGroupsProvideReferenceMarkNameForLinking() Returns:boolean true if all citation groups have referenceMarkNameForLinking

createNumberedBibliographySortedByComparator	back to summary
public void createNumberedBibliographySortedByComparator(Comparator<BibEntry> entryComparator) Precondition database lookup already performed (otherwise we just sort citation keys)

createNumberedBibliographySortedInOrderOfAppearance	back to summary
public void createNumberedBibliographySortedInOrderOfAppearance()

createPlainBibliographySortedByComparator	back to summary
public void createPlainBibliographySortedByComparator(Comparator<BibEntry> entryComparator) Precondition database lookup already performed (otherwise we just sort citation keys)

distributeToCitations	back to summary
public <T> void distributeToCitations(List<CitationPath> where, Consumer<OOPair<Citation, T>> fun, T value) For each citation in `where` call `fun.accept(new Pair(citation, value));`

getBibliography	back to summary
public Optional<CitedReferences> getBibliography()

getCitationGroup	back to summary
public Optional<CitationGroup> getCitationGroup(CitationGroupId groupId)

getCitationGroupsInGlobalOrder	back to summary
public List<CitationGroup> getCitationGroupsInGlobalOrder() Citation groups in `globalOrder`

getCitationGroupsUnordered	back to summary
public List<CitationGroup> getCitationGroupsUnordered()

getCitedReferencesSortedInOrderOfAppearance	back to summary
public CitedReferences getCitedReferencesSortedInOrderOfAppearance() CitedReferences created iterating citations in (globalOrder,localOrder)

getCitedReferencesUnordered	back to summary
public CitedReferences getCitedReferencesUnordered() Collect citations into a list of cited sources using neither CitationGroup.globalOrder or Citation.localOrder

getUnresolvedKeys	back to summary
public List<String> getUnresolvedKeys() Returns:List<String> Citation keys where lookupCitations() failed.

hasGlobalOrder	back to summary
public boolean hasGlobalOrder()

imposeLocalOrder	back to summary
public void imposeLocalOrder(Comparator<BibEntry> entryComparator) Impose an order for citations within each group.

lookupCitations	back to summary
public void lookupCitations(List<BibDatabase> databases)

numberOfCitationGroups	back to summary
public int numberOfCitationGroups()

setGlobalOrder

back to summary

public void setGlobalOrder(@NonNull List<CitationGroupId> globalOrder)

Impose an order of citation groups by providing the order of their citation group idendifiers.

Also set indexInGlobalOrder for each citation group.