JabRef 5.15 · org.jabref.model.metadata.MetaData · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	BIBDESK_STATIC_FLAG
private final Map<EntryType, String>	citeKeyPatterns
private final ContentSelectors	contentSelectors
public static final String	DATABASE_TYPE
private String	defaultCiteKeyPattern
private String	defaultFileDirectory
private Charset	encoding
private boolean	encodingExplicitlySupplied
public static final String	ENTRYTYPE_FLAG
public static final char	ESCAPE_CHARACTER
private final EventBus	eventBus
public static final String	FILE_DIRECTORY
public static final String	FILE_DIRECTORY_LATEX
private final ObjectProperty<GroupTreeNode>	groupsRoot
private final com.tobiasdiez.easybind.optional.OptionalBinding<GroupTreeNode>	groupsRootBinding
public static final String	GROUPSTREE
public static final String	GROUPSTREE_LEGACY
private boolean	isEventPropagationEnabled
private boolean	isProtected
public static final String	KEYPATTERNDEFAULT
private final Map<String, Path>	laTexFileDirectory
private static final Logger	LOGGER
public static final String	META_FLAG
private BibDatabaseMode	mode
public static final String	PREFIX_KEYPATTERN
public static final String	PROTECTED_FLAG_META
public static final String	SAVE_ACTIONS
public static final String	SAVE_ORDER_CONFIG
private FieldFormatterCleanups	saveActions
private SaveOrder	saveOrder
public static final String	SELECTOR_META_PREFIX
public static final char	SEPARATOR_CHARACTER
public static final String	SEPARATOR_STRING
private final Map<String, List<String>>	unknownMetaData
private final Map<String, String>	userFileDirectory
public static final String	VERSION_DB_STRUCT
private String	versionDBStructure

Access	Constructor and Description
public	MetaData() Constructs an empty metadata.

Method Summary

Modifier and Type	Method and Description
public void	addContentSelector(ContentSelector contentSelector)
public void	clearContentSelectors(Field field)
public void	clearDefaultFileDirectory()
public void	clearLatexFileDirectory(String user)
public void	clearSaveActions()
public void	clearSaveOrder()
public void	clearUserFileDirectory(String user)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public AbstractCitationKeyPatterns	Returns: the stored label patterns getCiteKeyPatterns(GlobalCitationKeyPatterns globalPatterns)
public ContentSelectors	getContentSelectors()
public SortedSet<ContentSelector>	getContentSelectorsSorted()
public List<String>	getContentSelectorValuesForField(Field field)
public Optional<String>	getDefaultCiteKeyPattern()
public Optional<String>	getDefaultFileDirectory()
public Optional<Charset>	getEncoding() Returns the encoding used during parsing.
public boolean	getEncodingExplicitlySupplied()
public Optional<GroupTreeNode>	getGroups()
public Map<String, Path>	getLatexFileDirectories()
public Optional<Path>	getLatexFileDirectory(String user)
public Optional<BibDatabaseMode>	getMode()
public Optional<FieldFormatterCleanups>	getSaveActions()
public Optional<SaveOrder>	getSaveOrder()
public Map<String, List<String>>	getUnknownMetaData()
public Map<String, String>	getUserFileDirectories()
public Optional<String>	getUserFileDirectory(String user)
public Optional<String>	getVersionDBStructure()
public com.tobiasdiez.easybind.optional.OptionalBinding<GroupTreeNode>	groupsBinding()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty()
public boolean	isProtected()
public void	markAsNotProtected()
public void	markAsProtected()
private void	postChange() Posts a new `MetaDataChangedEvent` on the `EventBus`.
public void	putUnknownMetaDataItem(String key, List<String> value)
public void	registerListener(Object listener)
public void	setCiteKeyPattern(AbstractCitationKeyPatterns the key patterns to update to. A reference to this object is stored internally and is returned at getCiteKeyPattern(); bibtexKeyPatterns) Updates the stored key patterns to the given key patterns.
public void	setCiteKeyPattern(CitationKeyPattern defaultValue, Map<EntryType, CitationKeyPattern> nonDefaultPatterns)
public void	setDefaultFileDirectory(String path)
public void	setEncoding(Charset encoding)
public void	setEncoding(Charset encoding, ChangePropagation postChanges) This method (with additional parameter) has been introduced to avoid event loops while saving a database.
public void	setEncodingExplicitlySupplied(boolean encodingExplicitlySupplied) Sets the indication whether the encoding was set using "% Encoding: ..." or whether it was detected "magically"
public void	setEventPropagation(boolean enabled) If disabled `MetaDataChangedEvent` will not be posted.
public void	setGroups(GroupTreeNode root) Sets a new group root node Warning This invalidates everything returned by getGroups() so far!!!
public void	setLatexFileDirectory(String user, Path path)
public void	setMode(BibDatabaseMode mode)
public void	setSaveActions(FieldFormatterCleanups saveActions)
public void	setSaveOrder(SaveOrder saveOrder)
public void	setUserFileDirectory(String user, String path)
public void	setVersionDBStructure(String version)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	unregisterListener(Object listener)

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

