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.datasource.optionlist;
35  
36  import info.magnolia.ui.editor.MultiItemConverter;
37  import info.magnolia.ui.field.FieldDefinition;
38  
39  import java.util.Collection;
40  import java.util.Objects;
41  import java.util.Optional;
42  
43  import org.apache.commons.beanutils.ConvertUtilsBean;
44  
45  import com.vaadin.data.Converter;
46  import com.vaadin.data.Result;
47  import com.vaadin.data.ValueContext;
48  
49  /**
50   * Converter which converts {@link Option} value into {@link FieldDefinition#getType()}.
51   *
52   * In case {@link FieldDefinition#getType()} is set to {@link Collection} then no conversion is done
53   * and string {@link Option#getValue()} is returned. This is because {@link FieldDefinition#getType()} is type of
54   * the field (not type of selected element) and converter for multi-select field is by default
55   * automatically wrapped into {@link MultiItemConverter} - see {@link info.magnolia.ui.field.SelectFieldBinder#createConfiguredConverter}.
56   *
57   * @param <MODEL> model type
58   */
59  public class OptionToModelTypeConverter<MODEL> implements Converter<Option, MODEL> {
60  
61      private final FieldDefinition fieldDefinition;
62      private final OptionListDefinition optionListDefinition;
63  
64      public OptionToModelTypeConverter(FieldDefinition fieldDefinition, OptionListDefinition optionListDefinition) {
65          this.fieldDefinition = fieldDefinition;
66          this.optionListDefinition = optionListDefinition;
67      }
68  
69      @Override
70      public Result<MODEL> convertToModel(Option option, ValueContext context) {
71          ConvertUtilsBean converter = new ConvertUtilsBean();
72          return Result.ok(Optional.ofNullable(option)
73                  .map(Option::getValue)
74                  .map(value -> (MODEL) (!Collection.class.isAssignableFrom(fieldDefinition.getType()) ? converter.convert(value, fieldDefinition.getType()) : value))
75                  .orElse(null));
76      }
77  
78      @Override
79      public Option convertToPresentation(MODEL value, ValueContext context) {
80          return optionListDefinition.getOptions().stream()
81                  .filter(option -> Objects.equals(option.getValue(), String.valueOf(value)))
82                  .findFirst()
83                  .orElse(null);
84      }
85  }