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.api.i18n.I18NAuthoringSupport;
37  import info.magnolia.ui.databinding.JcrItemPropertySet;
38  import info.magnolia.ui.field.FieldDefinition;
39  import info.magnolia.ui.framework.datasource.components.PropertySetFactory;
40  
41  import java.util.Collection;
42  import java.util.List;
43  import java.util.Locale;
44  import java.util.Map;
45  import java.util.Optional;
46  import java.util.function.Function;
47  import java.util.stream.Collectors;
48  
49  import javax.inject.Inject;
50  import javax.jcr.Item;
51  
52  import com.vaadin.data.PropertySet;
53  
54  /**
55   * {@link PropertySet PropertySet} factory which yields JCR-specific implementations.
56   */
57  public class JcrPropertySetFactory implements PropertySetFactory<Item> {
58  
59      private final I18NAuthoringSupport i18NAuthoringSupport;
60  
61      @Inject
62      public JcrPropertySetFactory(I18NAuthoringSupport i18NAuthoringSupport) {
63          this.i18NAuthoringSupport = i18NAuthoringSupport;
64      }
65  
66      @Override
67      public PropertySet<Item> withProperties(Map<String, Class> properties) {
68          final List<JcrItemPropertySet.JcrPropertyDescriptor> propertyDescriptors = properties.entrySet().stream()
69                  .map(entry -> JcrItemPropertySet.JcrPropertyDescriptor.builder()
70                          .type(entry.getValue())
71                          .name(entry.getKey())
72                          .build())
73                  .collect(Collectors.toList());
74  
75          return new JcrItemPropertySet(propertyDescriptors);
76      }
77  
78      @Override
79      public PropertySet<Item> fromFieldDefinitions(Collection<FieldDefinition> fieldDefinitions, Locale locale) {
80          final List<JcrItemPropertySet.JcrPropertyDescriptor> propertyDefinitions = fieldDefinitions.stream()
81                  .map(fieldDefinition -> JcrItemPropertySet.JcrPropertyDescriptor
82                          .builder()
83                          .name(getI18nNameProvider(locale).apply(fieldDefinition))
84                          .type(fieldDefinition.getType())
85                          .build())
86                  .collect(Collectors.toList());
87  
88          return new JcrItemPropertySet(propertyDefinitions);
89      }
90  
91      private Function<FieldDefinition<Item>, String> getI18nNameProvider(Locale locale) {
92          return fieldDefinition ->
93                  Optional.ofNullable(locale)
94                          .filter(l -> !i18NAuthoringSupport.isDefaultLocale(locale))
95                          .filter(l -> fieldDefinition.isI18n())
96                          .map(l -> i18NAuthoringSupport.deriveLocalisedPropertyName(fieldDefinition.getName(), locale))
97                          .orElse(fieldDefinition.getName());
98      }
99  }