Field Detail

BIBDESK_STATIC_FLAG	back to summary
public static final String BIBDESK_STATIC_FLAG

citeKeyPatterns	back to summary
private final Map<EntryType, String> citeKeyPatterns

contentSelectors	back to summary
private final ContentSelectors contentSelectors

DATABASE_TYPE	back to summary
public static final String DATABASE_TYPE

defaultCiteKeyPattern	back to summary
private String defaultCiteKeyPattern

defaultFileDirectory	back to summary
private String defaultFileDirectory

encoding	back to summary
private Charset encoding

encodingExplicitlySupplied	back to summary
private boolean encodingExplicitlySupplied

ENTRYTYPE_FLAG	back to summary
public static final String ENTRYTYPE_FLAG

ESCAPE_CHARACTER	back to summary
public static final char ESCAPE_CHARACTER

eventBus	back to summary
private final EventBus eventBus

FILE_DIRECTORY	back to summary
public static final String FILE_DIRECTORY

FILE_DIRECTORY_LATEX	back to summary
public static final String FILE_DIRECTORY_LATEX

groupsRoot	back to summary
private final ObjectProperty<GroupTreeNode> groupsRoot

groupsRootBinding	back to summary
private final com.tobiasdiez.easybind.optional.OptionalBinding<GroupTreeNode> groupsRootBinding

GROUPSTREE	back to summary
public static final String GROUPSTREE

GROUPSTREE_LEGACY	back to summary
public static final String GROUPSTREE_LEGACY

isEventPropagationEnabled	back to summary
private boolean isEventPropagationEnabled

isProtected	back to summary
private boolean isProtected

KEYPATTERNDEFAULT	back to summary
public static final String KEYPATTERNDEFAULT

laTexFileDirectory	back to summary
private final Map<String, Path> laTexFileDirectory

LOGGER	back to summary
private static final Logger LOGGER

META_FLAG	back to summary
public static final String META_FLAG

mode	back to summary
private BibDatabaseMode mode

PREFIX_KEYPATTERN	back to summary
public static final String PREFIX_KEYPATTERN

PROTECTED_FLAG_META	back to summary
public static final String PROTECTED_FLAG_META

SAVE_ACTIONS	back to summary
public static final String SAVE_ACTIONS

SAVE_ORDER_CONFIG	back to summary
public static final String SAVE_ORDER_CONFIG

saveActions	back to summary
private FieldFormatterCleanups saveActions

saveOrder	back to summary
private SaveOrder saveOrder

SELECTOR_META_PREFIX	back to summary
public static final String SELECTOR_META_PREFIX

SEPARATOR_CHARACTER	back to summary
public static final char SEPARATOR_CHARACTER

SEPARATOR_STRING	back to summary
public static final String SEPARATOR_STRING

unknownMetaData	back to summary
private final Map<String, List<String>> unknownMetaData

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

VERSION_DB_STRUCT	back to summary
public static final String VERSION_DB_STRUCT

versionDBStructure	back to summary
private String versionDBStructure

Constructor Detail

MetaData	back to summary
public MetaData() Constructs an empty metadata.

Method Detail

addContentSelector	back to summary
public void addContentSelector(ContentSelector contentSelector)

clearContentSelectors	back to summary
public void clearContentSelectors(Field field)

clearDefaultFileDirectory	back to summary
public void clearDefaultFileDirectory()

clearLatexFileDirectory	back to summary
public void clearLatexFileDirectory(String user)

clearSaveActions	back to summary
public void clearSaveActions()

clearSaveOrder	back to summary
public void clearSaveOrder()

clearUserFileDirectory	back to summary
public void clearUserFileDirectory(String user)

equals back to summary

