Apply other way of filter grid configuration

Co-authored-by: Sven F. <sven1103@users.noreply.github.com>

Author: KochTobi

datamanager-app/src/main/java/life/qbic/datamanager/views/demo/ComponentDemo.java

@@ -45,11 +45,11 @@
 import life.qbic.datamanager.views.general.grid.Filter;
 import life.qbic.datamanager.views.general.grid.PredicateFilter;
 import life.qbic.datamanager.views.general.grid.component.FilterGrid;
+import life.qbic.datamanager.views.general.grid.component.FilterGridConfigurations;
 import life.qbic.datamanager.views.general.grid.component.FilterGridTab;
 import life.qbic.datamanager.views.general.grid.component.FilterGridTabSheet;
 import life.qbic.datamanager.views.general.grid.component.FilterGridTabSheet.TabAction;
-import life.qbic.datamanager.views.general.grid.component.GridFilterStrategyFactory;
-import life.qbic.datamanager.views.general.grid.component.GridFilterStrategyFactory.FilterTester;
+import life.qbic.datamanager.views.general.grid.component.GridConfiguration.FilterTester;
 import life.qbic.datamanager.views.general.icon.IconFactory;
 import life.qbic.datamanager.views.notifications.MessageSourceNotificationFactory;
 import life.qbic.datamanager.views.projects.project.experiments.experiment.components.experimentalvariable.ExperimentalVariablesInput;
