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.factory;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.registry.RegistrationException;
38  import info.magnolia.ui.form.field.definition.FieldDefinition;
39  import info.magnolia.ui.form.fieldtype.definition.FieldTypeDefinition;
40  import info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry;
41  import info.magnolia.ui.form.validator.registry.FieldValidatorFactoryFactory;
42  
43  import java.io.Serializable;
44  
45  import javax.inject.Inject;
46  
47  import org.slf4j.Logger;
48  import org.slf4j.LoggerFactory;
49  
50  /**
51   * Factory for creating FieldFactory instances using an internal set of mappings connecting a {@link info.magnolia.ui.form.field.definition.FieldDefinition} class with a {@link FieldFactory} class.
52   *
53   * @see FieldDefinition
54   * @see FieldFactory
55   */
56  public class FieldFactoryFactory implements Serializable {
57  
58      private static final Logger log = LoggerFactory.getLogger(FieldFactoryFactory.class);
59  
60      private final ComponentProvider componentProvider;
61      private final FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry;
62      private final FieldValidatorFactoryFactory fieldValidatorFactoryFactory;
63  
64      @Inject
65      public FieldFactoryFactory(ComponentProvider componentProvider, FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry, FieldValidatorFactoryFactory fieldValidatorFactoryFactory) {
66          this.componentProvider = componentProvider;
67          this.fieldTypeDefinitionRegistry = fieldTypeDefinitionRegistry;
68          this.fieldValidatorFactoryFactory = fieldValidatorFactoryFactory;
69      }
70  
71  
72      /**
73       * Based on the {@link FieldDefinition}, get the related {@link FieldFactory} initialized with the input parameters. <br>
74       * 
75       * @param definition
76       * @param parameters
77       * @return related {@link FieldFactory} or null in case of exception or if no related factory is defined.
78       */
79      public FieldFactory createFieldFactory(FieldDefinition definition, Object... parameters) {
80  
81          FieldTypeDefinition fieldTypeDefinition;
82          try {
83              fieldTypeDefinition = fieldTypeDefinitionRegistry.getByDefinition(definition.getClass());
84              if (fieldTypeDefinition == null) {
85                  return null;
86              }
87          } catch (RegistrationException e) {
88              log.error("No field type definition found for " + definition.getName(), e);
89              return null;
90          }
91  
92          Class<? extends FieldFactory> factoryClass = fieldTypeDefinition.getFactoryClass();
93          if (factoryClass == null) {
94              log.warn("No factory class set for definition class [{}]. Please check your configuration.", definition.getClass().getName());
95              return null;
96          }
97  
98          Object[] combinedParameters = new Object[parameters.length + 1];
99          combinedParameters[0] = definition;
100         System.arraycopy(parameters, 0, combinedParameters, 1, parameters.length);
101 
102         FieldFactory fieldFactory = componentProvider.newInstance(factoryClass, combinedParameters);
103         fieldFactory.setFieldValidatorFactoryFactory(fieldValidatorFactoryFactory);
104 
105         return fieldFactory;
106     }
107 }