Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve performance #5539

Merged
merged 3 commits into from
Oct 29, 2019
Merged

Improve performance #5539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0b83a1
Improve performance
tobiasdiez Oct 28, 2019
683fdbb
Add empty lines
tobiasdiez Oct 29, 2019
5654d5f
Merge branch 'master' into improvePerf
tobiasdiez Oct 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions src/main/java/org/jabref/gui/BasePanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -908,10 +908,6 @@ public void updateEntryEditorIfShowing() {

public void markBaseChanged() {
baseChanged = true;
markBasedChangedInternal();
}

private void markBasedChangedInternal() {
tobiasdiez marked this conversation as resolved.
Show resolved Hide resolved
// Put an asterisk behind the filename to indicate the database has changed.
frame.setWindowTitle();
DefaultTaskExecutor.runInJavaFXThread(frame::updateAllTabTitles);
Expand Down Expand Up @@ -1085,11 +1081,6 @@ public void cut() {
mainTable.cut();
}

@Subscribe
public void listen(EntryChangedEvent entryChangedEvent) {
this.markBaseChanged();
tobiasdiez marked this conversation as resolved.
Show resolved Hide resolved
}

private static class SearchAndOpenFile {

private final BibEntry entry;
Expand Down
8 changes: 5 additions & 3 deletions src/main/java/org/jabref/gui/maintable/MainTableDataModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
public class MainTableDataModel {
private final FilteredList<BibEntryTableViewModel> entriesFiltered;
private final SortedList<BibEntryTableViewModel> entriesSorted;
private final GroupViewMode groupViewMode;

public MainTableDataModel(BibDatabaseContext context) {
ObservableList<BibEntry> allEntries = BindingsHelper.forUI(context.getDatabase().getEntries());

ObservableList<BibEntryTableViewModel> entriesViewModel = BindingsHelper.mapBacked(allEntries, BibEntryTableViewModel::new);

entriesFiltered = new FilteredList<>(entriesViewModel);
entriesFiltered.predicateProperty().bind(
Bindings.createObjectBinding(() -> this::isMatched,
Expand All @@ -40,6 +41,7 @@ public MainTableDataModel(BibDatabaseContext context) {
Globals.stateManager.setActiveSearchResultSize(context, resultSize);
// We need to wrap the list since otherwise sorting in the table does not work
entriesSorted = new SortedList<>(entriesFiltered);
groupViewMode = Globals.prefs.getGroupViewMode();
}

private boolean isMatched(BibEntryTableViewModel entry) {
Expand All @@ -64,7 +66,7 @@ private Optional<MatcherSet> createGroupMatcher(List<GroupTreeNode> selectedGrou
return Optional.empty();
}

final MatcherSet searchRules = MatcherSets.build(Globals.prefs.getGroupViewMode() == GroupViewMode.INTERSECTION ? MatcherSets.MatcherType.AND : MatcherSets.MatcherType.OR);
final MatcherSet searchRules = MatcherSets.build(groupViewMode == GroupViewMode.INTERSECTION ? MatcherSets.MatcherType.AND : MatcherSets.MatcherType.OR);

for (GroupTreeNode node : selectedGroups) {
searchRules.addRule(node.getSearchMatcher());
Expand Down
14 changes: 14 additions & 0 deletions src/main/java/org/jabref/gui/util/BindingsHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,20 @@ public static <T> ObservableValue<T> ifThenElse(ObservableValue<Boolean> conditi
});
}

/**
* Invokes {@code subscriber} for the every new value of {@code observable}, but not for the current value.
*
* @param observable observable value to subscribe to
* @param subscriber action to invoke for values of {@code observable}.
* @return a subscription that can be used to stop invoking subscriber for any further {@code observable} changes.
* @apiNote {@link EasyBind#subscribe(ObservableValue, Consumer)} is similar but also invokes the {@code subscriber} for the current value
*/
public static <T> Subscription subscribeFuture(ObservableValue<T> observable, Consumer<? super T> subscriber) {
ChangeListener<? super T> listener = (obs, oldValue, newValue) -> subscriber.accept(newValue);
observable.addListener(listener);
return () -> observable.removeListener(listener);
}

private static class BidirectionalBinding<A, B> {

private final ObservableValue<A> propertyA;
Expand Down
7 changes: 3 additions & 4 deletions src/main/java/org/jabref/gui/util/DefaultTaskExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import javafx.application.Platform;
import javafx.concurrent.Task;

import org.fxmisc.easybind.EasyBind;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -117,9 +116,9 @@ private <V> Task<V> getJavaFXTask(BackgroundTask<V> task) {
Task<V> javaTask = new Task<V>() {

{
EasyBind.subscribe(task.progressProperty(), progress -> updateProgress(progress.getWorkDone(), progress.getMax()));
EasyBind.subscribe(task.messageProperty(), this::updateMessage);
EasyBind.subscribe(task.isCanceledProperty(), cancelled -> {
BindingsHelper.subscribeFuture(task.progressProperty(), progress -> updateProgress(progress.getWorkDone(), progress.getMax()));
BindingsHelper.subscribeFuture(task.messageProperty(), this::updateMessage);
BindingsHelper.subscribeFuture(task.isCanceledProperty(), cancelled -> {
if (cancelled) {
cancel();
}
Expand Down
53 changes: 37 additions & 16 deletions src/main/java/org/jabref/model/entry/BibEntry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import org.jabref.model.entry.types.StandardEntryType;
import org.jabref.model.strings.LatexToUnicodeAdapter;
import org.jabref.model.strings.StringUtil;
import org.jabref.model.util.MultiKeyMap;

import com.google.common.base.Strings;
import com.google.common.eventbus.EventBus;
Expand All @@ -53,14 +54,22 @@ public class BibEntry implements Cloneable {
private static final Logger LOGGER = LoggerFactory.getLogger(BibEntry.class);
private static final Pattern REMOVE_TRAILING_WHITESPACE = Pattern.compile("\\s+$");
private final SharedBibEntryData sharedBibEntryData;

/**
* Map to store the words in every field
*/
private final Map<Field, Set<String>> fieldsAsWords = new HashMap<>();

/**
* Cache that stores latex free versions of fields.
*/
private final Map<Field, String> latexFreeFields = new ConcurrentHashMap<>();

/**
tobiasdiez marked this conversation as resolved.
Show resolved Hide resolved
* Cache that stores the field as keyword lists (format <Field, Separator, Keyword list>)
*/
private MultiKeyMap<Field, Character, KeywordList> fieldsAsKeywords = new MultiKeyMap<>();

private final EventBus eventBus = new EventBus();
private String id;
private final ObjectProperty<EntryType> type = new SimpleObjectProperty<>(DEFAULT_TYPE);
Expand Down Expand Up @@ -720,8 +729,7 @@ public void addKeywords(Collection<String> keywords, Character delimiter) {
}

public KeywordList getKeywords(Character delimiter) {
Optional<String> keywordsContent = getField(StandardField.KEYWORDS);
return keywordsContent.map(content -> KeywordList.parse(content, delimiter)).orElse(new KeywordList());
return getFieldAsKeywords(StandardField.KEYWORDS, delimiter);
}

public KeywordList getResolvedKeywords(Character delimiter, BibDatabase database) {
Expand Down Expand Up @@ -824,33 +832,46 @@ public Set<String> getFieldAsWords(Field field) {
}
}

public KeywordList getFieldAsKeywords(Field field, Character keywordSeparator) {
Optional<KeywordList> storedList = fieldsAsKeywords.get(field, keywordSeparator);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't you use Google Guava's Cache? 😇 Maybe, with Eclipse Collections Twin

LoadingCache<Pair<Field, Character>, KeywordList> storedKeywordList = CacheBuilder.newBuilder()
  .build(new CacheLoader<Pair<Field, Character>, KeywordList>() {
    @Override
    public String load(final Pair<Field, Character> pair) throws Exception {
      return getField(pair.getOne().map(... pair.getTwo());
    }
});
return storedKeywordList.get(Tuples.pair(field, keywordSeparator));

OK, invalidation is worse (as it is not possible to invalidate all pairs having the same first value (easily)).

storedKeywordList.invalidateAll();

(I now that Tuples.pair(...) might be slower than your approach. Howver, I would like that the cache can be tweaked ^^).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks complicated 😄 https://github.com/google/guava/wiki/CachesExplained#applicability has the nice explanation

Note: If you do not need the features of a Cache, ConcurrentHashMap is more memory-efficient -- but it is extremely difficult or impossible to duplicate most Cache features with any old ConcurrentMap.

I guess we do not need these cache features (but I've also never worked with Guave Caches...so I cannot appreciate them).

if (storedList.isPresent()) {
return storedList.get();
} else {
KeywordList keywords = getField(field)
.map(content -> KeywordList.parse(content, keywordSeparator))
.orElse(new KeywordList());
fieldsAsKeywords.put(field, keywordSeparator, keywords);
return keywords;
}
}

public Optional<FieldChange> clearCiteKey() {
return clearField(InternalField.KEY_FIELD);
}

private void invalidateFieldCache(Field field) {
latexFreeFields.remove(field);
fieldsAsWords.remove(field);
fieldsAsKeywords.remove(field);
}

public Optional<String> getLatexFreeField(Field field) {
if (!hasField(field) && !InternalField.TYPE_HEADER.equals(field)) {
return Optional.empty();
} else if (latexFreeFields.containsKey(field)) {
return Optional.ofNullable(latexFreeFields.get(field));
} else if (InternalField.KEY_FIELD.equals(field)) {
if (InternalField.KEY_FIELD.equals(field)) {
// the key field should not be converted
Optional<String> citeKey = getCiteKeyOptional();
latexFreeFields.put(field, citeKey.get());
return citeKey;
return getCiteKeyOptional();
} else if (InternalField.TYPE_HEADER.equals(field)) {
String typeName = type.get().getDisplayName();
latexFreeFields.put(field, typeName);
return Optional.of(typeName);
return Optional.of(type.get().getDisplayName());
} else if (latexFreeFields.containsKey(field)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could also be a good place for Guava's Cache.

return Optional.ofNullable(latexFreeFields.get(field));
} else {
String latexFreeField = LatexToUnicodeAdapter.format(getField(field).get()).intern();
latexFreeFields.put(field, latexFreeField);
return Optional.of(latexFreeField);
Optional<String> fieldValue = getField(field);
if (fieldValue.isPresent()) {
String latexFreeField = LatexToUnicodeAdapter.format(fieldValue.get()).intern();
latexFreeFields.put(field, latexFreeField);
return Optional.of(latexFreeField);
} else {
return Optional.empty();
}
}
}

Expand Down
5 changes: 1 addition & 4 deletions src/main/java/org/jabref/model/groups/WordKeywordGroup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
Expand Down Expand Up @@ -119,9 +118,7 @@ private Set<String> getFieldContentAsWords(BibEntry entry) {
if (InternalField.TYPE_HEADER.equals(searchField)) {
return searchWords.stream().filter(word -> entry.getType().getName().equalsIgnoreCase(word)).collect(Collectors.toSet());
}
return entry.getField(searchField)
.map(content -> KeywordList.parse(content, keywordSeparator).toStringList())
.orElse(Collections.emptySet());
return entry.getFieldAsKeywords(searchField, keywordSeparator).toStringList();
} else {
return entry.getFieldAsWords(searchField);
}
Expand Down
33 changes: 33 additions & 0 deletions src/main/java/org/jabref/model/util/MultiKeyMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package org.jabref.model.util;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

public class MultiKeyMap<K1, K2, V> {
tobiasdiez marked this conversation as resolved.
Show resolved Hide resolved
private final Map<K1, Map<K2, V>> map = new HashMap<>();

public Optional<V> get(K1 key1, K2 key2) {
Map<K2, V> metaValue = map.get(key1);
if (metaValue == null) {
return Optional.empty();
} else {
return Optional.ofNullable(metaValue.get(key2));
}
}

public void put(K1 key1, K2 key2, V value) {
Map<K2, V> metaValue = map.get(key1);
if (metaValue == null) {
Map<K2, V> newMetaValue = new HashMap<>();
newMetaValue.put(key2, value);
map.put(key1, newMetaValue);
} else {
metaValue.put(key2, value);
}
}

public void remove(K1 key1) {
map.remove(key1);
}
}