View Javadoc
1   /**
2    * This file Copyright (c) 2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.contentapp;
35  
36  import info.magnolia.ui.filter.DataFilter;
37  
38  import java.util.Optional;
39  import java.util.stream.Stream;
40  
41  import com.vaadin.data.provider.ConfigurableFilterDataProvider;
42  import com.vaadin.data.provider.HierarchicalDataProvider;
43  import com.vaadin.data.provider.HierarchicalQuery;
44  import com.vaadin.data.provider.Query;
45  
46  /**
47   * Filterable wrapper for a data provider of the specified type.
48   * @param <T> item type.
49   */
50  public class FilterableHierarchicalDataProvider<T> extends HierarchicalDataProviderWrapper<T, DataFilter> implements ConfigurableFilterDataProvider<T, DataFilter, DataFilter> {
51  
52      public static <T> FilterableHierarchicalDataProvider<T> wrap(HierarchicalDataProvider<T, DataFilter> src) {
53          return new FilterableHierarchicalDataProvider<>(src);
54      }
55  
56      private FilterableHierarchicalDataProvider(HierarchicalDataProvider<T, DataFilter> dataProvider) {
57          super(dataProvider);
58      }
59  
60      private DataFilter filter;
61  
62      /**
63       * @deprecated since 6.2.1. Use {@link #setFilter(info.magnolia.ui.filter.DataFilter)} instead.
64       */
65      @Deprecated
66      public void setDataFilter(DataFilter dataFilter) {
67          setFilter(dataFilter);
68      }
69  
70      @Override
71      public void setFilter(DataFilter filter) {
72          this.filter = filter;
73      }
74  
75      @Override
76      public Stream<T> fetch(Query<T, DataFilter> t) {
77          return dataProvider.fetch(new HierarchicalQuery<>(t.getOffset(), t.getLimit(),
78                  t.getSortOrders(), t.getInMemorySorting(), getFilter(t), null));
79      }
80  
81      @Override
82      public Stream<T> fetchChildren(HierarchicalQuery<T, DataFilter> query) {
83          return super.fetchChildren(query)
84                  .sorted(Optional.ofNullable(query.getInMemorySorting()).orElse((o1, o2) -> 0));
85      }
86  
87      @Override
88      public DataFilter getFilter(Query<T, DataFilter> query) {
89          return filter;
90      }
91  
92      @Override
93      public boolean hasChildren(T item) {
94          return fetchChildren(new HierarchicalQuery<>(filter, item)).count() > 0;
95      }
96  }