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.contentapp.configuration.column;
35
36 import info.magnolia.config.NamedDefinition;
37 import info.magnolia.ui.api.app.SubAppDescriptor;
38 import info.magnolia.ui.api.i18n.AbstractAppKeyGenerator;
39
40 import java.lang.reflect.AnnotatedElement;
41 import java.util.List;
42
43 /**
44 * Key generator for {@link ColumnDefinition}. Generates key in form <app-name>.<sub-app-name>.views.<view-name>.<column-name>.<property-name>.
45 */
46 public class ColumnDefinitionKeyGenerator extends AbstractAppKeyGenerator<ColumnDefinition> {
47
48 private static final String VIEWS = "views";
49
50 @Override
51 protected void keysFor(List<String> keys, ColumnDefinition columnDefinition, AnnotatedElement el) {
52 Object root = getRoot(columnDefinition);
53 NamedDefinition appDescriptor = (NamedDefinition) root;
54 final String rootName = appDescriptor.getName();
55 final String columnName = replaceColons(columnDefinition.getName());
56 final String fieldOrGetterName = fieldOrGetterName(el);
57
58 getAncestors(columnDefinition).stream()
59 .filter(SubAppDescriptor.class::isInstance)
60 .map(SubAppDescriptor.class::cast)
61 .map(SubAppDescriptor::getName)
62 .findFirst()
63 .ifPresent(name -> addKey(keys, rootName, name, VIEWS, columnName, fieldOrGetterName)); // app specific, view-specific
64
65 // app specific, all views
66 addKey(keys, rootName, VIEWS, columnName, fieldOrGetterName);
67 // all apps, all views
68 addKey(keys, VIEWS, columnName, fieldOrGetterName);
69 }
70 }