@@ -144,15 +144,15 @@ private Div filterGridShowCase() {
     gridPerson.addColumn(Person::lastName).setHeader("Last Name").setKey("lastName");
     gridPerson.addColumn(Person::age).setHeader("Age").setKey("age");
 
-    var personConfiguration = GridFilterStrategyFactory.configureLazy(
-        gridPerson,
-        contactFetchCallback, contactCountCallback);
+    var lazyConfiguration = FilterGridConfigurations.lazy(contactFetchCallback,
+        contactCountCallback);
     var personGrid = FilterGrid.create(
         Person.class,
         SimplePersonFilter.class,
+        gridPerson,
         () -> new SimplePersonFilter(""),
         (searchTerm, filter) -> new SimplePersonFilter(searchTerm),
-        personConfiguration
+        lazyConfiguration
     );
 
     personGrid.addFilterUpdateListener(
@@ -169,17 +169,14 @@ private Div filterGridShowCase() {
     gridContact.addColumn(Person::lastName).setHeader("Last Name").setKey("lastName");
     gridContact.addColumn(Person::age).setHeader("Age").setKey("age");
 
-    var contactConfiguration = GridFilterStrategyFactory.configureLazy(
-        gridContact,
-        contactFetchCallback,
-        contactCountCallback
-    );
+
     var contactGrid = FilterGrid.create(
         Person.class,
         SimplePersonFilter.class,
+        gridContact,
         () -> new SimplePersonFilter(""),
         (searchTerm, filter) -> new SimplePersonFilter(searchTerm),
-        contactConfiguration
+        lazyConfiguration
     );
     var filterTabContacts = new FilterGridTab<>("Contacts", contactGrid);
 
@@ -188,15 +185,15 @@ private Div filterGridShowCase() {
     gridMemoryPerson.addColumn(Person::lastName).setHeader("Last Name").setKey("lastName");
     gridMemoryPerson.addColumn(Person::age).setHeader("Age").setKey("age");
 
-    var contactInMemoryConfiguration = GridFilterStrategyFactory.configureInMemory(
-        gridMemoryPerson,
+    var contactInMemoryConfiguration = FilterGridConfigurations.inMemory(
         examples,
         nameContainsFilterTerm::test
     );
 
     var inMemoryPersonGrid = FilterGrid.create(
         Person.class,
         SimplePersonFilter.class,
+        gridMemoryPerson,
         () -> new SimplePersonFilter(""),
         (searchTerm, filter) -> new SimplePersonFilter(searchTerm),
         contactInMemoryConfiguration

datamanager-app/src/main/java/life/qbic/datamanager/views/general/grid/component/FilterGrid.java

@@ -115,7 +115,8 @@ public final class FilterGrid<T, F> extends Div {
   private final Class<T> type;
   private final Class<F> filterType;
 
-  private final GridFilterStrategy<T, F> gridFilterStrategy;
+  private final Grid<T> grid;
+  private final GridConfiguration<T, F> gridConfiguration;
   private final Div selectionDisplay = new SelectionNotification();
   private final Div secondaryActionGroup = createSecondaryActionGroup();
 
@@ -128,28 +129,34 @@ public final class FilterGrid<T, F> extends Div {
   public static <T, F> FilterGrid<T, F> create(
       Class<T> itemType,
       Class<F> filterType,
+      Grid<T> grid,
       Supplier<F> filterSupplier,
       SearchTermFilterCombiner<F> searchTermFilterCombiner,
-      GridFilterStrategy<T, F> gridFilterStrategy) {
-    return new FilterGrid<>(itemType, filterType, filterSupplier,
-        searchTermFilterCombiner, gridFilterStrategy);
+      GridConfiguration<T, F> gridConfiguration) {
+
+    return new FilterGrid<>(itemType, filterType, grid, filterSupplier,
+        searchTermFilterCombiner, gridConfiguration);
   }
 
 
   private FilterGrid(
       Class<T> itemType,
       Class<F> filterType,
+      Grid<T> grid,
       Supplier<F> filterSupplier,
       SearchTermFilterCombiner<F> searchTermFilterUpdater,
-      GridFilterStrategy<T, F> gridFilterStrategy) {
+      GridConfiguration<T, F> gridConfiguration) {
     //assign fields
     this.type = Objects.requireNonNull(itemType);
     this.filterType = Objects.requireNonNull(filterType);
-    this.gridFilterStrategy = gridFilterStrategy;
+    this.grid = Objects.requireNonNull(grid);
+    this.gridConfiguration = gridConfiguration;
 
-    configureGrid(gridFilterStrategy.getGrid());
+    configureGridForMultiSelect(grid);
+    optimizeGrid(grid, DEFAULT_QUERY_SIZE);
+    gridConfiguration.applyConfiguration(grid);
     //construct filter Grid component
-    constructComponent(gridFilterStrategy.getGrid());
+    constructComponent(grid);
 
     listenToSelection();
     //update the filter
@@ -161,8 +168,8 @@ private FilterGrid(
    * Refreshes the grid and clears the selection.
    */
   public void refreshAll() {
-    this.gridFilterStrategy.getGrid().getDataProvider().refreshAll();
-    this.gridFilterStrategy.getGrid().deselectAll();
+    this.grid.getDataProvider().refreshAll();
+    this.grid.deselectAll();
   }
 
 
@@ -242,15 +249,10 @@ private void constructComponent(Grid<T> grid) {
 
   private void listenToSelection() {
     updateSelectionDisplay(
-        this.gridFilterStrategy.getGrid().getSelectionModel().getSelectedItems().size());
+        this.grid.getSelectionModel().getSelectedItems().size());
     addSelectionListener(event -> updateSelectionDisplay(event.selectedItems().size()));
   }
 
-  private static <T> void configureGrid(Grid<T> grid) {
-    configureGridForMultiSelect(grid);
-    optimizeGrid(grid, DEFAULT_QUERY_SIZE);
-  }
-
   /**
    * Updates the filter and fires a
    * {@link life.qbic.datamanager.views.general.grid.component.FilterGrid.FilterUpdateEvent}
@@ -263,7 +265,7 @@ private void updateFilter(SearchTermFilterCombiner<F> searchTermFilterCombiner,
       F filter,
       String searchTerm) {
     F updatedFilter = searchTermFilterCombiner.apply(searchTerm, filter);
-    gridFilterStrategy.setFilter(updatedFilter);
+    gridConfiguration.applyConfiguration(grid).setFilter(updatedFilter);
     fireEvent(new FilterUpdateEvent<>(this.filterType, this, false, filter, updatedFilter));
   }
 
@@ -280,7 +282,8 @@ public Registration addItemCountListener(
       ComponentEventListener<ItemCountChangeEvent<FilterGrid<T, F>>> listener) {
     ComponentEventListener<ItemCountChangeEvent<?>> itemCountComponentListener = it -> listener.onComponentEvent(
         new ItemCountChangeEvent<>(this, it.getItemCount(), it.isItemCountEstimated()));
-    return gridFilterStrategy.addItemCountChangeListener(itemCountComponentListener);
+    return gridConfiguration.applyConfiguration(grid).addItemCountChangeListener(
+        itemCountComponentListener);
   }
 
   /**
@@ -289,7 +292,7 @@ public Registration addItemCountListener(
    * @return the assumed number of items.
    */
   public int getItemCount() {
-    return gridFilterStrategy.getGrid().getDataCommunicator().getItemCount();
+    return grid.getDataCommunicator().getItemCount();
   }
 
   /**
@@ -534,7 +537,7 @@ public void setSecondaryActionGroup(Button firstButton, Button... buttons) {
    * @since 1.12.0
    */
   public @NonNull Set<T> selectedElements() {
-    return gridFilterStrategy.getGrid().getSelectedItems();
+    return grid.getSelectedItems();
   }
 
   /**
@@ -570,7 +573,7 @@ public void itemDisplayLabel(String label) {
    * @see Grid#deselectAll()
    */
   public void deselectAll() {
-    gridFilterStrategy.getGrid().deselectAll();
+    grid.deselectAll();
   }
 
   /**
@@ -585,7 +588,7 @@ public void deselectAll() {
    */
   public Registration addSelectionListener(
       ComponentEventListener<FilterGridSelectionEvent<T>> listener) {
-    return gridFilterStrategy.getGrid().addSelectionListener(it -> listener.onComponentEvent(
+    return grid.addSelectionListener(it -> listener.onComponentEvent(
         new FilterGridSelectionEvent<>(this, it.getAllSelectedItems(), it.isFromClient())));
   }
 

datamanager-app/src/main/java/life/qbic/datamanager/views/general/grid/component/FilterGridConfigurations.java

@@ -0,0 +1,71 @@
+package life.qbic.datamanager.views.general.grid.component;
+
+import com.vaadin.flow.component.grid.Grid;
+import com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback;
+import com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback;
+import com.vaadin.flow.data.provider.ConfigurableFilterDataProvider;
+import com.vaadin.flow.data.provider.DataProvider;
+import java.util.List;
+import java.util.Objects;
+import life.qbic.datamanager.views.general.grid.component.GridConfiguration.FilterTester;
+import org.springframework.lang.NonNull;
+
+public class FilterGridConfigurations {
+
+  private FilterGridConfigurations() {
+
+  }
+
+  public static <T, F> GridConfiguration<T, F> lazy(
+      FetchCallback<T, F> fetchCallback,
+      CountCallback<T, F> countCallback
+  ) {
+    return new LazyFilterGridConfiguration<>(fetchCallback, countCallback);
+  }
+
+  public static <T, F> GridConfiguration<T, F> inMemory(
+      List<T> items, FilterTester<T, F> filterTester) {
+    return new InMemoryFilterGridConfiguration<>(items, filterTester);
+  }
+
+
+  static class LazyFilterGridConfiguration<T, F> implements
+      GridConfiguration<T, F> {
+
+    private final ConfigurableFilterDataProvider<T, Void, F> dataProvider;
+
+    public LazyFilterGridConfiguration(
+        @NonNull FetchCallback<T, F> fetchCallback,
+        @NonNull CountCallback<T, F> countCallback) {
+
+      Objects.requireNonNull(fetchCallback);
+      Objects.requireNonNull(countCallback);
+
+      this.dataProvider = DataProvider.fromFilteringCallbacks(fetchCallback, countCallback)
+          .withConfigurableFilter();
+    }
+
+    @Override
+    public ConfiguredGrid<T, F> applyConfiguration(Grid<T> grid) {
+      return new LazyGrid<>(grid, dataProvider);
+    }
+  }
+
+  static class InMemoryFilterGridConfiguration<T, F> implements
+      GridConfiguration<T, F> {
+
+    private final List<T> items;
+    private final FilterTester<T, F> filterTester;
+
+    InMemoryFilterGridConfiguration(List<T> items, FilterTester<T, F> filterTester) {
+      this.items = Objects.requireNonNull(items);
+      this.filterTester = Objects.requireNonNull(filterTester);
+    }
+
+    @Override
+    public ConfiguredGrid<T, F> applyConfiguration(Grid<T> grid) {
+      return new InMemoryGrid<>(grid, items, filterTester);
+    }
+  }
+
+}

datamanager-app/src/main/java/life/qbic/datamanager/views/general/grid/component/Filterable.java

@@ -0,0 +1,6 @@
+package life.qbic.datamanager.views.general.grid.component;
+
+public interface Filterable<F> {
+
+  void setFilter(F filter);
+}

datamanager-app/src/main/java/life/qbic/datamanager/views/general/grid/component/GridConfiguration.java

@@ -0,0 +1,74 @@
+package life.qbic.datamanager.views.general.grid.component;
+
+import com.vaadin.flow.component.ComponentEventListener;
+import com.vaadin.flow.component.grid.Grid;
+import com.vaadin.flow.data.provider.ConfigurableFilterDataProvider;
+import com.vaadin.flow.data.provider.ItemCountChangeEvent;
+import com.vaadin.flow.shared.Registration;
+import java.util.List;
+import java.util.Objects;
+import java.util.function.BiPredicate;
+
+public interface GridConfiguration<T, F> {
+
+  sealed interface ConfiguredGrid<T, F> extends Filterable<F>, ItemCountChangePublisher permits
+      InMemoryGrid, LazyGrid {
+
+
+  }
+
+  interface FilterTester<T, F> extends BiPredicate<T, F> {
+
+  }
+
+  final class InMemoryGrid<T, F> implements ConfiguredGrid<T, F> {
+
+    private final Grid<T> grid;
+    private final FilterTester<T, F> filterTester;
+
+    public InMemoryGrid(Grid<T> grid, List<T> items, FilterTester<T, F> filterTester) {
+      this.grid = Objects.requireNonNull(grid);
+      this.filterTester = Objects.requireNonNull(filterTester);
+      Objects.requireNonNull(items);
+      grid.setItems(items);
+    }
+
+    @Override
+    public void setFilter(F filter) {
+      grid.getListDataView().setFilter(item -> filterTester.test(item, filter));
+    }
+
+    @Override
+    public Registration addItemCountChangeListener(
+        ComponentEventListener<ItemCountChangeEvent<?>> listener) {
+      return grid.getListDataView().addItemCountChangeListener(listener);
+    }
+  }
+
+  final class LazyGrid<T, F> implements ConfiguredGrid<T, F> {
+
+    private final Grid<T> grid;
+    private final ConfigurableFilterDataProvider<T, Void, F> dataProvider;
+
+    public LazyGrid(Grid<T> grid,
+        ConfigurableFilterDataProvider<T, Void, F> dataProvider) {
+      this.grid = Objects.requireNonNull(grid);
+      this.dataProvider = Objects.requireNonNull(dataProvider);
+      grid.setItems(dataProvider);
+    }
+
+    @Override
+    public void setFilter(F filter) {
+      dataProvider.setFilter(filter);
+    }
+
+    @Override
+    public Registration addItemCountChangeListener(
+        ComponentEventListener<ItemCountChangeEvent<?>> listener) {
+      return grid.getLazyDataView().addItemCountChangeListener(listener);
+    }
+  }
+
+  ConfiguredGrid<T, F> applyConfiguration(Grid<T> grid);
+
+}