View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.form.field.transformer.multi;
35  
36  import info.magnolia.objectfactory.Components;
37  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
38  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
39  import info.magnolia.ui.form.field.transformer.basic.BasicTransformer;
40  
41  import java.util.Iterator;
42  import java.util.LinkedList;
43  import java.util.List;
44  
45  import javax.inject.Inject;
46  
47  import com.vaadin.v7.data.Item;
48  import com.vaadin.v7.data.Property;
49  import com.vaadin.v7.data.util.ObjectProperty;
50  import com.vaadin.v7.data.util.PropertysetItem;
51  
52  /**
53   * Multi values properties implementation of {@link info.magnolia.ui.form.field.transformer.Transformer}.<br>
54   * Store the list of values as a {@link javax.jcr.Value[]} property.<br>
55   * Retrieve the {@link javax.jcr.Value[]} property value as a list.
56   */
57  
58  public class MultiValueTransformer extends BasicTransformer<PropertysetItem> {
59  
60      /**
61       * @deprecated since 5.4.2 - use {@link #MultiValueTransformer(Item, ConfiguredFieldDefinition, Class, I18NAuthoringSupport)} instead.
62       */
63      @Deprecated
64      public MultiValueTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type) {
65          this(relatedFormItem, definition, type, Components.getComponent(I18NAuthoringSupport.class));
66      }
67  
68      @Inject
69      public MultiValueTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, I18NAuthoringSupport i18NAuthoringSupport) {
70          super(relatedFormItem, definition, type, i18NAuthoringSupport);
71      }
72  
73      @SuppressWarnings("rawtypes")
74      @Override
75      public void writeToItem(PropertysetItem newValue) {
76          Property<List> property = getOrCreateProperty(List.class);
77  
78          List<Object> propertyValue = null;
79          if (newValue != null && !newValue.getItemPropertyIds().isEmpty()) {
80              propertyValue = new LinkedList<>();
81              Iterator<?> it = newValue.getItemPropertyIds().iterator();
82              while (it.hasNext()) {
83                  propertyValue.add(newValue.getItemProperty(it.next()).getValue());
84              }
85          }
86          property.setValue(propertyValue);
87      }
88  
89      @SuppressWarnings("rawtypes")
90      @Override
91      public PropertysetItem readFromItem() {
92          PropertysetItem newValues = new PropertysetItem();
93          Property<List> property = getOrCreateProperty(List.class);
94          if (property.getValue() != null) {
95              List<?> values = property.getValue();
96              int position = 0;
97              for (Object o : values) {
98                  newValues.addItemProperty(position, new ObjectProperty<>(o));
99                  position += 1;
100             }
101         }
102 
103         return newValues;
104     }
105 
106 }