View Javadoc
1   /**
2    * This file Copyright (c) 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.field.factory;
35  
36  import info.magnolia.ui.field.FieldDefinition;
37  import info.magnolia.ui.framework.databinding.registry.ComponentTypeDefinitionRegistry;
38  import info.magnolia.ui.framework.databinding.registry.FieldTypeDefinition;
39  import info.magnolia.objectfactory.ComponentProvider;
40  import info.magnolia.ui.api.ioc.UiContextScoped;
41  
42  import javax.inject.Inject;
43  
44  import org.slf4j.LoggerFactory;
45  
46  import com.vaadin.data.HasValue;
47  import com.vaadin.ui.Component;
48  
49  /**
50   * Produces a Vaadin field based on its definition.
51   * Field factory is resolved via {@link ComponentTypeDefinitionRegistry}.
52   */
53  @UiContextScoped
54  public class FormFieldFactory {
55  
56      private static final org.slf4j.Logger log = LoggerFactory.getLogger(FormFieldFactory.class);
57  
58      private final ComponentProvider componentProvider;
59  
60      private final ComponentTypeDefinitionRegistry componentTypeDefinitionRegistry;
61  
62      @Inject
63      public FormFieldFactory(ComponentProvider componentProvider, ComponentTypeDefinitionRegistry componentTypeDefinitionRegistry) {
64          this.componentProvider = componentProvider;
65          this.componentTypeDefinitionRegistry = componentTypeDefinitionRegistry;
66      }
67  
68      /**
69       * Based on the {@link FieldDefinition}, get the related {@link FieldFactory} initialized with the input parameters.
70       *
71       * @return related {@link FieldFactory} or null in case of exception or if no related factory is defined.
72       */
73      public <TYPE, FIELD extends HasValue<TYPE> & Component> FIELD createField(FieldDefinition<TYPE> definition, Object... parameters) {
74          final FieldTypeDefinition<TYPE> fieldTypeDefinition = componentTypeDefinitionRegistry.getByDefinition(definition);
75          if (fieldTypeDefinition == null) {
76              return null;
77          }
78  
79          Class<? extends FieldFactory<TYPE>> factoryClass = fieldTypeDefinition.getFactoryClass();
80          if (factoryClass == null) {
81              log.warn("No factory class set for definition class [{}]. Please check your configuration.", definition.getClass().getName());
82              return null;
83          }
84  
85          Object[] combinedParameters = new Object[parameters.length + 1];
86          combinedParameters[0] = definition;
87          System.arraycopy(parameters, 0, combinedParameters, 1, parameters.length);
88  
89          return componentProvider.newInstance(factoryClass, combinedParameters).createField();
90      }
91  }