JabRef 6.0-beta.1 · org.jabref.logic.importer.fileformat.BibtexParser

Modifier and Type	Class and Description
private static class	BibtexParser.ConflictMarkerFoundException Thrown as soon as an unresolved version control conflict marker is read, which makes the rest of the file meaningless.

Field Summary

Modifier and Type	Field and Description
private static final String	BIB_DESK_ROOT_GROUP_NAME
private GroupTreeNode	bibDeskGroupTreeNode
private int	column
private static final int	CONFLICT_MARKER_LENGTH Git writes conflict markers as seven characters at the start of a line, but a botched merge can produce longer runs (https://github.com/JabRef/jabref/issues/9167).
private char	conflictMarkerCharacter `0` while the current line does not start with a run of conflict marker characters
private BibDatabase	database
private static final DocumentBuilderFactory	DOCUMENT_BUILDER_FACTORY
private Set<BibEntryType>	entryTypes
private boolean	eof
private static final Pattern	EPILOG_PATTERN
private final Deque<Integer>	highestColumns
private final ImportFormatPreferences	importFormatPreferences
private static final int	INDEX_RELATIVE_PATH_IN_PLIST
private int	line
private static final Logger	LOGGER
private static final int	LOOKAHEAD
private final MetaDataParser	metaDataParser
private final Map<String, String>	parsedBibDeskGroups
private ParserResult	parserResult
private final Deque<Character>	pureTextFromFile
private PushbackReader	pushbackReader

Constructor Summary

Access	Constructor and Description
public	BibtexParser(@NonNull ImportFormatPreferences importFormatPreferences, FileUpdateMonitor fileMonitor)
public	BibtexParser(ImportFormatPreferences importFormatPreferences)

Method Summary

Modifier and Type	Method and Description
private void	addBibDeskGroupEntriesToJabRefGroups(Character keywordSeparator) Adds BibDesk group entries to the JabRef database
private void	checkEpilog()
private void	checkForConflictMarker(int character) Detects a run of conflict marker characters at the start of a line.
private void	consume(char expected)
private void	consume(Field field, char expected)
private void	consume(char firstOption, char secondOption)
private boolean	consumeUncritically(char expected)
private void	createBibDeskGroupTree(Character keywordSeparator)
private String	determineNewLineSeparator()
private String	Returns: the text read so far dumpTextReadSoFarToString() Puts all text that has been read from the reader, including newlines, etc., since the last call of this method into a string.
private String	Returns: rest of key on success, otherwise empty string fixKey() Tries to restore the key
private String	getPureTextFromFile()
public Collection<BibtexString>	getStringValues()
private void	initializeParserResult(String newLineSeparator)
private boolean	isClosingBracketNext()
private boolean	isEntryStart()
private boolean	isEOFCharacter(int character)
private boolean	isEscapeSymbol(char character)
public ParserResult	parse(@NonNull Reader in) Parses BibTeX data found when reading from reader.
private void	parseAndAddEntry(String type)
private void	parseBibDeskComment(String comment, Map<String, String> meta) Parses comment types found in BibDesk, to migrate BibDesk Static Groups to JabRef.
private void	parseBibtexString()
private StringBuilder	parseBracketedFieldContent(boolean recoverAtEntryStart) This is called if a field in the form of `field = {content}` is parsed.
private String	parseBracketedText()
private void	parseDatabaseID()
public List<BibEntry>	parseEntries(InputStream inputStream) Implements org.jabref.logic.importer.Parser.parseEntries.
private BibEntry	parseEntry(String entryType)
private void	parseField(BibEntry entry)
private String	parseFieldContent(Field field)
private ParserResult	parseFileContent()
private void	parseJabRefComment(Map<String, String> meta)
private String	parseKey() This method is used to parse the citation key of an entry.
private String	parsePreamble()
private StringBuilder	parseQuotedFieldExactly()
private void	parseRemainingContent()
public Optional<BibEntry>	parseSingleEntry(String bibtexString)
private BibtexString	parseString()
private String	parseTextToken() This method is used to parse string labels, field names, entry type and numbers outside brackets.
private int	peek()
private char[]	peekTwoCharacters()
private String	Returns: a stripped version of the context purge(String context, String stringToPurge) Purges the given stringToPurge (if it exists) from the given context
private String	Returns: a String without eof characters purgeEOFCharacters(String input) Removes all eof characters from a StringBuilder and returns a new String with the resulting content
private int	read()
private StringBuilder	removeWhitespaces(StringBuilder toRemove) returns a new `StringBuilder` which corresponds to `toRemove` without whitespaces
public static Optional<BibEntry>	Returns: An `Optional<BibEntry>. Optional.empty()` if non was found or an error occurred. singleFromString(String bibtexString, ImportFormatPreferences importFormatPreferences) Parses BibtexEntries from the given string and returns one entry found (or null if none found) It is undetermined which entry is returned, so use this in case you know there is only one entry in the string.
private String	skipAndRecordWhitespace(int character)
private void	skipOneNewline()
private void	skipSpace()
private void	skipWhitespace()
private void	unread(int character)
private void	unreadBuffer(StringBuilder stringBuilder) pushes buffer back into input

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

Field Detail

BIB_DESK_ROOT_GROUP_NAME	back to summary
private static final String BIB_DESK_ROOT_GROUP_NAME

bibDeskGroupTreeNode	back to summary
private GroupTreeNode bibDeskGroupTreeNode

column	back to summary
private int column

CONFLICT_MARKER_LENGTH	back to summary
private static final int CONFLICT_MARKER_LENGTH Git writes conflict markers as seven characters at the start of a line, but a botched merge can produce longer runs (https://github.com/JabRef/jabref/issues/9167).

conflictMarkerCharacter	back to summary
private char conflictMarkerCharacter `0` while the current line does not start with a run of conflict marker characters

database	back to summary
private BibDatabase database

DOCUMENT_BUILDER_FACTORY	back to summary
private static final DocumentBuilderFactory DOCUMENT_BUILDER_FACTORY

entryTypes	back to summary
private Set<BibEntryType> entryTypes

eof	back to summary
private boolean eof

EPILOG_PATTERN	back to summary
private static final Pattern EPILOG_PATTERN

highestColumns	back to summary
private final Deque<Integer> highestColumns

importFormatPreferences	back to summary
private final ImportFormatPreferences importFormatPreferences

INDEX_RELATIVE_PATH_IN_PLIST	back to summary
private static final int INDEX_RELATIVE_PATH_IN_PLIST

line	back to summary
private int line

LOGGER	back to summary
private static final Logger LOGGER

LOOKAHEAD	back to summary
private static final int LOOKAHEAD

metaDataParser	back to summary
private final MetaDataParser metaDataParser

parsedBibDeskGroups	back to summary
private final Map<String, String> parsedBibDeskGroups

parserResult	back to summary
private ParserResult parserResult

pureTextFromFile	back to summary
private final Deque<Character> pureTextFromFile

pushbackReader	back to summary
private PushbackReader pushbackReader

Constructor Detail

BibtexParser	back to summary
public BibtexParser(@NonNull ImportFormatPreferences importFormatPreferences, FileUpdateMonitor fileMonitor)

BibtexParser	back to summary
public BibtexParser(ImportFormatPreferences importFormatPreferences)

Method Detail

addBibDeskGroupEntriesToJabRefGroups	back to summary
private void addBibDeskGroupEntriesToJabRefGroups(Character keywordSeparator) Adds BibDesk group entries to the JabRef database

checkEpilog	back to summary
private void checkEpilog()

checkForConflictMarker back to summary

checkForConflictMarker	back to summary
private void checkForConflictMarker(int character) Detects a run of conflict marker characters at the start of a line. `column` still holds the column of the just-read character. The state is keyed on `column` (which `unread(int)` restores) instead of on a counter: lookahead reads a character, unreads it and reads it again, and each physical character must be counted once only. Only `<` and `>` are looked for. A line of `=` or `\|` also appears as a decorative rule in comments and field values, and looking for them buys nothing: the `=======` separator and the `\|\|\|\|\|\|\| base` line of a diff3 style conflict are always preceded by a `<<<<<<<` line, which is reported first anyway.

private void checkForConflictMarker(int character)

Detects a run of conflict marker characters at the start of a line. column still holds the column of the just-read character.

The state is keyed on column (which unread(int) restores) instead of on a counter: lookahead reads a character, unreads it and reads it again, and each physical character must be counted once only.

Only < and > are looked for. A line of = or | also appears as a decorative rule in comments and field values, and looking for them buys nothing: the ======= separator and the ||||||| base line of a diff3 style conflict are always preceded by a <<<<<<< line, which is reported first anyway.

consume	back to summary
private void consume(char expected) throws IOException

consume	back to summary
private void consume(Field field, char expected) throws IOException

consume	back to summary
private void consume(char firstOption, char secondOption) throws IOException

consumeUncritically	back to summary
private boolean consumeUncritically(char expected) throws IOException

createBibDeskGroupTree	back to summary
private void createBibDeskGroupTree(Character keywordSeparator)

determineNewLineSeparator	back to summary
private String determineNewLineSeparator() throws IOException

dumpTextReadSoFarToString	back to summary
private String dumpTextReadSoFarToString() Puts all text that has been read from the reader, including newlines, etc., since the last call of this method into a string. Removes the JabRef file header, if it is found Returns:String the text read so far

dumpTextReadSoFarToString

back to summary

private String dumpTextReadSoFarToString()

Puts all text that has been read from the reader, including newlines, etc., since the last call of this method into a string. Removes the JabRef file header, if it is found

Returns:String: the text read so far

fixKey	back to summary
private String fixKey() throws IOException Tries to restore the key Returns:String rest of key on success, otherwise empty string Exceptions IOException: on Reader-Error

fixKey

back to summary

private String fixKey() throws IOException

Tries to restore the key

Returns:String

rest of key on success, otherwise empty string

Exceptions

IOException:: on Reader-Error

getPureTextFromFile	back to summary
private String getPureTextFromFile()

getStringValues	back to summary
public Collection<BibtexString> getStringValues()

initializeParserResult	back to summary
private void initializeParserResult(String newLineSeparator)

isClosingBracketNext	back to summary
private boolean isClosingBracketNext()

isEntryStart	back to summary
private boolean isEntryStart() throws IOException

isEOFCharacter	back to summary
private boolean isEOFCharacter(int character)

isEscapeSymbol	back to summary
private boolean isEscapeSymbol(char character)

parse back to summary

parse	back to summary
public ParserResult parse(@NonNull Reader in) throws IOException Parses BibTeX data found when reading from reader. The reader will be consumed. Multiple calls to parse() return the same results Handling of encoding is done at `BibtexImporter`

public ParserResult parse(@NonNull Reader in) throws IOException

Parses BibTeX data found when reading from reader.

The reader will be consumed.

Multiple calls to parse() return the same results

Handling of encoding is done at BibtexImporter

parseAndAddEntry	back to summary
private void parseAndAddEntry(String type)

parseBibDeskComment	back to summary
private void parseBibDeskComment(String comment, Map<String, String> meta) throws ParseException Parses comment types found in BibDesk, to migrate BibDesk Static Groups to JabRef.

parseBibtexString	back to summary
private void parseBibtexString() throws IOException

parseBracketedFieldContent	back to summary
private StringBuilder parseBracketedFieldContent(boolean recoverAtEntryStart) throws IOException This is called if a field in the form of `field = {content}` is parsed. The global variable `character` contains `{`.

parseBracketedText	back to summary
private String parseBracketedText() throws IOException

parseDatabaseID	back to summary
private void parseDatabaseID() throws IOException

parseEntries

back to summary

public List<BibEntry> parseEntries(InputStream inputStream) throws ParseException

Implements org.jabref.logic.importer.Parser.parseEntries.

Annotations

@Override

parseEntry	back to summary
private BibEntry parseEntry(String entryType) throws IOException

parseField	back to summary
private void parseField(BibEntry entry) throws IOException

parseFieldContent	back to summary
private String parseFieldContent(Field field) throws IOException

parseFileContent	back to summary
private ParserResult parseFileContent() throws IOException

parseJabRefComment	back to summary
private void parseJabRefComment(Map<String, String> meta)

parseKey	back to summary
private String parseKey() throws IOException This method is used to parse the citation key of an entry.

parsePreamble	back to summary
private String parsePreamble() throws IOException

parseQuotedFieldExactly	back to summary
private StringBuilder parseQuotedFieldExactly() throws IOException

parseRemainingContent	back to summary
private void parseRemainingContent()

parseSingleEntry	back to summary
public Optional<BibEntry> parseSingleEntry(String bibtexString) throws ParseException

parseString	back to summary
private BibtexString parseString() throws IOException

parseTextToken	back to summary
private String parseTextToken() throws IOException This method is used to parse string labels, field names, entry type and numbers outside brackets.

peek	back to summary
private int peek() throws IOException

peekTwoCharacters	back to summary
private char[] peekTwoCharacters() throws IOException

purge

back to summary

private String purge(String context, String stringToPurge)

Purges the given stringToPurge (if it exists) from the given context

Returns:String: a stripped version of the context

purgeEOFCharacters

back to summary

private String purgeEOFCharacters(String input)

Removes all eof characters from a StringBuilder and returns a new String with the resulting content

Returns:String: a String without eof characters

read	back to summary
private int read() throws IOException

removeWhitespaces	back to summary
private StringBuilder removeWhitespaces(StringBuilder toRemove) returns a new `StringBuilder` which corresponds to `toRemove` without whitespaces

singleFromString back to summary

public static Optional<BibEntry> singleFromString(String bibtexString, ImportFormatPreferences importFormatPreferences) throws ParseException

Parses BibtexEntries from the given string and returns one entry found (or null if none found)

It is undetermined which entry is returned, so use this in case you know there is only one entry in the string.

Returns:Optional<BibEntry>: An Optional<BibEntry>. Optional.empty() if non was found or an error occurred.

skipAndRecordWhitespace	back to summary
private String skipAndRecordWhitespace(int character) throws IOException

skipOneNewline	back to summary
private void skipOneNewline() throws IOException

skipSpace	back to summary
private void skipSpace() throws IOException

skipWhitespace	back to summary
private void skipWhitespace() throws IOException

unread	back to summary
private void unread(int character) throws IOException

unreadBuffer

back to summary

private void unreadBuffer(StringBuilder stringBuilder) throws IOException

pushes buffer back into input

Exceptions

IOException:: can be thrown if buffer is bigger than LOOKAHEAD

public Class BibtexParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BibtexParser.ConflictMarkerFoundException

Constructor Summary

Constructor Detail