JabRef 6.0-beta.1 · org.jabref.model.database.BibDatabaseContext

Modifier and Type	Field and Description
private final BibDatabase	database
private @Nullable CoarseChangeFilter	dbmsListener
private @Nullable DatabaseSynchronizer	dbmsSynchronizer
private DatabaseLocation	location
private static final Logger	LOGGER
private final MetaData	metaData
private @Nullable Path	path The path where this database was last saved to.
private final String	uid Generate a random UID for unique of the concrete context In contrast to hashCode this stays unique

Access	Constructor and Description
public	BibDatabaseContext()
public	BibDatabaseContext(BibDatabase database)
public	BibDatabaseContext(BibDatabase database, MetaData metaData)
public	BibDatabaseContext(BibDatabase database, MetaData metaData, @Nullable Path path)
public	BibDatabaseContext(BibDatabase database, MetaData metaData, @Nullable Path path, DatabaseLocation location)

Method Summary

Modifier and Type	Method and Description
public void	clearDatabasePath()
public void	clearDBMSSynchronizer()
public void	convertToLocalDatabase()
public void	convertToSharedDatabase(DatabaseSynchronizer dbmsSynchronizer)
public static BibDatabaseContext	empty()
public boolean	equals(@Nullable Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public FileDirectories	Returns: fixed-size record containing absolute paths (if configured) getAllFileDirectories(FilePreferences The file directory preferences preferences) Look up all configured file directories of this database.
public BibDatabase	getDatabase()
public Optional<Path>	getDatabaseDirectory()
public Optional<Path>	Returns: Optional of the relevant Path, or Optional.empty() if none is defined. getDatabasePath() Get the path where this database was last saved to or loaded from, if any.
public @Nullable DatabaseSynchronizer	getDBMSSynchronizer()
public List<BibEntry>	getEntries()
public List<Path>	Returns: List of existing absolute paths getFileDirectories(FilePreferences The fileDirectory preferences preferences) Look up the directories set up for this database.
private Path	getFileDirectoryPath(String directory) Returns: The absolute path for the given directory
public Optional<Path>	Returns: the path - or an empty optional, if none of the directories exists getFirstExistingFileDir(FilePreferences preferences) Returns the first existing file directory from `getFileDirectories(FilePreferences)`
public Path	getFulltextIndexPath() Returns: The path to store the lucene index files.
public Character	getKeywordSeparator(Character fallbackKeywordSeparator) The keyword separator of this library, falling back to the given separator (typically the global preference) when the library does not declare one
public Optional<String>	getLibraryId() The id used to address this library from the outside: the REST API (`/libraries/{id}/...`
public DatabaseLocation	getLocation()
public MetaData	getMetaData()
public BibDatabaseMode	getMode()
public String	Returns: The generated UID in UUIDv4 format with the prefix bibdatabasecontext_ getUid() Get the generated UID for the current context.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isBiblatexMode()
public boolean	isStudy() Returns whether this .bib file belongs to a `org.jabref.model.study.Study`
public static BibDatabaseContext	of(Reader bibContentReader, ImportFormatPreferences importFormatPreferences)
public static BibDatabaseContext	of(String bibContent, ImportFormatPreferences importFormatPreferences)
public static BibDatabaseContext	of(InputStream bibContentStream, ImportFormatPreferences importFormatPreferences)
public void	setDatabasePath(@Nullable Path file)
public void	setMode(BibDatabaseMode bibDatabaseMode)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

database	back to summary
private final BibDatabase database

dbmsListener	back to summary
private @Nullable CoarseChangeFilter dbmsListener

dbmsSynchronizer	back to summary
private @Nullable DatabaseSynchronizer dbmsSynchronizer

location	back to summary
private DatabaseLocation location

LOGGER	back to summary
private static final Logger LOGGER

path	back to summary
private @Nullable Path path The path where this database was last saved to.

uid	back to summary
private final String uid Generate a random UID for unique of the concrete context In contrast to hashCode this stays unique

BibDatabaseContext	back to summary
public BibDatabaseContext()

BibDatabaseContext	back to summary
public BibDatabaseContext(BibDatabase database)

Method Detail

clearDatabasePath	back to summary
public void clearDatabasePath()

clearDBMSSynchronizer	back to summary
public void clearDBMSSynchronizer()

convertToLocalDatabase	back to summary
public void convertToLocalDatabase()

convertToSharedDatabase	back to summary
public void convertToSharedDatabase(DatabaseSynchronizer dbmsSynchronizer)

empty	back to summary
public static BibDatabaseContext empty()

equals back to summary

equals	back to summary
public boolean equals(@Nullable Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(@Nullable Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getAllFileDirectories	back to summary
public FileDirectories getAllFileDirectories(FilePreferences preferences) Look up all configured file directories of this database. The returned record contains the following directories: user-specific directory library-specific directory BIB file directory or Main file directory (depending on preferences) Parameters preferences:FilePreferences The file directory preferences Returns:FileDirectories fixed-size record containing absolute paths (if configured)

getAllFileDirectories

back to summary

public FileDirectories getAllFileDirectories(FilePreferences preferences)

Look up all configured file directories of this database. The returned record contains the following directories:

user-specific directory
library-specific directory
BIB file directory or Main file directory (depending on preferences)

Parameters

preferences:FilePreferences: The file directory preferences

Returns:FileDirectories

fixed-size record containing absolute paths (if configured)

getDatabase	back to summary
public BibDatabase getDatabase()

getDatabaseDirectory	back to summary
public Optional<Path> getDatabaseDirectory()

getDatabasePath	back to summary
public Optional<Path> getDatabasePath() Get the path where this database was last saved to or loaded from, if any. Returns:Optional<Path> Optional of the relevant Path, or Optional.empty() if none is defined.

getDatabasePath

back to summary

public Optional<Path> getDatabasePath()

Get the path where this database was last saved to or loaded from, if any.

Returns:Optional<Path>: Optional of the relevant Path, or Optional.empty() if none is defined.

getDBMSSynchronizer	back to summary
public @Nullable DatabaseSynchronizer getDBMSSynchronizer()

getEntries	back to summary
public List<BibEntry> getEntries()

getFileDirectories	back to summary
public List<Path> getFileDirectories(FilePreferences preferences) Look up the directories set up for this database. There can be up to four directory definitions for these files: next to the .bib file. the preferences can specify a default one. the database's metadata can specify a library-specific directory. the database's metadata can specify a user-specific directory. The settings are prioritized in the following order, and the first defined setting is used: user-specific metadata directory general metadata directory BIB file directory (if configured in the preferences AND none of the two above directories are configured) preferences directory (if .bib file directory should not be used according to the (global) preferences) Parameters preferences:FilePreferences The fileDirectory preferences Returns:List<Path> List of existing absolute paths

getFileDirectories

back to summary

public List<Path> getFileDirectories(FilePreferences preferences)

Look up the directories set up for this database. There can be up to four directory definitions for these files:

next to the .bib file.
the preferences can specify a default one.
the database's metadata can specify a library-specific directory.
the database's metadata can specify a user-specific directory.

The settings are prioritized in the following order, and the first defined setting is used:

user-specific metadata directory
general metadata directory
BIB file directory (if configured in the preferences AND none of the two above directories are configured)
preferences directory (if .bib file directory should not be used according to the (global) preferences)

Parameters

preferences:FilePreferences: The fileDirectory preferences

Returns:List<Path>

List of existing absolute paths

getFileDirectoryPath	back to summary
private Path getFileDirectoryPath(String directory) Returns:Path The absolute path for the given directory

getFirstExistingFileDir back to summary

getFirstExistingFileDir	back to summary
public Optional<Path> getFirstExistingFileDir(FilePreferences preferences) Returns the first existing file directory from `getFileDirectories(FilePreferences)` Returns:Optional<Path> the path - or an empty optional, if none of the directories exists

public Optional<Path> getFirstExistingFileDir(FilePreferences preferences)

Returns the first existing file directory from getFileDirectories(FilePreferences)

Returns:Optional<Path>: the path - or an empty optional, if none of the directories exists

getFulltextIndexPath	back to summary
public Path getFulltextIndexPath() Returns:Path The path to store the lucene index files. One directory for each library.

getKeywordSeparator	back to summary
public Character getKeywordSeparator(Character fallbackKeywordSeparator) The keyword separator of this library, falling back to the given separator (typically the global preference) when the library does not declare one

getLibraryId	back to summary
public Optional<String> getLibraryId() The id used to address this library from the outside: the REST API (`/libraries/{id}/...`), cite-as-you-write (`libraryid=`), JabMap and in-app links (`jabref://libraries/{id}/entries/{key}`). Empty for libraries that have not been saved to disk yet.

getLocation	back to summary
public DatabaseLocation getLocation()

getMetaData	back to summary
public MetaData getMetaData()

getMode	back to summary
public BibDatabaseMode getMode()

getUid back to summary

getUid	back to summary
public String getUid() Get the generated UID for the current context. Can be used to distinguish contexts with changing metadata etc This is required, because of `hashCode()` implementation. Returns:String The generated UID in UUIDv4 format with the prefix bibdatabasecontext_

public String getUid()

Get the generated UID for the current context. Can be used to distinguish contexts with changing metadata etc

This is required, because of hashCode() implementation.

Returns:String: The generated UID in UUIDv4 format with the prefix bibdatabasecontext_

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Implementation Note This implementation needs to be consistent with equals. That means, as soon as a new entry is added to the database, two different instances of BibDatabaseContext are not equal - and thus, the hashCode also needs to change. This has the drawback, that one cannot create HashMaps from the BiDatabaseContext anymore, as the hashCode changes as soon as a new entry is added. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Implementation Note

This implementation needs to be consistent with equals. That means, as soon as a new entry is added to the database, two different instances of BibDatabaseContext are not equal - and thus, the hashCode also needs to change. This has the drawback, that one cannot create HashMaps from the BiDatabaseContext anymore, as the hashCode changes as soon as a new entry is added.

Annotations

@Override

isBiblatexMode	back to summary
public boolean isBiblatexMode()

isStudy	back to summary
public boolean isStudy() Returns whether this .bib file belongs to a `org.jabref.model.study.Study`

of	back to summary
public static BibDatabaseContext of(Reader bibContentReader, ImportFormatPreferences importFormatPreferences) throws JabRefException

of	back to summary
public static BibDatabaseContext of(String bibContent, ImportFormatPreferences importFormatPreferences) throws JabRefException

of	back to summary
public static BibDatabaseContext of(InputStream bibContentStream, ImportFormatPreferences importFormatPreferences) throws JabRefException

setDatabasePath	back to summary
public void setDatabasePath(@Nullable Path file)

setMode	back to summary
public void setMode(BibDatabaseMode bibDatabaseMode)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class BibDatabaseContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail