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 static java.util.stream.Collectors.*;
37  
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
41  import info.magnolia.ui.availability.AvailabilityChecker;
42  import info.magnolia.ui.contentapp.browser.ListPresenter;
43  import info.magnolia.ui.contentapp.configuration.GridViewDefinition;
44  import info.magnolia.ui.contentapp.configuration.column.ColumnDefinition;
45  import info.magnolia.ui.contentapp.observation.JcrDataSourceObservation;
46  import info.magnolia.ui.datasource.DatasourceDefinition;
47  import info.magnolia.ui.datasource.jcr.JcrDatasource;
48  import info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition;
49  import info.magnolia.ui.editor.JcrItemPropertySet;
50  
51  import java.util.List;
52  
53  import javax.inject.Inject;
54  import javax.jcr.Item;
55  import javax.jcr.Node;
56  
57  import com.vaadin.data.PropertySet;
58  
59  /**
60   * JCR-specific implementation of {@link ListPresenter}.
61   */
62  public class JcrListPresenter extends ListPresenter<Node> {
63  
64      private final JcrItemInteractionAvailability interactionAvailability;
65      private final I18NAuthoringSupport<Item> i18NAuthoringSupport;
66      private final JcrDatasourceDefinition datasourceDefinition;
67  
68      @Inject
69      JcrListPresenter(
70              GridViewDefinition<Node> definition,
71              ComponentProvider componentProvider,
72              AvailabilityChecker<Node> availabilityChecker,
73              JcrDatasource datasource,
74              JcrDataSourceObservation datasourceObservation, I18NAuthoringSupport<Item> i18NAuthoringSupport, JcrDatasourceDefinition datasourceDefinition) {
75          super(definition, componentProvider, availabilityChecker, (Datasource) datasource, datasourceObservation);
76          this.interactionAvailability = new JcrItemInteractionAvailability(datasource);
77          this.i18NAuthoringSupport = i18NAuthoringSupport;
78          this.datasourceDefinition = datasourceDefinition;
79      }
80  
81      /**
82       * @deprecated since 6.2.4. Use {@link info.magnolia.ui.contentapp.JcrListPresenter#JcrListPresenter(info.magnolia.ui.contentapp.configuration.GridViewDefinition, info.magnolia.objectfactory.ComponentProvider, info.magnolia.ui.availability.AvailabilityChecker, info.magnolia.ui.datasource.jcr.JcrDatasource, info.magnolia.ui.contentapp.observation.JcrDataSourceObservation, info.magnolia.ui.api.i18n.I18NAuthoringSupport, info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition)} instead.
83       */
84      @Deprecated
85      public JcrListPresenter(GridViewDefinition<Node> definition, ComponentProvider componentProvider, AvailabilityChecker availabilityChecker, JcrDatasource datasource, JcrDataSourceObservation datasourceObservation) {
86          this(definition, componentProvider, availabilityChecker, datasource, datasourceObservation, Components.getComponent(I18NAuthoringSupport.class), (JcrDatasourceDefinition) Components.getComponent(DatasourceDefinition.class));
87      }
88  
89      @Override
90      public FilterableListDataProvider<Node> createDataProvider() {
91          return FilterableListDataProvider.wrap(componentProvider.newInstance(JcrDataProvider.class));
92      }
93  
94      @Override
95      protected PropertySet<Node> createPropertySet() {
96          final List<JcrItemPropertySet.JcrPropertyDescriptor> propertyDescriptors = definition.getColumns().stream().collect(toMap(ColumnDefinition::getName, ColumnDefinition::getType))
97                  .entrySet().stream()
98                  .map(entry -> JcrItemPropertySet.JcrPropertyDescriptor.builder()
99                          .type((Class) entry.getValue())
100                         .name(entry.getKey())
101                         .nodeNameProperty(datasourceDefinition.getNodeNameProperty())
102                         .build())
103                 .collect(toList());
104         return (PropertySet) new JcrItemPropertySet(propertyDescriptors, i18NAuthoringSupport);
105     }
106 
107     @Override
108     public boolean isItemAvailable(Node item) {
109         return this.interactionAvailability.isItemAvailable(item);
110     }
111 }