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.ItemProviderDefinition;
37  import info.magnolia.ui.editor.JcrChildNodeProviderDefinition;
38  import info.magnolia.ui.field.ConfiguredComplexPropertyDefinition;
39  
40  import org.slf4j.Logger;
41  import org.slf4j.LoggerFactory;
42  
43  /**
44   * Abstract class for converting definitions of complex fields: CompositeField, MultiValueField and SwitchableField.
45   *
46   * @param <T> item type used in new definition
47   * @param <NEW> new definition class which extends {@link info.magnolia.ui.field.EditorPropertyDefinition}
48   * @param <OLD> old definition class {@link info.magnolia.ui.form.field.definition.FieldDefinition}
49   */
50  abstract public class AbstractComplexFieldDefinitionConverter<T, NEW extends ConfiguredComplexPropertyDefinition<T>, OLD extends info.magnolia.ui.form.field.definition.FieldDefinition> implements FieldDefinitionConverter<T, NEW, OLD> {
51  
52      private final Logger log = LoggerFactory.getLogger(AbstractComplexFieldDefinitionConverter.class);
53  
54      @Override
55      public NEW convert(OLD oldDefinition) {
56          NEW newDefinition = createNewDefinition(oldDefinition);
57          newDefinition.setDescription(oldDefinition.getDescription());
58          newDefinition.setI18n(oldDefinition.isI18n());
59          newDefinition.setItemProvider((ItemProviderDefinition<T, T>) new JcrChildNodeProviderDefinition());
60          newDefinition.setLabel(oldDefinition.getLabel());
61          newDefinition.setName(oldDefinition.getName());
62          newDefinition.setStyleName(oldDefinition.getStyleName());
63          return newDefinition;
64      }
65  
66      abstract NEW createNewDefinition(OLD oldDefinition);
67  
68      @Override
69      public boolean supports(OLD oldDefinition) {
70          if (oldDefinition.getTransformerClass() != null && !supportsTransformerClass(oldDefinition.getTransformerClass())) {
71              log.error("Unsupported transformer class for field definition: " + oldDefinition.getName() + ": " + oldDefinition.getTransformerClass().getName());
72              return false;
73          }
74          if (oldDefinition.getConverterClass() != null) {
75              log.error("Unsupported converter class for field definition: " + oldDefinition.getName() + ": " + oldDefinition.getConverterClass().getName());
76              return false;
77          }
78          return true;
79      }
80  
81      protected boolean supportsTransformerClass(Class transformerClass) {
82          return false;
83      }
84  
85  }