Verified Owner
Top Inners Fields Constructors Methods
org.jabref.logic.citationkeypattern

public Class CitationKeyPatternPreferences

extends Object
Class Inheritance
Imports
javafx.beans.property.BooleanProperty, .ObjectProperty, .ReadOnlyObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, com.google.common.annotations.VisibleForTesting

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CitationKeyPatternPreferences.KeySuffix

Field Summary

Modifier and TypeField and Description
private static final GlobalCitationKeyPatterns
DEFAULT_CITATION_KEY_PATTERN

private static final SimpleObjectProperty<Character>
DEFAULT_KEYWORD_SEPARATOR

public static final String
DEFAULT_UNWANTED_CHARACTERS

List of unwanted characters.

private final StringProperty
keyPatternRegex

private final StringProperty
keyPatternReplacement

private final ObjectProperty<GlobalCitationKeyPatterns>
keyPatterns

private final ObjectProperty<CitationKeyPatternPreferences.KeySuffix>
keySuffix

private final SimpleObjectProperty<Character>
keywordSeparator

private final BooleanProperty
shouldAvoidOverwriteCiteKey

private final BooleanProperty
shouldGenerateCiteKeysBeforeSaving

private final BooleanProperty
shouldTransliterateFieldsForCitationKey

private final BooleanProperty
shouldWarnBeforeOverwriteCiteKey

private final StringProperty
unwantedCharacters

Constructor Summary

AccessConstructor and Description
public
CitationKeyPatternPreferences(boolean shouldTransliterateFieldsForCitationKey, boolean shouldAvoidOverwriteCiteKey, boolean shouldWarnBeforeOverwriteCiteKey, boolean shouldGenerateCiteKeysBeforeSaving, CitationKeyPatternPreferences.KeySuffix keySuffix, String keyPatternRegex, String keyPatternReplacement, String unwantedCharacters, GlobalCitationKeyPatterns keyPatterns, ReadOnlyObjectProperty<Character>
should always be org.jabref.model.entry.BibEntryPreferences#keywordSeparator
keywordSeparator)

private
CitationKeyPatternPreferences()

Method Summary

Modifier and TypeMethod and Description
public static CitationKeyPatternPreferences
getDefault()

public String
getKeyPatternRegex()

public String
getKeyPatternReplacement()

public GlobalCitationKeyPatterns
getKeyPatterns()

public CitationKeyPatternPreferences.KeySuffix
getKeySuffix()

public Character
getKeywordSeparator()

public String
getUnwantedCharacters()

public StringProperty
keyPatternRegexProperty()

public StringProperty
keyPatternReplacementProperty()

public ObjectProperty<GlobalCitationKeyPatterns>
keyPatternsProperty()

public ObjectProperty<CitationKeyPatternPreferences.KeySuffix>
keySuffixProperty()

public void
setAvoidOverwriteCiteKey(boolean shouldAvoidOverwriteCiteKey)

public void
setGenerateCiteKeysBeforeSaving(boolean shouldGenerateCiteKeysBeforeSaving)

public void
setKeyPatternRegex(String keyPatternRegex)

public void
setKeyPatternReplacement(String keyPatternReplacement)

public void
setKeyPatterns(GlobalCitationKeyPatterns keyPatterns)

public void
setKeySuffix(CitationKeyPatternPreferences.KeySuffix keySuffix)

public void
setShouldTransliterateFieldsForCitationKey(boolean shouldTransliterateFieldsForCitationKey)

public void
setUnwantedCharacters(String unwantedCharacters)

public void
setWarnBeforeOverwriteCiteKey(boolean shouldWarnBeforeOverwriteCiteKey)

public boolean
shouldAvoidOverwriteCiteKey()

public BooleanProperty
shouldAvoidOverwriteCiteKeyProperty()

public boolean
shouldGenerateCiteKeysBeforeSaving()

public BooleanProperty
shouldGenerateCiteKeysBeforeSavingProperty()

