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.framework.databinding.i18n;
35
36 import info.magnolia.ui.field.ComplexPropertyDefinition;
37 import info.magnolia.ui.field.EditorPropertyDefinition;
38 import info.magnolia.ui.field.FieldDefinition;
39 import info.magnolia.ui.form.FormDefinition;
40 import info.magnolia.ui.form.AbstractFormKeyGenerator;
41
42 import java.lang.reflect.AnnotatedElement;
43 import java.util.Deque;
44 import java.util.LinkedList;
45 import java.util.List;
46 import java.util.Optional;
47 import java.util.stream.Collectors;
48
49 /**
50 * An {@link info.magnolia.i18nsystem.I18nKeyGenerator} for {@link EditorPropertyDefinition}.
51 * It could be either be a {@link FormDefinition} or a {@link FieldDefinition}
52 */
53 public class ComponentDefinitionKeyGenerator extends AbstractFormKeyGenerator<EditorPropertyDefinition> {
54
55 @Override
56 protected void keysFor(List<String> list, EditorPropertyDefinition editorPropertyDefinition, AnnotatedElement el) {
57 Object parent = getParentViaCast(editorPropertyDefinition);
58 final Deque<String> parentNames = new LinkedList<>();
59
60 while (parent != null) {
61 Optional.ofNullable(getIdOrNameForUnknownRoot(parent)).ifPresent(parentNames::addFirst);
62 parent = getParentViaCast(parent);
63 }
64 final String parentKeyPart = parentNames
65 .stream()
66 .map(e -> e.replace(':', '-'))
67 .distinct()
68 .collect(Collectors.joining("."));
69 final String fieldOrGetterName = fieldOrGetterName(el);
70 addKey(list, parentKeyPart, editorPropertyDefinition.getName(), fieldOrGetterName);
71 }
72
73 @Override
74 protected String getIdOrNameForUnknownRoot(Object obj) {
75 if (obj instanceof ComplexPropertyDefinition) {
76 return ((ComplexPropertyDefinition) obj).getName();
77 }
78 return super.getIdOrNameForUnknownRoot(obj);
79 }
80 }