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

public Class Citation

extends Object
implements ComparableCitation, CitationMarkerEntry, CitationMarkerNumericEntry
Class Inheritance
All Implemented Interfaces
org.jabref.model.openoffice.style.CitationMarkerNumericEntry, org.jabref.model.openoffice.style.CitationMarkerEntry, org.jabref.model.openoffice.style.CitationMarkerNormEntry, org.jabref.model.openoffice.style.ComparableCitation, org.jabref.model.openoffice.style.ComparableCitedKey
Imports
java.util.List, .Optional, org.jabref.model.database.BibDatabase, org.jabref.model.entry.BibEntry, org.jabref.model.openoffice.ootext.OOText, org.jabref.model.openoffice.util.OOPair

Field Summary

Modifier and TypeField and Description
public final String
citationKey

key in database

private Optional<CitationLookupResult>
db

Result from database lookup.

private boolean
isFirstAppearanceOfSource

isFirstAppearanceOfSource

private Optional<Integer>
number

The number used for numbered citation styles .

private Optional<OOText>
pageInfo

pageInfo

private Optional<String>
uniqueLetter

Letter that makes the in-text citation unique.

Constructor Summary

AccessConstructor and Description
public
Citation(String citationKey)

Method Summary

Modifier and TypeMethod and Description
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.CitationMarkerNumericEntry.getCitationKey.

Citation key.

public boolean
getIsFirstAppearanceOfSource()

Implements org.jabref.model.openoffice.style.CitationMarkerEntry.getIsFirstAppearanceOfSource.

public Optional<CitationLookupResult>
getLookupResult()

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

Result of looking up citation key in databases.

public Optional<Integer>
getNumber()

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

public int
getNumberOrThrow()

public Optional<OOText>
getPageInfo()

Implements org.jabref.model.openoffice.style.ComparableCitation.getPageInfo, org.jabref.model.openoffice.style.CitationMarkerEntry.getPageInfo, org.jabref.model.openoffice.style.CitationMarkerNumericEntry.getPageInfo.

pageInfo for this citation, provided by the user.

public Optional<String>
getUniqueLetter()

Implements org.jabref.model.openoffice.style.CitationMarkerEntry.getUniqueLetter.

uniqueLetter or Optional.empty() if not needed.

public boolean
isUnresolved()

public static Optional<CitationLookupResult>
lookup(BibDatabase database, String key)

public static Optional<CitationLookupResult>
lookup(List<BibDatabase> databases, String key)

public void
lookupInDatabases(List<BibDatabase> databases)

public void
setIsFirstAppearanceOfSource(boolean value)

public void
setLookupResult(Optional<CitationLookupResult> db)

public static void
setLookupResult(OOPair<Citation, Optional<CitationLookupResult>> pair)

public void
setNumber(Optional<Integer> number)

public static void
setNumber(OOPair<Citation, Optional<Integer>> pair)

public void
setPageInfo(Optional<OOText> pageInfo)

public void
setUniqueLetter(Optional<String> uniqueLetter)

public static void
setUniqueLetter(OOPair<Citation, Optional<String>> pair)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

citationKeyback to summary
public final String citationKey

key in database

dbback to summary
private Optional<CitationLookupResult> db

Result from database lookup. Optional.empty() if not found.

isFirstAppearanceOfSourceback to summary
private boolean isFirstAppearanceOfSource

isFirstAppearanceOfSource

numberback to summary
private Optional<Integer> number

The number used for numbered citation styles .

pageInfoback to summary
private Optional<OOText> pageInfo

pageInfo

uniqueLetterback to summary
private Optional<String> uniqueLetter

Letter that makes the in-text citation unique.

Constructor Detail

Citationback to summary
public Citation(String citationKey)

Method Detail

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.CitationMarkerNumericEntry.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
getIsFirstAppearanceOfSourceback to summary
public boolean getIsFirstAppearanceOfSource()

Implements org.jabref.model.openoffice.style.CitationMarkerEntry.getIsFirstAppearanceOfSource.

Returns:boolean

Doc from org.jabref.model.openoffice.style.CitationMarkerEntry.getIsFirstAppearanceOfSource.

true if this citation is the first appearance of the source cited. Some styles use different limit on the number of authors shown in this case.

Annotations
@Override
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.

getNumberback to summary
public Optional<Integer> getNumber()

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

Returns:Optional<Integer>

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

Optional.empty() for unresolved

Annotations
@Override
getNumberOrThrowback to summary
public int getNumberOrThrow()
getPageInfoback to summary
public Optional<OOText> getPageInfo()

Implements org.jabref.model.openoffice.style.ComparableCitation.getPageInfo, org.jabref.model.openoffice.style.CitationMarkerEntry.getPageInfo, org.jabref.model.openoffice.style.CitationMarkerNumericEntry.getPageInfo.

Doc from org.jabref.model.openoffice.style.CitationMarkerEntry.getPageInfo.

pageInfo for this citation, provided by the user. May be empty, for none.

Annotations
@Override
getUniqueLetterback to summary
public Optional<String> getUniqueLetter()

Implements org.jabref.model.openoffice.style.CitationMarkerEntry.getUniqueLetter.

Doc from org.jabref.model.openoffice.style.CitationMarkerEntry.getUniqueLetter.

uniqueLetter or Optional.empty() if not needed.

isUnresolvedback to summary
public boolean isUnresolved()
lookupback to summary
public static Optional<CitationLookupResult> lookup(BibDatabase database, String key)
lookupback to summary
public static Optional<CitationLookupResult> lookup(List<BibDatabase> databases, String key)
lookupInDatabasesback to summary
public void lookupInDatabases(List<BibDatabase> databases)
setIsFirstAppearanceOfSourceback to summary
public void setIsFirstAppearanceOfSource(boolean value)
setLookupResultback to summary
public void setLookupResult(Optional<CitationLookupResult> db)
setLookupResultback to summary
public static void setLookupResult(OOPair<Citation, Optional<CitationLookupResult>> pair)
setNumberback to summary
public void setNumber(Optional<Integer> number)
setNumberback to summary
public static void setNumber(OOPair<Citation, Optional<Integer>> pair)
setPageInfoback to summary
public void setPageInfo(Optional<OOText> pageInfo)
setUniqueLetterback to summary
public void setUniqueLetter(Optional<String> uniqueLetter)
setUniqueLetterback to summary
public static void setUniqueLetter(OOPair<Citation, Optional<String>> pair)