JabRef 6.0-beta.1 · org.jabref.model.entry.BibEntry · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	changed Marks whether the complete serialization, which was read from file, should be used.
private String	commentsBeforeEntry The part before the start of the entry
public static final EntryType	DEFAULT_TYPE
public static final String	ENTRY_LINK_SEPARATOR
private final EventBus	eventBus
private ObservableMap<Field, String>	fields
private final MultiKeyMap<StandardField, Character, KeywordList>	fieldsAsKeywords Cache that stores the field as keyword lists (format <Field, Separator, Keyword list>)
private final Map<Field, Set<String>>	fieldsAsWords Map to store the words in every field
private String	id
private final Map<Field, String>	latexFreeFields Cache that stores latex free versions of fields.
private static final Logger	LOGGER
private String	parsedSerialization Stores the text "rendering" of the entry as read by the BibTeX reader.
private final SharedBibEntryData	sharedBibEntryData
private final ObjectProperty<EntryType>	type

Access	Constructor and Description
public	BibEntry() Constructs a new BibEntry.
public	BibEntry(String citationKey)
public	BibEntry(EntryType type) Constructs a new BibEntry.
public	BibEntry(EntryType type, String citationKey)
public	BibEntry(BibEntry other) Returns a copy of this entry.

Method Summary

