Top Description Fields Constructors Methods
org.jabref.model.openoffice.style

public Class CitedKey

extends Object
implements ComparableCitedKey, CitationMarkerNormEntry, CitationMarkerNumericBibEntry
Class Inheritance
All Implemented Interfaces
org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry, org.jabref.model.openoffice.style.CitationMarkerNormEntry, org.jabref.model.openoffice.style.ComparableCitedKey
Imports
java.util.ArrayList, .List, .Optional, org.jabref.model.database.BibDatabase, org.jabref.model.entry.BibEntry, org.jabref.model.openoffice.ootext.OOText
Cited keys are collected from the citations in citation groups.

They contain backreferences to the corresponding citations in where. This allows the extra information generated using CitedKeys to be distributed back to the in-text citations.

Field Summary

Modifier and TypeField and Description
public final String
citationKey

private Optional<CitationLookupResult>
db

private Optional<OOText>
normCitMarker

private Optional<Integer>
number

private Optional<String>
uniqueLetter

private final List<CitationPath>
where

Constructor Summary

AccessConstructor and Description
pack-priv
CitedKey(String citationKey, CitationPath path, Citation citation)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
addPath(CitationPath path, Citation cit)

Appends to end of where

pack-priv void
distributeLookupResult(CitationGroups citationGroups)

pack-priv void
distributeNumber(CitationGroups citationGroups)

pack-priv void
distributeUniqueLetter(CitationGroups citationGroups)

public Optional<BibEntry>
getBibEntry()

Implements org.jabref.model.openoffice.style.ComparableCitedKey.getBibEntry.

public String
getCitationKey()

Implements org.jabref.model.openoffice.style.ComparableCitedKey.getCitationKey, org.jabref.model.openoffice.style.CitationMarkerNormEntry.getCitationKey, org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry.getCitationKey.

Citation key.

public List<CitationPath>
getCitationPaths()

public Optional<CitationLookupResult>
getLookupResult()

Implements org.jabref.model.openoffice.style.CitationMarkerNormEntry.getLookupResult.

Result of looking up citation key in databases.

public Optional<OOText>
getNormalizedCitationMarker()

public Optional<Integer>
getNumber()

Implements org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry.getNumber.

public Optional<String>
getUniqueLetter()

pack-priv void
lookupInDatabases(List<BibDatabase> databases)

public void
setNormalizedCitationMarker(Optional<OOText> normCitMarker)

public void
setNumber(Optional<Integer> number)

public void
setUniqueLetter(Optional<String> uniqueLetter)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

citationKeyback to summary
public final String citationKey
dbback to summary
private Optional<CitationLookupResult> db
normCitMarkerback to summary
private Optional<OOText> normCitMarker
numberback to summary
private Optional<Integer> number
uniqueLetterback to summary
private Optional<String> uniqueLetter
whereback to summary
private final List<CitationPath> where

Constructor Detail

CitedKeyback to summary
pack-priv CitedKey(String citationKey, CitationPath path, Citation citation)

Method Detail

addPathback to summary
pack-priv void addPath(CitationPath path, Citation cit)

Appends to end of where

distributeLookupResultback to summary
pack-priv void distributeLookupResult(CitationGroups citationGroups)
distributeNumberback to summary
pack-priv void distributeNumber(CitationGroups citationGroups)
distributeUniqueLetterback to summary
pack-priv void distributeUniqueLetter(CitationGroups citationGroups)
getBibEntryback to summary
public Optional<BibEntry> getBibEntry()

Implements org.jabref.model.openoffice.style.ComparableCitedKey.getBibEntry.

Annotations
@Override
getCitationKeyback to summary
public String getCitationKey()

Implements org.jabref.model.openoffice.style.ComparableCitedKey.getCitationKey, org.jabref.model.openoffice.style.CitationMarkerNormEntry.getCitationKey, org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry.getCitationKey.

Doc from org.jabref.model.openoffice.style.CitationMarkerNormEntry.getCitationKey.

Citation key. This is what we usually get from the document.

Used if getLookupResult() returns empty, which indicates failure to lookup in the databases.

Annotations
@Override
getCitationPathsback to summary
public List<CitationPath> getCitationPaths()
getLookupResultback to summary
public Optional<CitationLookupResult> getLookupResult()

Implements org.jabref.model.openoffice.style.CitationMarkerNormEntry.getLookupResult.

Doc from org.jabref.model.openoffice.style.CitationMarkerNormEntry.getLookupResult.

Result of looking up citation key in databases.

Optional.empty() indicates unresolved citation.

Annotations
@Override
getNormalizedCitationMarkerback to summary
public Optional<OOText> getNormalizedCitationMarker()
getNumberback to summary
public Optional<Integer> getNumber()

Implements org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry.getNumber.

Returns:Optional<Integer>

Doc from org.jabref.model.openoffice.style.CitationMarkerNumericBibEntry.getNumber.

Optional.empty() for unresolved

Annotations
@Override
getUniqueLetterback to summary
public Optional<String> getUniqueLetter()
lookupInDatabasesback to summary
pack-priv void lookupInDatabases(List<BibDatabase> databases)
setNormalizedCitationMarkerback to summary
public void setNormalizedCitationMarker(Optional<OOText> normCitMarker)
setNumberback to summary
public void setNumber(Optional<Integer> number)
setUniqueLetterback to summary
public void setUniqueLetter(Optional<String> uniqueLetter)