1 /**
2 * This file Copyright (c) 2015-2016 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.rendering.template.i18n;
35
36 import info.magnolia.i18nsystem.AbstractI18nKeyGenerator;
37 import info.magnolia.rendering.template.AreaDefinition;
38 import info.magnolia.rendering.template.RenderableDefinition;
39
40 import java.lang.reflect.AnnotatedElement;
41 import java.util.Arrays;
42 import java.util.List;
43
44 /**
45 * {@link info.magnolia.i18nsystem.I18nKeyGenerator} for {@link info.magnolia.rendering.template.RenderableDefinition}.
46 */
47 public class RenderableDefinitionKeyGenerator extends AbstractI18nKeyGenerator<RenderableDefinition> {
48
49 private static final String TEMPLATES = "templates";
50 private static final String AREAS = "areas";
51 private static final String COMPONENTS = "components";
52
53 @Override
54 protected void keysFor(List<String> keys, RenderableDefinition definition, AnnotatedElement el) {
55 final String suffix = fieldOrGetterName(el);
56 if (definition.getId() == null) {
57 addKey(keys, TEMPLATES, getType(definition), definition.getName(), suffix);
58 } else {
59 addKey(keys, getModuleName(definition.getId()), TEMPLATES, getIdWithoutModuleName(definition.getId()), suffix);
60 addKey(keys, TEMPLATES, getIdWithoutModuleName(definition.getId()), suffix);
61 }
62 }
63
64 /**
65 * Custom implementation till MAGNOLIA-6596 is fixed.
66 */
67 @Override
68 protected void addKey(List<String> keys, String... parts) {
69 if ("title".equals(parts[parts.length - 1])) {
70 super.addKey(keys, Arrays.copyOf(parts, parts.length - 1));
71 } else {
72 super.addKey(keys, parts);
73 }
74 }
75
76 protected String getType(RenderableDefinition definition) {
77 return definition instanceof AreaDefinition ? AREAS : COMPONENTS;
78 }
79 }