JabRef 6.0-beta.1 · org.jabref.model.metadata.MetaData

Modifier and Type	Field and Description
public static final String	AI_LIBRARY_ID
private @Nullable String	aiLibraryId
public static final String	BIBDESK_STATIC_FLAG
public static final String	BLG_FILE_PATH
private final Map<String, Path>	blgFilePathMap
private final Map<EntryType, String>	citeKeyPatterns
private boolean	containsSearchGroups
private final @NonNull ContentSelectors	contentSelectors
public static final String	DATABASE_TYPE
private @Nullable String	defaultCiteKeyPattern
private @Nullable Charset	encoding
private boolean	encodingExplicitlySupplied
public static final String	ENTRYTYPE_FLAG
public static final String	ENTRYTYPE_FLAG_V2
public static final char	ESCAPE_CHARACTER
private final EventBus	eventBus
public static final String	FILE_DIRECTORY
public static final String	FILE_DIRECTORY_LATEX
public static final String	GIT_AUTO_COMMIT
public static final String	GIT_AUTO_PULL
public static final String	GIT_AUTO_PUSH
private boolean	gitAutoCommit
private boolean	gitAutoPull
private boolean	gitAutoPush
public static final String	GROUPS_SEARCH_SYNTAX_VERSION
private Optional<Version>	groupSearchSyntaxVersion
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
public static final String	KEYWORD_SEPARATOR
private @Nullable Character	keywordSeparator
private final Map<String, String>	latexFileDirectory
public static final String	LIBRARY_ABBREVIATION_TYPE
private @Nullable AbbreviationType	libraryAbbreviationType
private @Nullable String	librarySpecificFileDirectory
public static final String	META_FLAG
private @Nullable 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 @Nullable FieldFormatterCleanupActions	saveActions
private @Nullable 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 @Nullable String	versionDBStructure

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

Method Summary

Modifier and Type	Method and Description
public void	addContentSelector(@NonNull ContentSelector contentSelector)
public void	clearBlgFilePath(String user)
public void	clearContentSelectors(@NonNull Field field)
public void	clearGroups() Removes the group tree, so that the library has no groups at all — the state it is in before the first group is created.
public void	clearGroups(MetaDataChangeSource source) Removes the group tree, reporting who is behind the change — see `setGroups(GroupTreeNode, MetaDataChangeSource)`.
public void	clearKeywordSeparator()
public void	clearLatexFileDirectory(String userHostString)
public void	clearLibraryAbbreviationType()
public void	clearLibrarySpecificFileDirectory()
public void	clearSaveActions()
public void	clearSaveOrder()
public void	clearUserFileDirectory(String user)
public boolean	containsSearchGroups()
public static MetaData	copyOf(@NonNull MetaData other) A detached copy of `other` with new identity and without listeners.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Optional<String>	getAiLibraryId()
public Optional<Path>	getBlgFilePath(String user)
public Map<String, Path>	getBlgFilePaths()
public AbstractCitationKeyPatterns	getCiteKeyPatterns(@NonNull GlobalCitationKeyPatterns globalPatterns) Returns: the stored label patterns
public @NonNull ContentSelectors	getContentSelectors()
public @NonNull SortedSet<@NonNull ContentSelector>	getContentSelectorsSorted()
public @NonNull List<@NonNull String>	getContentSelectorValuesForField(Field field)
public Optional<String>	getDefaultCiteKeyPattern()
public Optional<Charset>	getEncoding() Returns the encoding used during parsing.
public boolean	getEncodingExplicitlySupplied()
public Optional<GroupTreeNode>	getGroups()
public Optional<Version>	getGroupSearchSyntaxVersion()
public Optional<Character>	getKeywordSeparator() The separator used in this library's keyword fields; absent if the library does not declare one (then the global preference applies)
public Map<String, String>	getLatexFileDirectories()
public Optional<Path>	getLatexFileDirectory(String userHostString)
public Optional<AbbreviationType>	getLibraryAbbreviationType()
public Optional<String>	getLibrarySpecificFileDirectory()
public Optional<BibDatabaseMode>	getMode()
public Optional<FieldFormatterCleanupActions>	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	isGitAutoCommit()
public boolean	isGitAutoPull()
public boolean	isGitAutoPush()
public boolean	isProtected()
public void	markAsNotProtected()
public void	markAsProtected()
public void	overwriteWith(@NonNull MetaData other) Overwrites this instance's contents with those of `other`.
public void	overwriteWith(@NonNull MetaData other, MetaDataChangeSource source) Overwrites this instance's contents with those of `other`, reporting who is behind the change.
private void	postChange() Posts a new `MetaDataChangedEvent` on the `EventBus`.
private void	postChange(MetaDataChangeSource source) Every setter reports `MetaDataChangeSource#LOCAL`; the two doors a recorded change goes through — `setGroups(GroupTreeNode, MetaDataChangeSource)` and `overwriteWith(MetaData, MetaDataChangeSource)` — say so instead.
public void	putUnknownMetaDataItem(@NonNull String key, @NonNull List<String> value)
public void	registerListener(Object listener)
public void	setAiLibraryId(@NonNull String id)
public void	setBlgFilePath(@NonNull String user, @NonNull Path path)
public void	setCiteKeyPattern(@NonNull 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	setContainsSearchGroups(boolean containsSearchGroups)
public void	setEncoding(Charset encoding)
public void	setEncoding(@NonNull 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	setGitAutoCommit(boolean gitAutoCommit)
public void	setGitAutoPull(boolean gitAutoPull)
public void	setGitAutoPush(boolean gitAutoPush)
public void	setGroups(@NonNull GroupTreeNode root) Sets a new group root node.
public void	setGroups(@NonNull GroupTreeNode root, MetaDataChangeSource source) Sets a new group root node, reporting who is behind the change.
public void	setGroupSearchSyntaxVersion(Version version)
public void	setKeywordSeparator(@NonNull Character keywordSeparator)
public void	setLatexFileDirectory(@NonNull String userHostString, @NonNull String path)
public void	setLibraryAbbreviationType(@NonNull AbbreviationType type)
public void	setLibrarySpecificFileDirectory(@NonNull String path)
public void	setMode(@NonNull BibDatabaseMode mode)
public void	setSaveActions(@NonNull FieldFormatterCleanupActions saveActions)
public void	setSaveOrder(SaveOrder saveOrder)
public void	setUserFileDirectory(@NonNull String user, @NonNull String path)
public void	setVersionDBStructure(@NonNull 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

public Class MetaData

Field Summary

Constructor Summary

Method Summary