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.framework.ioc.Destructible;
37  
38  import java.util.stream.Stream;
39  
40  import com.vaadin.data.provider.DataProviderWrapper;
41  import com.vaadin.data.provider.HierarchicalDataProvider;
42  import com.vaadin.data.provider.HierarchicalQuery;
43  
44  /**
45   * Abstract wrapper class of {@link HierarchicalDataProvider}. Similar to Vaadin's own
46   * {@link DataProviderWrapper data provider wrapper}, but for some
47   * reason framework does not provide its own variation for the hierarchical providers.
48   *
49   * @param <T>
50   *     data type
51   * @param <F>
52   *     filter type
53   */
54  public abstract class HierarchicalDataProviderWrapper<T, F> extends DataProviderWrapper<T, F, F> implements HierarchicalDataProvider<T, F>, Destructible {
55  
56      protected HierarchicalDataProviderWrapper(HierarchicalDataProvider<T, F> dataProvider) {
57          super(dataProvider);
58      }
59  
60      protected HierarchicalDataProvider<T, F> dataProvider() {
61          return (HierarchicalDataProvider<T, F>) dataProvider;
62      }
63  
64      @Override
65      public int getChildCount(HierarchicalQuery<T, F> query) {
66          return dataProvider().getChildCount(new HierarchicalQuery<>(
67                  query.getOffset(),
68                  query.getLimit(),
69                  query.getSortOrders(),
70                  query.getInMemorySorting(),
71                  getFilter(query),
72                  query.getParent()));
73      }
74  
75      @Override
76      public Stream<T> fetchChildren(HierarchicalQuery<T, F> query) {
77          return dataProvider.fetch(new HierarchicalQuery<>(
78                  query.getOffset(),
79                  query.getLimit(),
80                  query.getSortOrders(),
81                  query.getInMemorySorting(),
82                  getFilter(query),
83                  query.getParent()));
84      }
85  
86      @Override
87      public boolean hasChildren(T item) {
88          return dataProvider().hasChildren(item);
89      }
90  
91      @Override
92      public void destroy() {
93          if (dataProvider instanceof Destructible) {
94              ((Destructible) dataProvider).destroy();
95          }
96      }
97  }