-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable Merging of BibDatabases (#6689)
* Clean up commit and remove unwanted changes. Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com> * Move Merger and DuplicateCheck into database package Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com> * Move meta data merging into DatabaseMerger Add DatabaseContext merging capability to DatabaseMerger Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com> * Add one meta data merge test (unfinished) Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com> * Add meta data merging tests. Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com> * Reduce test example Signed-off-by: Dominik Voigt <dominik.ingo.voigt@gmail.com>
- Loading branch information
1 parent
5ab494e
commit 35f5078
Showing
11 changed files
with
340 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
src/main/java/org/jabref/logic/database/DatabaseMerger.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| package org.jabref.logic.database; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.jabref.model.database.BibDatabase; | ||
| import org.jabref.model.database.BibDatabaseContext; | ||
| import org.jabref.model.database.BibDatabaseModeDetection; | ||
| import org.jabref.model.entry.BibEntry; | ||
| import org.jabref.model.entry.BibEntryTypesManager; | ||
| import org.jabref.model.entry.BibtexString; | ||
| import org.jabref.model.groups.AllEntriesGroup; | ||
| import org.jabref.model.groups.ExplicitGroup; | ||
| import org.jabref.model.groups.GroupHierarchyType; | ||
| import org.jabref.model.metadata.ContentSelector; | ||
| import org.jabref.model.metadata.MetaData; | ||
| import org.jabref.preferences.JabRefPreferences; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class DatabaseMerger { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(DatabaseMerger.class); | ||
|
|
||
| /** | ||
| * Merges all entries and strings of the other database into the target database. Any duplicates are ignored. | ||
| * In case a string has a different content, it is added with a new unique name. | ||
| * The unique name is generated by suffix "_i", where i runs from 1 onwards. | ||
| * | ||
| * @param other The other databases that is merged into this database | ||
| */ | ||
| public synchronized void merge(BibDatabase target, BibDatabase other) { | ||
| mergeEntries(target, other); | ||
| mergeStrings(target, other); | ||
| } | ||
|
|
||
| /** | ||
| * Merges all entries, strings, and metaData of the other database context into the target database context. Any duplicates are ignored. | ||
| * In case a string has a different content, it is added with a new unique name. | ||
| * The unique name is generated by suffix "_i", where i runs from 1 onwards. | ||
| * | ||
| * @param other The other databases that is merged into this database | ||
| */ | ||
| public synchronized void merge(BibDatabaseContext target, BibDatabaseContext other, String otherFileName) { | ||
| mergeEntries(target.getDatabase(), other.getDatabase()); | ||
| mergeStrings(target.getDatabase(), other.getDatabase()); | ||
| mergeMetaData(target.getMetaData(), other.getMetaData(), otherFileName, other.getEntries()); | ||
| } | ||
|
|
||
| private void mergeEntries(BibDatabase target, BibDatabase other) { | ||
| DuplicateCheck duplicateCheck = new DuplicateCheck(new BibEntryTypesManager()); | ||
| List<BibEntry> newEntries = other.getEntries().stream() | ||
| // Remove all entries that are already part of the database (duplicate) | ||
| .filter(entry -> duplicateCheck.containsDuplicate(target, entry, BibDatabaseModeDetection.inferMode(target)).isEmpty()) | ||
| .collect(Collectors.toList()); | ||
| target.insertEntries(newEntries); | ||
| } | ||
|
|
||
| public void mergeStrings(BibDatabase target, BibDatabase other) { | ||
| for (BibtexString bibtexString : other.getStringValues()) { | ||
| String bibtexStringName = bibtexString.getName(); | ||
| if (target.hasStringByName(bibtexStringName)) { | ||
| String importedContent = bibtexString.getContent(); | ||
| String existingContent = target.getStringByName(bibtexStringName).get().getContent(); | ||
| if (!importedContent.equals(existingContent)) { | ||
| LOGGER.info("String contents differ for {}: {} != {}", bibtexStringName, importedContent, existingContent); | ||
| int suffix = 1; | ||
| String newName = bibtexStringName + "_" + suffix; | ||
| while (target.hasStringByName(newName)) { | ||
| suffix++; | ||
| newName = bibtexStringName + "_" + suffix; | ||
| } | ||
| BibtexString newBibtexString = new BibtexString(newName, importedContent); | ||
| // TODO undo/redo | ||
| target.addString(newBibtexString); | ||
| LOGGER.info("New string added: {} = {}", newBibtexString.getName(), newBibtexString.getContent()); | ||
| } | ||
| } else { | ||
| // TODO undo/redo | ||
| target.addString(bibtexString); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param target the metaData that is the merge target | ||
| * @param other the metaData to merge into the target | ||
| * @param otherFilename the filename of the other library. Pass "unknown" if not known. | ||
| */ | ||
| public void mergeMetaData(MetaData target, MetaData other, String otherFilename, List<BibEntry> allOtherEntries) { | ||
| Objects.requireNonNull(other); | ||
| Objects.requireNonNull(otherFilename); | ||
| Objects.requireNonNull(allOtherEntries); | ||
|
|
||
| mergeGroups(target, other, otherFilename, allOtherEntries); | ||
| mergeContentSelectors(target, other); | ||
| } | ||
|
|
||
| private void mergeGroups(MetaData target, MetaData other, String otherFilename, List<BibEntry> allOtherEntries) { | ||
| // Adds the specified node as a child of the current root. The group contained in <b>newGroups</b> must not be of | ||
| // type AllEntriesGroup, since every tree has exactly one AllEntriesGroup (its root). The <b>newGroups</b> are | ||
| // inserted directly, i.e. they are not deepCopy()'d. | ||
| other.getGroups().ifPresent(newGroups -> { | ||
| // ensure that there is always only one AllEntriesGroup in the resulting database | ||
| // "Rename" the AllEntriesGroup of the imported database to "Imported" | ||
| if (newGroups.getGroup() instanceof AllEntriesGroup) { | ||
| // create a dummy group | ||
| try { | ||
| // This will cause a bug if the group already exists | ||
| // There will be group where the two groups are merged | ||
| String newGroupName = otherFilename; | ||
| ExplicitGroup group = new ExplicitGroup("Imported " + newGroupName, GroupHierarchyType.INDEPENDENT, | ||
| JabRefPreferences.getInstance().getKeywordDelimiter()); | ||
| newGroups.setGroup(group); | ||
| group.add(allOtherEntries); | ||
| } catch (IllegalArgumentException e) { | ||
| LOGGER.error("Problem appending entries to group", e); | ||
| } | ||
| } | ||
| target.getGroups().ifPresentOrElse( | ||
| newGroups::moveTo, | ||
| // target does not contain any groups, so we can just use the new groups | ||
| () -> target.setGroups(newGroups)); | ||
| }); | ||
| } | ||
|
|
||
| private void mergeContentSelectors(MetaData target, MetaData other) { | ||
| for (ContentSelector selector : other.getContentSelectorList()) { | ||
| target.addContentSelector(selector); | ||
| } | ||
| } | ||
| } |
2 changes: 1 addition & 1 deletion
2
...g/jabref/logic/bibtex/DuplicateCheck.java → ...jabref/logic/database/DuplicateCheck.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.