JabRef 6.0-beta.1 · org.jabref.gui.groups.GroupNodeViewModel

Modifier and Type	Class and Description
pack-priv class	GroupNodeViewModel.SearchIndexListener

Modifier and Type	Field and Description
private final BooleanBinding	allSelectedEntriesMatched
private final BooleanBinding	anySelectedEntriesMatched
private static final int	BULK_CHANGE_THRESHOLD
private final ObservableList<GroupNodeViewModel>	children
private @Nullable Future<?>	currentUpdateFuture
private @Nullable org.jabref.logic.util.BackgroundTask<List<BibEntry>>	currentUpdateTask
private final ListChangeListener<BibEntry>	databaseChangeListener
private final BibDatabaseContext	databaseContext
private final SimpleObjectProperty<String>	displayName
private boolean	disposed
private final ObservableList<BibEntry>	entriesList
private final SimpleBooleanProperty	expandedProperty
private final GroupTreeNode	groupNode
private final SimpleBooleanProperty	hasChildren
private final boolean	isRoot
private final CustomLocalDragboard	localDragBoard
private static final Logger	LOGGER
private final Set<String>	matchedEntries Internal cache of matched entry IDs.
private final ReadOnlyIntegerWrapper	matchedEntriesCount UI-facing count derived from `matchedEntries`.
private boolean	matchedEntriesInitialized
private final Object	matchedEntriesLock Guards both the matched-entry cache and the derived hit-count property so readers observe a consistent pair.
private boolean	matchedEntriesUpdateInProgress
private boolean	matchedEntriesUpdatePending
private final InvalidationListener	onInvalidatedGroup
private final GuiPreferences	preferences
private final List<Future<?>>	searchIndexFutures
private final GroupNodeViewModel.SearchIndexListener	searchIndexListener
private final StateManager	stateManager
private final TaskExecutor	taskExecutor

Access	Constructor and Description
public	GroupNodeViewModel(@NonNull BibDatabaseContext databaseContext, @NonNull StateManager stateManager, @NonNull TaskExecutor taskExecutor, @NonNull GroupTreeNode groupNode, @NonNull CustomLocalDragboard localDragBoard, @NonNull GuiPreferences preferences)
public	GroupNodeViewModel(BibDatabaseContext databaseContext, StateManager stateManager, TaskExecutor taskExecutor, AbstractGroup group, CustomLocalDragboard localDragboard, GuiPreferences preferences)

Method Summary

Modifier and Type	Method and Description
public boolean	acceptableDrop(Dragboard dragboard) Decides if the content stored in the given `Dragboard` can be dropped on the given target row.
public List<FieldChange>	addEntriesToGroup(List<BibEntry> entries) Returns: what the assignment changed, for the caller to record — this does not touch the journal itself, because whether the assignment is a step of its own or part of a larger one is the caller's to know Todo warn before assigning to a group whose membership is written to a field other than `keywords`, since that edits the entries in a way the user may not expect.
private void	addMatchedEntry(String entryId)
public GroupTreeNode	addSubgroup(AbstractGroup subgroup)
public BooleanBinding	allSelectedEntriesMatchedProperty()
public BooleanBinding	anySelectedEntriesMatchedProperty()
public boolean	canAddEntriesIn()
public boolean	canAddGroupsIn()
public boolean	canBeDragged()
public boolean	canRemove()
private void	clearMatchedEntries()
private void	completeMatchedEntriesUpdate()
private JabRefIcon	createDefaultIcon()
pack-priv void	dispose()
public void	draggedOn(GroupNodeViewModel target, DroppingMouseLocation mouseLocation)
pack-priv void	ensureMatchedEntriesLoaded()
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public SimpleBooleanProperty	expandedProperty()
public Optional<GroupNodeViewModel>	findGroupNodeViewModel(GroupTreeNode targetNode)
private Optional<GroupNodeViewModel>	findGroupNodeViewModelByEquality(GroupTreeNode targetNode)
private Optional<GroupNodeViewModel>	findGroupNodeViewModelByIdentity(GroupTreeNode targetNode)
pack-priv static GroupNodeViewModel	getAllEntriesGroup(BibDatabaseContext newDatabase, StateManager stateManager, TaskExecutor taskExecutor, CustomLocalDragboard localDragBoard, GuiPreferences preferences)
public Optional<GroupNodeViewModel>	getChildByPath(String pathToSource)
public ObservableList<GroupNodeViewModel>	getChildren()
public Color	getColor()
public String	getDescription()
public String	getDisplayName()
public GroupTreeNode	getGroupNode()
public IntegerBinding	getHits()
public JabRefIcon	getIcon()
public Optional<GroupTreeNode>	getParent()
public String	getPath()
private int	getPositionInParent()
public boolean	hasAllSuggestedGroups()
public SimpleBooleanProperty	hasChildrenProperty()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasSimilarSearchGroup(SearchGroup searchGroup)
public boolean	hasSubgroups()
public boolean	isAllEntriesGroup()
public boolean	isEditable()
pack-priv boolean	isMatchedBy(String searchString)
private boolean	isMatchEffective(GroupNodeViewModel vm, BibEntry entry) Returns whether the given entry should be considered part of this group for the purpose of the groups sidebar (hit counter, highlighting, etc.).
public boolean	isRoot()
public void	moveTo(GroupNodeViewModel target) Moves this group, without recording: a drag can move several groups at once, so the step is opened by whoever handles the gesture — see `GroupTreeViewModel#recordTreeChange`.
public void	moveTo(GroupTreeNode target, int targetIndex)
private void	onDatabaseChanged(ListChangeListener.Change<? extends BibEntry> change) Gets invoked if an entry in the current database changes.
private Optional<JabRefIcon>	parseIcon(String iconCode)
private void	refreshGroup()
private void	removeMatchedEntry(String entryId)
private void	replaceMatchedEntries(List<BibEntry> entries)
public void	setDisplayName(String newName)
pack-priv void	toggleExpansion()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private GroupNodeViewModel	toViewModel(GroupTreeNode child)
private void	updateAllEntriesCount()
pack-priv void	updateMatchedEntries()

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

Field Detail

allSelectedEntriesMatched	back to summary
private final BooleanBinding allSelectedEntriesMatched

anySelectedEntriesMatched	back to summary
private final BooleanBinding anySelectedEntriesMatched

BULK_CHANGE_THRESHOLD	back to summary
private static final int BULK_CHANGE_THRESHOLD

children	back to summary
private final ObservableList<GroupNodeViewModel> children

currentUpdateFuture	back to summary
private @Nullable Future<?> currentUpdateFuture

currentUpdateTask	back to summary
private @Nullable org.jabref.logic.util.BackgroundTask<List<BibEntry>> currentUpdateTask

databaseChangeListener	back to summary
private final ListChangeListener<BibEntry> databaseChangeListener

databaseContext	back to summary
private final BibDatabaseContext databaseContext

displayName	back to summary
private final SimpleObjectProperty<String> displayName

disposed	back to summary
private boolean disposed

entriesList	back to summary
private final ObservableList<BibEntry> entriesList Annotations @SuppressWarnings:FieldCanBeLocal

expandedProperty	back to summary
private final SimpleBooleanProperty expandedProperty

groupNode	back to summary
private final GroupTreeNode groupNode

hasChildren	back to summary
private final SimpleBooleanProperty hasChildren

isRoot	back to summary
private final boolean isRoot

localDragBoard	back to summary
private final CustomLocalDragboard localDragBoard

LOGGER	back to summary
private static final Logger LOGGER

matchedEntries back to summary

matchedEntries	back to summary
private final Set<String> matchedEntries Internal cache of matched entry IDs. Kept as a plain `Set` instead of an `ObservableSet`, because group refreshes and search-index updates can overlap while the UI stays responsive (for example inside modal dialogs). Exposing collection change events for this cache made bulk refreshes re-entrant and could trigger `ConcurrentModificationException`.

private final Set<String> matchedEntries

Internal cache of matched entry IDs.

Kept as a plain Set instead of an ObservableSet, because group refreshes and search-index updates can overlap while the UI stays responsive (for example inside modal dialogs). Exposing collection change events for this cache made bulk refreshes re-entrant and could trigger ConcurrentModificationException.

matchedEntriesCount	back to summary
private final ReadOnlyIntegerWrapper matchedEntriesCount UI-facing count derived from `matchedEntries`. The sidebar binds to this property instead of the cache itself.

matchedEntriesInitialized	back to summary
private boolean matchedEntriesInitialized

matchedEntriesLock	back to summary
private final Object matchedEntriesLock Guards both the matched-entry cache and the derived hit-count property so readers observe a consistent pair.

matchedEntriesUpdateInProgress	back to summary
private boolean matchedEntriesUpdateInProgress

matchedEntriesUpdatePending	back to summary
private boolean matchedEntriesUpdatePending

onInvalidatedGroup	back to summary
private final InvalidationListener onInvalidatedGroup Annotations @SuppressWarnings:FieldCanBeLocal

preferences	back to summary
private final GuiPreferences preferences

searchIndexFutures	back to summary
private final List<Future<?>> searchIndexFutures

searchIndexListener	back to summary
private final GroupNodeViewModel.SearchIndexListener searchIndexListener

stateManager	back to summary
private final StateManager stateManager

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

GroupNodeViewModel	back to summary
public GroupNodeViewModel(@NonNull BibDatabaseContext databaseContext, @NonNull StateManager stateManager, @NonNull TaskExecutor taskExecutor, @NonNull GroupTreeNode groupNode, @NonNull CustomLocalDragboard localDragBoard, @NonNull GuiPreferences preferences)

GroupNodeViewModel	back to summary
public GroupNodeViewModel(BibDatabaseContext databaseContext, StateManager stateManager, TaskExecutor taskExecutor, AbstractGroup group, CustomLocalDragboard localDragboard, GuiPreferences preferences)

Method Detail

acceptableDrop back to summary

acceptableDrop	back to summary
public boolean acceptableDrop(Dragboard dragboard) Decides if the content stored in the given `Dragboard` can be dropped on the given target row. Currently, the following sources are allowed: another group (will be added as subgroup on drop) entries if the group implements `GroupEntryChanger` (will be assigned to group on drop)

public boolean acceptableDrop(Dragboard dragboard)

Decides if the content stored in the given Dragboard can be dropped on the given target row. Currently, the following sources are allowed:

another group (will be added as subgroup on drop)
entries if the group implements GroupEntryChanger (will be assigned to group on drop)

addEntriesToGroup back to summary

addEntriesToGroup	back to summary
public List<FieldChange> addEntriesToGroup(List<BibEntry> entries) Returns:List<FieldChange> what the assignment changed, for the caller to record — this does not touch the journal itself, because whether the assignment is a step of its own or part of a larger one is the caller's to know Todo warn before assigning to a group whose membership is written to a field other than `keywords`, since that edits the entries in a way the user may not expect.

public List<FieldChange> addEntriesToGroup(List<BibEntry> entries)

Returns:List<FieldChange>: what the assignment changed, for the caller to record — this does not touch the journal itself, because whether the assignment is a step of its own or part of a larger one is the caller's to know
Todo
warn before assigning to a group whose membership is written to a field other than keywords, since that edits the entries in a way the user may not expect.

addMatchedEntry	back to summary
private void addMatchedEntry(String entryId)

addSubgroup	back to summary
public GroupTreeNode addSubgroup(AbstractGroup subgroup)

allSelectedEntriesMatchedProperty	back to summary
public BooleanBinding allSelectedEntriesMatchedProperty()

anySelectedEntriesMatchedProperty	back to summary
public BooleanBinding anySelectedEntriesMatchedProperty()

canAddEntriesIn	back to summary
public boolean canAddEntriesIn()

canAddGroupsIn	back to summary
public boolean canAddGroupsIn()

canBeDragged	back to summary
public boolean canBeDragged()

canRemove	back to summary
public boolean canRemove()

clearMatchedEntries	back to summary
private void clearMatchedEntries()

completeMatchedEntriesUpdate	back to summary
private void completeMatchedEntriesUpdate()

createDefaultIcon	back to summary
private JabRefIcon createDefaultIcon()

dispose	back to summary
pack-priv void dispose()

draggedOn	back to summary
public void draggedOn(GroupNodeViewModel target, DroppingMouseLocation mouseLocation)

ensureMatchedEntriesLoaded	back to summary
pack-priv void ensureMatchedEntriesLoaded()

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.

Annotations

@Override

expandedProperty	back to summary
public SimpleBooleanProperty expandedProperty()

findGroupNodeViewModel	back to summary
public Optional<GroupNodeViewModel> findGroupNodeViewModel(GroupTreeNode targetNode)

findGroupNodeViewModelByEquality	back to summary
private Optional<GroupNodeViewModel> findGroupNodeViewModelByEquality(GroupTreeNode targetNode)

findGroupNodeViewModelByIdentity	back to summary
private Optional<GroupNodeViewModel> findGroupNodeViewModelByIdentity(GroupTreeNode targetNode)

getAllEntriesGroup	back to summary
pack-priv static GroupNodeViewModel getAllEntriesGroup(BibDatabaseContext newDatabase, StateManager stateManager, TaskExecutor taskExecutor, CustomLocalDragboard localDragBoard, GuiPreferences preferences)

getChildByPath	back to summary
public Optional<GroupNodeViewModel> getChildByPath(String pathToSource)

getChildren	back to summary
public ObservableList<GroupNodeViewModel> getChildren()

getColor	back to summary
public Color getColor()

getDescription	back to summary
public String getDescription()

getDisplayName	back to summary
public String getDisplayName()

getGroupNode	back to summary
public GroupTreeNode getGroupNode()

getHits	back to summary
public IntegerBinding getHits()

getIcon	back to summary
public JabRefIcon getIcon()

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

getPath	back to summary
public String getPath()

getPositionInParent	back to summary
private int getPositionInParent()

hasAllSuggestedGroups	back to summary
public boolean hasAllSuggestedGroups()

hasChildrenProperty	back to summary
public SimpleBooleanProperty hasChildrenProperty()

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.

Annotations

@Override

hasSimilarSearchGroup	back to summary
public boolean hasSimilarSearchGroup(SearchGroup searchGroup)

hasSubgroups	back to summary
public boolean hasSubgroups()

isAllEntriesGroup	back to summary
public boolean isAllEntriesGroup()

isEditable	back to summary
public boolean isEditable()

isMatchedBy	back to summary
pack-priv boolean isMatchedBy(String searchString)

isMatchEffective

back to summary

private boolean isMatchEffective(GroupNodeViewModel vm, BibEntry entry)

Returns whether the given entry should be considered part of this group for the purpose of the groups sidebar (hit counter, highlighting, etc.).

We cannot simply use groupNode.matches(entry) here. That only checks the rule of this single group and ignores the configured hierarchy type and any child groups created in the view model (for example automatic subgroups)

This method applies the hierarchy type: INDEPENDENT: match this group only, INCLUDING: match this group or any child group, REFINING: match this group and all ancestor groups.

isRoot	back to summary
public boolean isRoot()

moveTo	back to summary
public void moveTo(GroupNodeViewModel target) Moves this group, without recording: a drag can move several groups at once, so the step is opened by whoever handles the gesture — see `GroupTreeViewModel#recordTreeChange`.

moveTo	back to summary
public void moveTo(GroupTreeNode target, int targetIndex)

onDatabaseChanged	back to summary
private void onDatabaseChanged(ListChangeListener.Change<? extends BibEntry> change) Gets invoked if an entry in the current database changes. Implementation Note Search groups are updated in `SearchIndexListener`.

parseIcon	back to summary
private Optional<JabRefIcon> parseIcon(String iconCode)

refreshGroup	back to summary
private void refreshGroup()

removeMatchedEntry	back to summary
private void removeMatchedEntry(String entryId)

replaceMatchedEntries	back to summary
private void replaceMatchedEntries(List<BibEntry> entries)

setDisplayName	back to summary
public void setDisplayName(String newName)

toggleExpansion	back to summary
pack-priv void toggleExpansion()

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

toViewModel	back to summary
private GroupNodeViewModel toViewModel(GroupTreeNode child)

updateAllEntriesCount	back to summary
private void updateAllEntriesCount()

updateMatchedEntries	back to summary
pack-priv void updateMatchedEntries()

public Class GroupNodeViewModel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class GroupNodeViewModel.SearchIndexListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	listen(IndexStartedEvent event)
public void	listen(IndexAddedOrUpdatedEvent event)
public void	listen(IndexRemovedEvent event)
public void	listen(IndexClosedEvent event)