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.form.field.definition.migration;
35  
36  import info.magnolia.ui.editor.CurrentItemProviderDefinition;
37  import info.magnolia.ui.editor.JcrChildNodeProviderDefinition;
38  import info.magnolia.ui.editor.JcrPropertyProvider;
39  import info.magnolia.ui.field.CompositeFieldDefinition;
40  import info.magnolia.ui.field.ConfiguredFieldDefinition;
41  import info.magnolia.ui.field.EditorPropertyDefinition;
42  import info.magnolia.ui.field.JcrMultiFieldDefinition;
43  import info.magnolia.ui.field.JcrMultiValueFieldDefinition;
44  import info.magnolia.ui.field.MultiFieldDefinition;
45  import info.magnolia.ui.form.definition.DefinitionConverter;
46  import info.magnolia.ui.form.field.definition.MultiValueFieldDefinition;
47  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformer;
48  import info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer;
49  
50  import java.util.ArrayList;
51  import java.util.List;
52  
53  import javax.jcr.Node;
54  
55  /**
56   * Converter from old {@link MultiValueFieldDefinition} to new {@link MultiFieldDefinition}.
57   */
58  public class MultiValueFieldDefinitionConverter extends AbstractComplexFieldDefinitionConverter<Node, MultiFieldDefinition<Node>, MultiValueFieldDefinition> {
59  
60      public MultiFieldDefinition<Node> convert(MultiValueFieldDefinition oldDefinition) {
61          MultiFieldDefinition newDefinition = super.convert(oldDefinition);
62          final ConfiguredFieldDefinition<Node> field = (ConfiguredFieldDefinition) DefinitionConverter.FIELD.convert(oldDefinition.getField());
63          if (newDefinition instanceof JcrMultiValueFieldDefinition) {
64              final JcrPropertyProvider.Definition definition = new JcrPropertyProvider.Definition(oldDefinition.getName());
65              definition.setMultiple(true);
66              newDefinition.setItemProvider(definition);
67              newDefinition.setField(field);
68              ((JcrMultiValueFieldDefinition) newDefinition).init();
69          } else {
70              List<EditorPropertyDefinition> properties = new ArrayList<>();
71              properties.add(field);
72              CompositeFieldDefinition<Object> compositeFieldDefinition = new CompositeFieldDefinition<>();
73              final JcrChildNodeProviderDefinition providerDefinition = new JcrChildNodeProviderDefinition();
74              providerDefinition.setNodeName(oldDefinition.getName());
75              compositeFieldDefinition.setName(oldDefinition.getName());
76              compositeFieldDefinition.setProperties(properties);
77              newDefinition.setField(compositeFieldDefinition);
78              convertTransformerStrategy(oldDefinition, newDefinition);
79          }
80          return newDefinition;
81      }
82  
83      @Override
84      MultiFieldDefinition createNewDefinition(MultiValueFieldDefinition oldDefinition) {
85          return oldDefinition.getTransformerClass().equals(MultiValueTransformer.class) ? new JcrMultiValueFieldDefinition() : new JcrMultiFieldDefinition();
86      }
87  
88      private void convertTransformerStrategy(info.magnolia.ui.form.field.definition.MultiValueFieldDefinition oldDefinition, MultiFieldDefinition<Node> newDefinition) {
89          if (oldDefinition.getTransformerClass().equals(DelegatingMultiValueFieldTransformer.class)) {
90              newDefinition.setItemProvider(new CurrentItemProviderDefinition<>());
91          }
92      }
93  
94      @Override
95      protected boolean supportsTransformerClass(Class transformerClass) {
96          return transformerClass.equals(MultiValueTransformer.class) ||
97                  transformerClass.equals(DelegatingMultiValueFieldTransformer.class);
98      }
99  }