equals	back to summary
public boolean equals(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. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(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.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCiteKeyPatterns	back to summary
public AbstractCitationKeyPatterns getCiteKeyPatterns(GlobalCitationKeyPatterns globalPatterns) Returns:AbstractCitationKeyPatterns the stored label patterns

getContentSelectors	back to summary
public ContentSelectors getContentSelectors()

getContentSelectorsSorted	back to summary
public SortedSet<ContentSelector> getContentSelectorsSorted()

getContentSelectorValuesForField	back to summary
public List<String> getContentSelectorValuesForField(Field field)

getDefaultCiteKeyPattern	back to summary
public Optional<String> getDefaultCiteKeyPattern()

getDefaultFileDirectory	back to summary
public Optional<String> getDefaultFileDirectory()

getEncoding	back to summary
public Optional<Charset> getEncoding() Returns the encoding used during parsing.

getEncodingExplicitlySupplied	back to summary
public boolean getEncodingExplicitlySupplied()

getGroups	back to summary
public Optional<GroupTreeNode> getGroups()

getLatexFileDirectories	back to summary
public Map<String, Path> getLatexFileDirectories()

getLatexFileDirectory	back to summary
public Optional<Path> getLatexFileDirectory(String user)

getMode	back to summary
public Optional<BibDatabaseMode> getMode()

getSaveActions	back to summary
public Optional<FieldFormatterCleanups> getSaveActions()

getSaveOrder	back to summary
public Optional<SaveOrder> getSaveOrder()

getUnknownMetaData	back to summary
public Map<String, List<String>> getUnknownMetaData()

getUserFileDirectories	back to summary
public Map<String, String> getUserFileDirectories()

getUserFileDirectory	back to summary
public Optional<String> getUserFileDirectory(String user)

getVersionDBStructure	back to summary
public Optional<String> getVersionDBStructure()

groupsBinding	back to summary
public com.tobiasdiez.easybind.optional.OptionalBinding<GroupTreeNode> groupsBinding()

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.

Returns:int

a hash code value for this object

Annotations

@Override

isEmpty	back to summary
public boolean isEmpty()

isProtected	back to summary
public boolean isProtected()

markAsNotProtected	back to summary
public void markAsNotProtected()

markAsProtected	back to summary
public void markAsProtected()

postChange	back to summary
private void postChange() Posts a new `MetaDataChangedEvent` on the `EventBus`.

putUnknownMetaDataItem	back to summary
public void putUnknownMetaDataItem(String key, List<String> value)

registerListener	back to summary
public void registerListener(Object listener)

setCiteKeyPattern

back to summary

public void setCiteKeyPattern(AbstractCitationKeyPatterns bibtexKeyPatterns)

Updates the stored key patterns to the given key patterns.

Parameters

bibtexKeyPatterns:AbstractCitationKeyPatterns: the key patterns to update to.
A reference to this object is stored internally and is returned at getCiteKeyPattern();

setCiteKeyPattern	back to summary
public void setCiteKeyPattern(CitationKeyPattern defaultValue, Map<EntryType, CitationKeyPattern> nonDefaultPatterns)

setDefaultFileDirectory	back to summary
public void setDefaultFileDirectory(String path)

setEncoding	back to summary
public void setEncoding(Charset encoding)

setEncoding	back to summary
public void setEncoding(Charset encoding, ChangePropagation postChanges) This method (with additional parameter) has been introduced to avoid event loops while saving a database.

setEncodingExplicitlySupplied	back to summary
public void setEncodingExplicitlySupplied(boolean encodingExplicitlySupplied) Sets the indication whether the encoding was set using "% Encoding: ..." or whether it was detected "magically"

setEventPropagation	back to summary
public void setEventPropagation(boolean enabled) If disabled `MetaDataChangedEvent` will not be posted.

setGroups	back to summary
public void setGroups(GroupTreeNode root) Sets a new group root node Warning This invalidates everything returned by getGroups() so far!!!

setLatexFileDirectory	back to summary
public void setLatexFileDirectory(String user, Path path)

setMode	back to summary
public void setMode(BibDatabaseMode mode)

setSaveActions	back to summary
public void setSaveActions(FieldFormatterCleanups saveActions)

setSaveOrder	back to summary
public void setSaveOrder(SaveOrder saveOrder)

setUserFileDirectory	back to summary
public void setUserFileDirectory(String user, String path)

setVersionDBStructure	back to summary
public void setVersionDBStructure(String version)

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.

Returns:String

a string representation of the object

Annotations

@Override

unregisterListener	back to summary
public void unregisterListener(Object listener)

public Class MetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail