JabRef 6.0-beta.1 · org.jabref.logic.openoffice.style.JStyle

Modifier and Type	Class and Description
pack-priv static enum	JStyle.BibStyleMode

Field Summary

Modifier and Type	Field and Description
private final JournalAbbreviationRepository	abbreviationRepository
private static final String	AUTHOR_FIELD
private static final String	AUTHOR_LAST_SEPARATOR
private static final String	AUTHOR_LAST_SEPARATOR_IN_TEXT
private static final String	AUTHOR_NAME_MARKUP_AFTER
private static final String	AUTHOR_NAME_MARKUP_BEFORE
private static final String	AUTHOR_NAMES_LIST_MARKUP_AFTER
private static final String	AUTHOR_NAMES_LIST_MARKUP_BEFORE
private static final String	AUTHOR_SEPARATOR
private static final String	AUTHORS_PART_MARKUP_AFTER
private static final String	AUTHORS_PART_MARKUP_BEFORE
private final Map<EntryType, Layout>	bibLayout
private static final String	BOLD_CITATIONS
private static final String	BRACKET_AFTER
private static final String	BRACKET_AFTER_IN_LIST
private static final String	BRACKET_BEFORE
private static final String	BRACKET_BEFORE_IN_LIST
private static final String	CITATION_CHARACTER_FORMAT
private static final String	CITATION_GROUP_MARKUP_AFTER
private static final String	CITATION_GROUP_MARKUP_BEFORE
private static final String	CITATION_KEY_CITATIONS
private static final String	CITATION_MARK
private static final String	CITATION_SEPARATOR
private final Map<String, Object>	citProperties
private static final String	DEFAULT_MARK
private Layout	defaultBibLayout
public static final String	ET_AL_STRING
private final LayoutFormatter	fieldFormatter
private static final String	FORMAT_CITATIONS
private boolean	fromResource Flag indicating whether this style is loaded from internal resources (true) or from an external file (false).
private static final String	GROUPED_NUMBERS_SEPARATOR
private static final String	IN_TEXT_YEAR_SEPARATOR
private static final String	IS_NUMBER_ENTRIES
private static final String	IS_SORT_BY_POSITION
private boolean	isDefaultLayoutPresent
private static final String	ITALIC_CITATIONS
public static final String	ITALIC_ET_AL
private final SortedSet<String>	journals
private static final String	JOURNALS_MARK
private static final String	LAYOUT_MRK
private final LayoutFormatterPreferences	layoutPreferences
private String	localCopy
private static final Logger	LOGGER
private static final String	MAX_AUTHORS
public static final String	MAX_AUTHORS_FIRST
public static final String	MINIMUM_GROUPING_COUNT
public static final String	MULTI_CITE_CHRONOLOGICAL
private String	name
private static final String	NAME_MARK
private static final Pattern	NUM_PATTERN
private static final String	OXFORD_COMMA
private static final String	PAGE_INFO_SEPARATOR
private final String	path Path used to identify the style file.
private final Map<String, Object>	properties
private static final String	PROPERTIES_MARK
private static final Pattern	QUOTED
public static final String	REFERENCE_HEADER_PARAGRAPH_FORMAT
public static final String	REFERENCE_PARAGRAPH_FORMAT
private static final String	SORT_ALGORITHM
private static final String	SPACE_BEFORE
private final Path	styleFile Reference to the style file on the filesystem.
private long	styleFileModificationTime
private static final String	SUBSCRIPT_CITATIONS
private static final String	SUPERSCRIPT_CITATIONS
public static final String	TITLE
public static final String	UNDEFINED_CITATION_MARKER
private static final String	UNIQUEFIER_SEPARATOR
private boolean	valid
private static final String	YEAR_FIELD
private static final String	YEAR_SEPARATOR