public boolean
shouldTransliterateFieldsForCitationKey()

public BooleanProperty
shouldTransliterateFieldsForCitationKeyProperty()

public boolean
shouldWarnBeforeOverwriteCiteKey()

public BooleanProperty
shouldWarnBeforeOverwriteCiteKeyProperty()

public StringProperty
unwantedCharactersProperty()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_CITATION_KEY_PATTERNback to summary
private static final GlobalCitationKeyPatterns DEFAULT_CITATION_KEY_PATTERN
DEFAULT_KEYWORD_SEPARATORback to summary
private static final SimpleObjectProperty<Character> DEFAULT_KEYWORD_SEPARATOR
DEFAULT_UNWANTED_CHARACTERSback to summary
public static final String DEFAULT_UNWANTED_CHARACTERS

List of unwanted characters. These will be removed at the end. Note that + is a wanted character to indicate "et al." in authorsAlpha. Example: ABC+. See org.jabref.logic.citationkeypattern.BracketedPatternTest#authorsAlpha() for examples.

Should never be used directly - use CitationKeyPatternPreferences#getUnwantedCharacters() instead, which respects the user's preferences

See also #DISALLOWED_CHARACTERS

Annotations
@VisibleForTesting
keyPatternRegexback to summary
private final StringProperty keyPatternRegex
keyPatternReplacementback to summary
private final StringProperty keyPatternReplacement
keyPatternsback to summary
private final ObjectProperty<GlobalCitationKeyPatterns> keyPatterns
keySuffixback to summary
private final ObjectProperty<CitationKeyPatternPreferences.KeySuffix> keySuffix
keywordSeparatorback to summary
private final SimpleObjectProperty<Character> keywordSeparator
shouldAvoidOverwriteCiteKeyback to summary
private final BooleanProperty shouldAvoidOverwriteCiteKey
shouldGenerateCiteKeysBeforeSavingback to summary
private final BooleanProperty shouldGenerateCiteKeysBeforeSaving
shouldTransliterateFieldsForCitationKeyback to summary
private final BooleanProperty shouldTransliterateFieldsForCitationKey
shouldWarnBeforeOverwriteCiteKeyback to summary
private final BooleanProperty shouldWarnBeforeOverwriteCiteKey
unwantedCharactersback to summary
private final StringProperty unwantedCharacters

Constructor Detail

CitationKeyPatternPreferencesback to summary
public CitationKeyPatternPreferences(boolean shouldTransliterateFieldsForCitationKey, boolean shouldAvoidOverwriteCiteKey, boolean shouldWarnBeforeOverwriteCiteKey, boolean shouldGenerateCiteKeysBeforeSaving, CitationKeyPatternPreferences.KeySuffix keySuffix, String keyPatternRegex, String keyPatternReplacement, String unwantedCharacters, GlobalCitationKeyPatterns keyPatterns, ReadOnlyObjectProperty<Character> keywordSeparator)
Parameters
keywordSeparator:ReadOnlyObjectProperty<Character>

should always be org.jabref.model.entry.BibEntryPreferences#keywordSeparator

CitationKeyPatternPreferencesback to summary
private CitationKeyPatternPreferences()

Method Detail

