1 /**
2 * This file Copyright (c) 2020 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.editor;
35
36 import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
37
38 import java.util.Locale;
39 import java.util.stream.IntStream;
40
41 import javax.inject.Inject;
42 import javax.jcr.Node;
43
44 import com.machinezoo.noexception.Exceptions;
45
46 import lombok.EqualsAndHashCode;
47 import lombok.Getter;
48 import lombok.Setter;
49
50 /**
51 * This class modifies {@link info.magnolia.ui.editor.JcrChildNodeProvider} to provide indexed nodes with lexicographically sortable names of length 2,
52 * i.e. 00, 01, 00_de, ...
53 *
54 * @deprecated since 6.2.1, use {@link info.magnolia.ui.editor.JcrChildNodeProvider}. This class is for compatibility
55 * use only to compensate compatibility UI {@link MultiValueSubChildrenNodePropertiesTransformer} behaviour.
56 */
57 @Deprecated
58 public class LexicographicallyIndexedChildNodeProvider extends JcrChildNodeProvider<LexicographicallyIndexedChildNodeProvider.Definition> {
59
60 @Inject
61 public LexicographicallyIndexedChildNodeProvider(
62 LexicographicallyIndexedChildNodeProvider.Definition definition,
63 ComplexPropertyDefinition<Node> associatedPropertyDefinition,
64 I18NAuthoringSupport<Node> i18NAuthoringSupport) {
65 super(definition, associatedPropertyDefinition, i18NAuthoringSupport);
66 }
67
68 @Override
69 protected String constructTargetSubNodeName(Node referenceNode, Locale locale) {
70 String subNodeName = getSubNodeNameBase();
71 if (this.definition.getIndex() >= 0) {
72 return constructLocalisedSubNodeName(referenceNode, String.format("%s%02d", subNodeName, definition.getIndex()), locale);
73 }
74
75 return IntStream.iterate(0, i -> i + 1)
76 .mapToObj(idx -> constructLocalisedSubNodeName(referenceNode, String.format("%s%02d", subNodeName, idx), locale))
77 .filter(Exceptions.sneak().predicate(referenceNode::hasNode).negate())
78 .findFirst()
79 .orElseThrow(RuntimeException::new);
80 }
81
82 /**
83 * Definition of {@link LexicographicallyIndexedChildNodeProvider}.
84 *
85 * @deprecated since 6.2.1
86 */
87 @Deprecated
88 @EqualsAndHashCode(callSuper = true)
89 public static class Definition extends JcrChildNodeProviderDefinition {
90
91 @Getter
92 @Setter
93 private int index = -1;
94
95 public Definition() {
96 setImplementationClass(LexicographicallyIndexedChildNodeProvider.class);
97 }
98 }
99 }