Modifier and Type	Method and Description
public Optional<FieldChange>	addFile(LinkedFile file)
public Optional<FieldChange>	addFile(int index, LinkedFile file)
public Optional<FieldChange>	addFiles(List<LinkedFile> filesToAdd)
public void	addKeyword(@NonNull String Keyword to add keyword, Character delimiter) Check if a keyword already exists (case insensitive), if not: add it
public void	addKeyword(Keyword keyword, Character delimiter)
public void	addKeywords(@NonNull Collection<String> Keywords to add keywords, Character delimiter) Add multiple keywords to entry
public boolean	Returns: true if all fields are set or could be resolved, false otherwise. allFieldsPresent(Collection<OrFields> An array of field names to be checked. fields, BibDatabase The database in which to look up crossref'd entries, if any. This argument can be null, meaning that no attempt will be made to follow crossrefs. database) Determines whether this entry has all the given fields present.
public Optional<FieldChange>	clearCitationKey()
public Optional<FieldChange>	clearField(Field The field to clear. field) Remove the mapping for the field name, and notify listeners about the change.
public Optional<FieldChange>	clearField(Field the field to clear. field, EntriesEventSource the source a new `FieldChangedEvent` should be posten from. eventSource) Remove the mapping for the field name, and notify listeners about the change including the `EntriesEventSource`.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private Optional<String>	Returns: determined field value genericGetFieldOrAlias(Field the field field, BiFunction<BibEntry, Field, Optional<String>> the method to get the value of a given field in a given entry getFieldValue) Internal method used to get the content of a field (or its alias) Used by `getFieldOrAlias(Field)` and `getFieldOrAliasLatexFree(Field)`
private Optional<String>	genericGetResolvedFieldOrAlias(Field field, @Nullable BibDatabase database, BiFunction<BibEntry, Field, Optional<String>> getFieldOrAlias)
public String	getAuthorTitleYear()
public String	Returns: A short textual description of the entry in the format: Author1, Author2: Title (Year) getAuthorTitleYear(int The maximum number of characters (additional characters are replaced by "..."). Set to 0 to disable truncation. maxCharacters) Creates a short textual description of the entry in the format: `Author1, Author2: Title (Year)` If `0` is passed as `maxCharacters`, the description is not truncated.
public @NonNull Optional<String>	getCitationKey() If not present, `BibEntry#getAuthorTitleYear(int)` can be used
public com.tobiasdiez.easybind.optional.OptionalBinding<String>	getCiteKeyBinding()
public SequencedSet<String>	Returns: List of citation keys; empty list if field is empty or not available. getCites() Checks `StandardField#CITES` for a list of citation keys and returns them.
public Optional<DOI>	getDOI()
public List<ParsedEntryLink>	getEntryLinkList(Field field, BibDatabase database)
public Optional<String>	getField(Field field) Returns the contents of the given field as an Optional.
public KeywordList	getFieldAsKeywords(Field field, Character keywordSeparator)
public Set<String>	getFieldAsWords(Field field)
public com.tobiasdiez.easybind.optional.OptionalBinding<String>	getFieldBinding(Field field)
public Optional<String>	getFieldLatexFree(Field field)
public Map<Field, String>	getFieldMap()
public Optional<String>	getFieldOrAlias(Field field) Returns the contents of the given field or its alias as an Optional The following aliases are considered (old bibtex <-> new biblatex) based on the biblatex documentation, chapter 2.2.5: address <-> location annote <-> annotation archiveprefix <-> eprinttype journal <-> journaltitle key <-> sortkey pdf <-> file primaryclass <-> eprintclass school <-> institution
public Optional<String>	Returns: the stored latex-free content of the field (or its alias) getFieldOrAliasLatexFree(Field the name of the field name) Return the LaTeX-free contents of the given field or its alias an Optional For details see also `getFieldOrAlias(Field)`
public SequencedSet<Field>	getFields() Returns an unmodifiable sequence containing the names of all fields that are set for this particular entry.
public SequencedSet<Field>	getFields(Predicate<Field> selector) Returns an unmodifiable sequence containing the names of all fields that are a) set for this particular entry and b) matching the given predicate
public ObservableMap<Field, String>	getFieldsObservable()
public Collection<String>	getFieldValues()
public List<LinkedFile>	Returns: the list of linked files, is never null but can be empty. Changes to the underlying list will have no effect on the entry itself. Use `addFile(LinkedFile)`. getFiles() Gets a list of linked files.
public String	getId() This id changes on each run of JabRef (because it is currently generated as increasing number).
public Optional<ISBN>	getISBN()
public String	getKeyAuthorTitleYear()
public String	getKeyAuthorTitleYear(int maxCharacters)
public KeywordList	getKeywords(Character delimiter)
public Optional<Month>	getMonth()
public Observable[]	getObservables() Returns a list of observables that represent the data of the entry.
public String	getParsedSerialization()
public Optional<Date>	Returns: will return the publication date of the entry or null if no year was found. getPublicationDate() Will return the publication date of the given bibtex entry conforming to ISO 8601, i.e. either YYYY or YYYY-MM.
public Optional<String>	getResolvedFieldOrAlias(OrFields fields, BibDatabase database)
public Optional<String>	Returns: The resolved field value or null if not found. getResolvedFieldOrAlias(Field The field to return the value of. field, @Nullable BibDatabase The database of the bibtex entry. database) Returns the text stored in the given field of the given bibtex entry which belongs to the given database.
public Optional<String>	getResolvedFieldOrAliasLatexFree(Field field, @Nullable BibDatabase database)
public KeywordList	getResolvedKeywords(Character delimiter, BibDatabase database)
public SharedBibEntryData	getSharedBibEntryData()
private Optional<Field>	Returns: the mapped field or null if there is no valid mapping available getSourceField(Field field name of the BibEntry targetField, EntryType type of the BibEntry targetEntry, EntryType type of the cross-referenced BibEntry sourceEntry) Map an (empty) field of a BibEntry to a field of a cross-referenced entry.
public @NonNull String	Returns: String representation - empty string in case of an error (to ease calling) getStringRepresentation(BibEntry entry, BibDatabaseMode type, BibEntryTypesManager entryTypesManager, FieldPreferences fieldPreferences) Uses `\n` as newline separator Method similar to `org.jabref.gui.entryeditor.SourceTab#getSourceString(BibEntry, BibDatabaseMode, FieldPreferences)`
public Optional<String>	Returns: an Optional containing the title of a BibTeX entry in case it exists, otherwise return an empty Optional. getTitle() Returns the title of the given BibTeX entry as an Optional.
public EntryType	getType() Returns this entry's type.
public String	getUserComments()
public Optional<Season>	getYearDivision()
public boolean	hasChanged()
public boolean	hasCitationKey()
public boolean	hasField(Field field) Returns true if the entry has the given field, or false if it is not set.
public Boolean	Returns: true if the entry contains the file hasFile(LinkedFile the file that is checked if it's in the entry or not file) Checks if the BibEntry contains the linked file
public int	hashCode() Overrides java.lang.Object.hashCode. On purpose, this hashes the "content" of the BibEntry, not the `sharedBibEntryData`.
private void	invalidateFieldCache(Field field)
public boolean	isEmpty()
public void	mergeWith(BibEntry another BibEntry from which fields are sourced from other) Merge this entry's fields with another BibEntry.
public void	mergeWith(BibEntry another BibEntry from which fields are sourced from other, Set<Field> collection of Fields in which 'other' has a priority into final result otherPrioritizedFields) Merge this entry's fields with another BibEntry.
public Optional<FieldChange>	putKeywords(List<String> keywords, @NonNull Character delimiter)
public Optional<FieldChange>	putKeywords(@NonNull KeywordList keywords, Character delimiter)
public void	registerListener(Object object)
public Optional<FieldChange>	removeKeywords(KeywordList keywordsToRemove, Character keywordDelimiter)
public void	replaceDownloadedFile(String the link to the file, which was downloaded linkToDownloadedFile, LinkedFile the path to be added to the entry downloadedFile) Helper method to add a downloaded file to the entry.
public Optional<FieldChange>	replaceKeywords(KeywordList keywordsToReplace, Keyword newValue, Character keywordDelimiter)
public void	setChanged(boolean changed)
public Optional<FieldChange>	setCitationKey(String The cite key to set. Must not be null; use `clearCitationKey()` to remove the cite key. newKey) Sets the citation key.
public Optional<FieldChange>	setCites(SequencedSet<String> keys)
public void	setCommentsBeforeEntry(String parsedComments)
public void	setDate(Date date)
public Optional<FieldChange>	setEntryLinkList(Field field, List<ParsedEntryLink> list)
public void	setField(@NonNull Map<Field, String> fields) Sets a number of fields simultaneously.
public Optional<FieldChange>	setField(@NonNull Field The field to set field, @Nullable String The value to set - "null" for clear. Useful for cleaner code at fetchers. value, @NonNull EntriesEventSource Source the event is sent from eventSource) Set a field, and notify listeners about the change.
public Optional<FieldChange>	setField(Field The field to set. field, @Nullable String The value to set - "null" for clear. Useful for cleaner code at fetchers. value) Set a field, and notify listeners about the change.
public Optional<FieldChange>	setFiles(List<LinkedFile> files)
public void	setId(@NonNull String The ID to be used id) Sets this entry's identifier (ID).
public Optional<FieldChange>	setLangid(Langid parsedLangid)
public Optional<FieldChange>	setMonth(Month parsedMonth)
public void	setParsedSerialization(String parsedSerialization)
public Optional<FieldChange>	setType(EntryType type) Sets this entry's type.
public Optional<FieldChange>	setType(@NonNull EntryType newType, EntriesEventSource eventSource) Sets this entry's type and sets the changed flag to true If the new entry type equals the old entry type no changed flag is set.
public String	Returns: A user-readable string NOT A VALID BibTeX string toString() Overrides java.lang.Object.toString. Serializes all fields, even the JabRef internal ones.
public void	trimLeft() Trims whitespaces at the beginning of the BibEntry
public ObjectProperty<EntryType>	typeProperty()
public void	unregisterListener(Object object)
public BibEntry	withChanged(boolean changed) Required to trigger new serialization of the entry.
public BibEntry	withCitationKey(String newKey)
public BibEntry	withDate(Date date)
public BibEntry	withField(Field field, String value)
public BibEntry	withFields(Map<Field, String> content) A copy is made of the parameter
public BibEntry	withFiles(List<LinkedFile> files)
public BibEntry	withMonth(Month parsedMonth)
public BibEntry	withUserComments(String commentsBeforeEntry)

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

public Class BibEntry

Field Summary

Constructor Summary

Method Summary