getDefaultback to summary
public static CitationKeyPatternPreferences getDefault()
getKeyPatternRegexback to summary
public String getKeyPatternRegex()
getKeyPatternReplacementback to summary
public String getKeyPatternReplacement()
getKeyPatternsback to summary
public GlobalCitationKeyPatterns getKeyPatterns()
getKeySuffixback to summary
public CitationKeyPatternPreferences.KeySuffix getKeySuffix()
getKeywordSeparatorback to summary
public Character getKeywordSeparator()
getUnwantedCharactersback to summary
public String getUnwantedCharacters()
keyPatternRegexPropertyback to summary
public StringProperty keyPatternRegexProperty()
keyPatternReplacementPropertyback to summary
public StringProperty keyPatternReplacementProperty()
keyPatternsPropertyback to summary
public ObjectProperty<GlobalCitationKeyPatterns> keyPatternsProperty()
keySuffixPropertyback to summary
public ObjectProperty<CitationKeyPatternPreferences.KeySuffix> keySuffixProperty()
setAvoidOverwriteCiteKeyback to summary
public void setAvoidOverwriteCiteKey(boolean shouldAvoidOverwriteCiteKey)
setGenerateCiteKeysBeforeSavingback to summary
public void setGenerateCiteKeysBeforeSaving(boolean shouldGenerateCiteKeysBeforeSaving)
setKeyPatternRegexback to summary
public void setKeyPatternRegex(String keyPatternRegex)
setKeyPatternReplacementback to summary
public void setKeyPatternReplacement(String keyPatternReplacement)
setKeyPatternsback to summary
public void setKeyPatterns(GlobalCitationKeyPatterns keyPatterns)
setKeySuffixback to summary
public void setKeySuffix(CitationKeyPatternPreferences.KeySuffix keySuffix)
setShouldTransliterateFieldsForCitationKeyback to summary
public void setShouldTransliterateFieldsForCitationKey(boolean shouldTransliterateFieldsForCitationKey)
setUnwantedCharactersback to summary
public void setUnwantedCharacters(String unwantedCharacters)
setWarnBeforeOverwriteCiteKeyback to summary
public void setWarnBeforeOverwriteCiteKey(boolean shouldWarnBeforeOverwriteCiteKey)
shouldAvoidOverwriteCiteKeyback to summary
public boolean shouldAvoidOverwriteCiteKey()
shouldAvoidOverwriteCiteKeyPropertyback to summary
public BooleanProperty shouldAvoidOverwriteCiteKeyProperty()
shouldGenerateCiteKeysBeforeSavingback to summary
public boolean shouldGenerateCiteKeysBeforeSaving()
shouldGenerateCiteKeysBeforeSavingPropertyback to summary
public BooleanProperty shouldGenerateCiteKeysBeforeSavingProperty()
shouldTransliterateFieldsForCitationKeyback to summary
public boolean shouldTransliterateFieldsForCitationKey()
shouldTransliterateFieldsForCitationKeyPropertyback to summary
public BooleanProperty shouldTransliterateFieldsForCitationKeyProperty()
shouldWarnBeforeOverwriteCiteKeyback to summary
public boolean shouldWarnBeforeOverwriteCiteKey()
shouldWarnBeforeOverwriteCiteKeyPropertyback to summary
public BooleanProperty shouldWarnBeforeOverwriteCiteKeyProperty()
unwantedCharactersPropertyback to summary
public StringProperty unwantedCharactersProperty()
org.jabref.logic.citationkeypattern back to summary

public final Enum CitationKeyPatternPreferences.KeySuffix

extends Enum<CitationKeyPatternPreferences.KeySuffix>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final CitationKeyPatternPreferences.KeySuffix
ALWAYS

public static final CitationKeyPatternPreferences.KeySuffix
SECOND_WITH_A

public static final CitationKeyPatternPreferences.KeySuffix
SECOND_WITH_B

Constructor Summary

AccessConstructor and Description
private
KeySuffix()

Method Summary

Modifier and TypeMethod and Description
public static CitationKeyPatternPreferences.KeySuffix
valueOf(String name)

public static CitationKeyPatternPreferences.KeySuffix[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ALWAYSback to summary
public static final CitationKeyPatternPreferences.KeySuffix ALWAYS
SECOND_WITH_Aback to summary
public static final CitationKeyPatternPreferences.KeySuffix SECOND_WITH_A
SECOND_WITH_Bback to summary
public static final CitationKeyPatternPreferences.KeySuffix SECOND_WITH_B

Constructor Detail

KeySuffixback to summary
private KeySuffix()

Method Detail

valueOfback to summary
public static CitationKeyPatternPreferences.KeySuffix valueOf(String name)
valuesback to summary
public static CitationKeyPatternPreferences.KeySuffix[] values()