View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.field;
35  
36  import static info.magnolia.util.Functions.defaultCombiner;
37  
38  import info.magnolia.objectfactory.ComponentProvider;
39  
40  import java.util.Optional;
41  
42  import org.apache.commons.lang3.ArrayUtils;
43  
44  import com.vaadin.data.Binder;
45  import com.vaadin.data.Converter;
46  import com.vaadin.data.ErrorMessageProvider;
47  import com.vaadin.data.HasValue;
48  import com.vaadin.data.Validator;
49  
50  /**
51   * Applies configuration parameters coming from a {@link FieldDefinition} to the binding builder.
52   */
53  public interface FieldBinder<T> {
54  
55      <BT> Binder.BindingBuilder<BT, T> configureBinding(FieldDefinition<T> definition, Binder.BindingBuilder<BT, T> source);
56  
57      /**
58       * Default implementation of {@link FieldBinder}. Will apply such configurable properties
59       * as error message, validators and converters.
60       *
61       * @param <T>
62       *     field value type
63       */
64      class Default<T> implements FieldBinder<T> {
65  
66          private final ComponentProvider componentProvider;
67  
68          public Default(ComponentProvider componentProvider) {
69              this.componentProvider = componentProvider;
70          }
71  
72          @Override
73          public <BT> Binder.BindingBuilder<BT, T> configureBinding(FieldDefinition<T> definition, Binder.BindingBuilder<BT, T> source) {
74              Binder.BindingBuilder<BT, T> result = source;
75  
76              if (definition.isRequired()) {
77                  source.asRequired(definition.getRequiredErrorMessage());
78              }
79  
80              result = definition.getValidators().stream()
81                      .map(this::newValidator)
82                      .reduce(result, Binder.BindingBuilder::withValidator, defaultCombiner());
83  
84              //noinspection unchecked
85              result = createConfiguredConverter(definition, result.getField()).map(result::withConverter).orElse((Binder.BindingBuilder) result);
86  
87              return result;
88          }
89  
90          private <VT> Validator<VT> newValidator(FieldValidatorDefinition definition, Object... parameters) {
91              FieldValidatorFactory fieldValidatorFactory = componentProvider.newInstance(definition.getFactoryClass(), ArrayUtils.add(parameters, definition));
92              return fieldValidatorFactory.createValidator();
93          }
94  
95          protected <PT> Optional<Converter<PT, ?>> createConfiguredConverter(FieldDefinition<PT> definition, HasValue<?> field) {
96              ErrorMessageProvider errorMessageProvider = context -> definition.getConversionErrorMessage();
97              return Optional.ofNullable(definition.getConverterClass())
98                      .map(converterClass -> componentProvider.newInstance(converterClass, field, errorMessageProvider));
99          }
100     }
101 }
102