Access	Constructor and Description
public	JStyle(@NonNull Path styleFile, @NonNull LayoutFormatterPreferences layoutPreferences, JournalAbbreviationRepository abbreviationRepository)
public	JStyle(@NonNull String resourcePath, @NonNull LayoutFormatterPreferences layoutPreferences, JournalAbbreviationRepository abbreviationRepository)

Method Summary

Modifier and Type	Method and Description
protected void	addJournal(String journalName)
public int	compareTo(JStyle other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public OOText	Returns: The formatted citation. The result does not include the standard wrappers: OOFormat.setLocaleNone() and OOFormat.setCharStyle(). These are added by decorateCitationMarker() createCitationMarker(List<CitationMarkerEntry> The list of entries providing the data. citationMarkerEntries, boolean Signals whether a parenthesized citation or an in-text citation is wanted. inParenthesis, NonUniqueCitationMarker THROWS : Should throw if finds that uniqueLetters provided do not make the entries unique. nonUniqueCitationMarkerHandling) Format the marker for the in-text citation according to this BIB style.
public OOText	createCitationMarker(List<CitationMarkerEntry> citationMarkerEntries, CitationType citationType, NonUniqueCitationMarker nonUniqueCitationMarkerHandling) As `createCitationMarker(List, boolean, NonUniqueCitationMarker)`, but takes the presentation from the citation type of the group, so that the partial and bracket-less citation types of https://github.com/JabRef/jabref/issues/7861 are handled as well.
public OOText	decorateCitationMarker(OOText citationText) Add setLocaleNone and optionally setCharStyle(CitationCharacterFormat) around citationText.
public void	ensureUpToDate() If this style was initialized from a file on disk, reload the style if the file has been modified since it was read.
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
protected OrFields	getAuthorFieldNames() Returns: Names of fields containing authors: the first non-empty field will be used.
protected String	getAuthorLastSeparator()
protected String	getAuthorLastSeparatorInTextWithFallBack()
public String	getAuthorNameMarkupAfter()
public String	getAuthorNameMarkupBefore() Author names.
public String	getAuthorNamesListMarkupAfter()
public String	getAuthorNamesListMarkupBefore() Author list, excluding " et al."
protected String	getAuthorSeparator() The String to add between author names except the last two: `"[Smith{, }Jones and Brown]"`
public String	getAuthorsPartMarkupAfter()
public String	getAuthorsPartMarkupBefore() Author list, including " et al."
protected Map<EntryType, Layout>	getBibLayout()
public boolean	Returns: the value getBooleanCitProperty(String The property key key) Get boolean property.
protected String	getBracketAfter() Closing parenthesis after citation
private String	getBracketAfterInList() Closing parenthesis after citation marker in the bibliography
pack-priv String	getBracketAfterInListWithFallBack()
protected String	getBracketBefore() Opening parenthesis before citation (or year, for in-text)
private String	getBracketBeforeInList() Opening parenthesis before citation marker in the bibliography.
public String	getBracketBeforeInListWithFallBack()
public String	getCitationCharacterFormat()
public String	getCitationGroupMarkupAfter()
public String	getCitationGroupMarkupBefore() Should citation markers be italicized?
protected String	getCitationSeparator()
protected Map<String, Object>	getCitProperties()
public Layout	getDefaultBibLayout()
public String	getEtAlString() The String to represent authors that are not mentioned, e.g. " et al."
protected LayoutFormatter	getFieldFormatter()
public Path	getFile()
public OOText	getFormattedBibliographyTitle()
public String	getGroupedNumbersSeparator() Used in number ranges like "10-13" in numbered citations.
public int	getIntCitProperty(String key)
protected boolean	getIsDefaultLayoutPresent()
public boolean	getItalicEtAl()
public Set<String>	getJournals()
protected LayoutFormatterPreferences	getLayoutPreferences()
public String	getLocalCopy()
protected int	getMaxAuthors() The maximum number of authors to write out in full without using "et al." Set to -1 to always write out all authors.
public int	getMaxAuthorsFirst()
public int	getMinimumGroupingCount() Minimal number of consecutive citation numbers needed to start replacing with an range like "10-13".
public boolean	getMultiCiteChronological()
public String	getName() Implements org.jabref.logic.openoffice.style.OOStyle.getName.
public OOText	getNormalizedCitationMarker(CitationMarkerNormEntry entry)
public OOText	Returns: The text for the citation. getNumCitationMarker2(List<CitationMarkerNumericEntry> entries) Format a number-based citation marker for the given entries.
public OOText	getNumCitationMarker2(List<CitationMarkerNumericEntry> entries, int minGroupingCount) For some tests we need to override minGroupingCount.
public OOText	getNumCitationMarkerForBibliography(CitationMarkerNumericBibEntry entry) Format a number-based bibliography label for the given number.
protected String	getOxfordComma() The String to put after the second to last author in case of three or more authors: (A, B{,} and C)
protected String	getPageInfoSeparator()
public String	getPath() Implements org.jabref.logic.openoffice.style.OOStyle.getPath.
protected Map<String, Object>	getProperties()
public Object	Returns: The property value, or null if it doesn't exist. getProperty(String The property name. propName) Get a style property.
public Layout	getReferenceFormat(EntryType type)
public String	getReferenceHeaderParagraphFormat() Name of paragraph format (within OO/LO) to be used for the title of the bibliography.
public OOText	getReferenceHeaderText() Title for the bibliography.
public String	getReferenceParagraphFormat() Name of paragraph format (within OO/LO) to be used for the entries in the bibliography.
public String	getStringCitProperty(String key)
private String	getStringProperty(String propName)
protected String	getUniquefierSeparator()
protected OrFields	getYearFieldNames() Returns: Field containing year, with fallback fields.
protected String	getYearSeparator()
protected String	getYearSeparatorInText()
private void	handleJournalsLine(String line) Parse a line providing a journal name for which this style is valid.
private void	handlePropertiesLine(String The line containing the formatter names. line, Map<String, Object> map) Parse a line providing a property name and value.
private void	handleStructureLine(String The string containing the structure description. line) Parse a line providing bibliography structure information for an entry type.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	initialize(@NonNull InputStream stream)
public boolean	Returns: true to indicate that citations should be in bold. isBoldCitations() Convenience method for checking whether citation markers should be bold.
public boolean	isCitationKeyCiteMarkers()
public boolean	Returns: true to indicate that citations should be in italics. isFormatCitations() Convenience method for checking whether citation markers formatted according to the results of the isItalicCitations() and isBoldCitations() methods.
public boolean	Returns: True if an internal style isInternalStyle() Implements org.jabref.logic.openoffice.style.OOStyle.isInternalStyle. Indicate if it is an internal style
public boolean	Returns: true to indicate that citations should be in italics. isItalicCitations() Convenience method for checking whether citation markers should be italicized.
public boolean	Returns: true if we use numbered citations, false otherwise. isNumberEntries() Convenience method for checking the property for whether we use number citations or author-year citations.
public boolean	Returns: true to sort by appearance, false to sort alphabetically. isSortByPosition() Convenience method for checking the property for whether we sort the bibliography according to their order of appearance in the text.
private boolean	Returns: true if the file has not been modified, false otherwise. isUpToDate() If this style was initialized from a file on disk, check whether the file is unmodified since initialization.
public boolean	Returns: true if the file could be parsed as a style file, false otherwise. isValid() After initializing this style from a file, this method can be used to check whether the file appeared to be a proper style file.
private void	readFormatFile(Reader input)
private void	reload() If this style was initialized from a file on disk, reload the style information.
protected void	setDefaultBibLayout(Layout layout)
private void	setDefaultProperties()
protected void	setIsDefaultLayoutPresent(boolean isPresent)
protected void	setLocalCopy(String contentsOfJstyleFile)
protected void	setName(String nameOfTheStyle)
protected void	setValid(boolean isValid)
public boolean	spaceBeforeCitation()

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

public Class JStyle

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary