Skip to content

Bug Fix: Mutliple filter components overwrite each others conditions when filtering the same grid #7

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

Closed
wants to merge 1 commit into from
Closed

Bug Fix: Mutliple filter components overwrite each others conditions when filtering the same grid #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
117 changes: 91 additions & 26 deletions vaadin-simple-grid-filter/src/main/java/software/xdev/vaadin/FilterComponent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@
import java.util.stream.IntStream;
import java.util.stream.Stream;

import com.vaadin.flow.component.AttachEvent;
import com.vaadin.flow.component.ComponentEvent;
import com.vaadin.flow.component.ComponentUtil;
import com.vaadin.flow.component.Composite;
import com.vaadin.flow.component.DetachEvent;
import com.vaadin.flow.component.ItemLabelGenerator;
import com.vaadin.flow.component.Key;
import com.vaadin.flow.component.UI;
Expand All @@ -65,6 +69,7 @@
import com.vaadin.flow.router.BeforeEnterEvent;
import com.vaadin.flow.router.BeforeEnterObserver;
import com.vaadin.flow.router.QueryParameters;
import com.vaadin.flow.shared.Registration;

import software.xdev.vaadin.builder.CustomizableFilterBuilder;
import software.xdev.vaadin.comparators.ContainsComparator;
Expand Down Expand Up @@ -369,6 +374,7 @@ private void onAcceptFilter()
final boolean editable;

// Check if it's an initial condition
// Set editable/deletable and the customization degree
if(this.editingBadgeId != null && !this.editingBadgeId.equals(NO_BADGE_ID_STRING))
{
deletable = this.deletingBadgeEnabled;
Expand Down Expand Up @@ -396,6 +402,7 @@ private void onAcceptFilter()
editable,
customizationDegree);

// Query parameter
if(!this.identifier.isBlank())
{
if(this.editingBadgeId != null && !this.editingBadgeId.equals(NO_BADGE_ID_STRING))
Expand Down Expand Up @@ -478,7 +485,7 @@ private void onAcceptFilter()
});
}

this.deactivateDeleteButtonFromChipComponents(deletableCondition, badge);
this.setBtnDeleteClickListenerWhenConditionShouldBeDeletable(deletableCondition, badge);

// Format chip badge text if it contains LocalDate/LocalDateTime
if(TemporalAccessor.class.isAssignableFrom(badge.getItem().getItem().getType())
Expand All @@ -490,12 +497,12 @@ private void onAcceptFilter()
this.chipBadges.add(badge);
this.hlChipBadges.add(badge);

this.updateGridFilter();
this.addFilterConditionToGrid(badge);

return badge;
}

