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