private void deactivateDeleteButtonFromChipComponents(
private void setBtnDeleteClickListenerWhenConditionShouldBeDeletable(
final boolean conditionDeletable,
final ChipBadgeExtension<FilterCondition<T, ?>> badge)
{
Expand Down Expand Up @@ -812,32 +819,18 @@ else if(type.isAssignableFrom(Enum.class) || type.isAssignableFrom(Boolean.class
}
}

private void updateGridFilter()
private void addFilterConditionToGrid(final ChipBadgeExtension<FilterCondition<T, ?>> chipBadge)
{
if(this.chipBadges.isEmpty())
{
this.dataGrid.getListDataView().removeFilters();
return;
}
Objects.requireNonNull(chipBadge);

this.dataGrid.getListDataView().setFilter(item ->
this.dataGrid.getListDataView().addFilter(item ->
{
final List<Predicate<T>> predicates = new ArrayList<>();
final FilterCondition<T, ?> item1 = chipBadge.getItem();
final String inputValue = item1.getInputValue();
final Predicate<T> predicate =
item1.getSelectedCondition().compare(item1.getItem().getValueProvider(), inputValue);

for(final ChipBadge<FilterCondition<T, ?>> chipBadge : this.chipBadges)
{
final FilterCondition<T, ?> item1 = chipBadge.getItem();
final String inputValue = item1.getInputValue();

predicates.add(

item1.getSelectedCondition().compare(
item1.getItem().getValueProvider(),
inputValue)
);
}

return predicates.stream().map(p -> p.test(item)).reduce(Boolean::logicalAnd).orElseThrow();
return predicate.test(item);
});
}

Expand Down Expand Up @@ -938,10 +931,21 @@ private void removeChipBadgeCondition(final ChipBadgeExtension<FilterCondition<T
{
this.chipBadges.remove(chip);
this.hlChipBadges.remove(chip);
// Have to set all filter when removing a condition again because we cannot remove just one filter from the
// grid
this.updateGridFilter();
this.removeQueryParameter(chip);
}

private void updateGridFilter()
Copy link
Member

@AB-xdev AB-xdev Oct 21, 2024

Choose a reason for hiding this comment

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

Method is called updateGridFilter but it just removes filters and throws a FilterComponentResetGridFilterEvent.

Should likely be called resetGridFilters or?

{
// Remove all filters from the grid
this.dataGrid.getListDataView().removeFilters();
// Fire grid removed all filters event
// Every filter component in the current ui should add his filter back again to the grid
ComponentUtil.fireEvent(UI.getCurrent(), new FilterComponentResetGridFilterEvent(this, false));
}

/**
* Sets the internationalization properties for the datePicker.
*
Expand Down Expand Up @@ -1289,7 +1293,7 @@ private String createMultipleQueryParameterString()
/**
* Method for adding a specific filter condition as query parameter.
*
* @param filterCondition The condition which should be converted to query parameter.
* @param chipBadge The condition which should be converted to query parameter.
*/
private void addQueryParameter(final ChipBadgeExtension<FilterCondition<T, ?>> chipBadge)
{
Expand Down Expand Up @@ -1500,4 +1504,65 @@ public FilterComponent<T> withInitialFilter(

return filterComponent;
}

// Needed for interacting with other filter components on the same ui
private Registration registration;
Copy link
Member

@AB-xdev AB-xdev Oct 21, 2024

Choose a reason for hiding this comment

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

Should be protected so that it can be overriden


@Override
protected void onAttach(final AttachEvent attachEvent)
{
super.onAttach(attachEvent);
// Register to events from the event bus
this.registration = ComponentUtil.addListener(
attachEvent.getUI(),
FilterComponentResetGridFilterEvent.class,
event ->
{
if(this.chipBadges.isEmpty())
{
return;
}

// Get all conditions from filter component and add them to the grid
this.dataGrid.getListDataView().addFilter(item -> this.isItemMatchingFilter(item, this.chipBadges));
}
);
}

private boolean isItemMatchingFilter(
final T item,
final List<ChipBadgeExtension<FilterCondition<T, ?>>> chipBadges)
{
final List<Predicate<T>> predicates = new ArrayList<>();

for(final ChipBadge<FilterCondition<T, ?>> chipBadge : chipBadges)
{
final FilterCondition<T, ?> item1 = chipBadge.getItem();
final String inputValue = item1.getInputValue();

predicates.add(
item1.getSelectedCondition().compare(
item1.getItem().getValueProvider(),
inputValue)
);
}

return predicates.stream().map(p -> p.test(item)).reduce(Boolean::logicalAnd).orElseThrow();
Comment on lines +1536 to +1550
Copy link
Member

@AB-xdev AB-xdev Oct 21, 2024

Choose a reason for hiding this comment

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

Can likely be written with Streaming API

}

@Override
protected void onDetach(final DetachEvent detachEvent)
{
super.onDetach(detachEvent);
// Unregister from the event bus
this.registration.remove();
}

private static class FilterComponentResetGridFilterEvent extends ComponentEvent<FilterComponent>
Copy link
Member

@AB-xdev AB-xdev Oct 21, 2024

Choose a reason for hiding this comment

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

Type is missing, see sonar for more details

{
public FilterComponentResetGridFilterEvent(final FilterComponent source, final boolean fromClient)
{
super(source, fromClient);
}
}
}