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.transformer.multi;
35
36 import info.magnolia.cms.core.Path;
37 import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
38 import info.magnolia.ui.vaadin.integration.jcr.JcrNodeAdapter;
39
40 import java.util.Set;
41
42 import javax.inject.Inject;
43 import javax.jcr.RepositoryException;
44
45 import org.apache.commons.lang3.StringUtils;
46 import org.apache.jackrabbit.commons.predicate.Predicate;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
49
50 import com.vaadin.v7.data.Item;
51 import com.vaadin.v7.data.util.PropertysetItem;
52
53 /**
54 * Sub Nodes implementation of {@link info.magnolia.ui.form.field.transformer.Transformer} storing and retrieving properties (as {@link PropertysetItem}) displayed in MultiField.<br>
55 * Storage strategy: <br>
56 * - root node (relatedFormItem)<br>
57 * -- main child node (nodeName = field name) <br>
58 * --- child node 1 (used to store the first value of the MultiField as a property)<br>
59 * ---- property1 (store the first value of the MultiField)<br>
60 * --- child node 2 (used to store the second value of the MultiField as a property)<br>
61 * ---- property2 (store the second value of the MultiField)<br>
62 * ...<br>
63 * Main child node : field name <br>
64 * Child node name : 20 first char of the related value <br>
65 * Property name : field name <br>
66 */
67 public class MultiValueSubChildrenNodeTransformer extends MultiValueChildrenNodeTransformer {
68
69 private static final Logger log = LoggerFactory.getLogger(MultiValueSubChildrenNodePropertiesTransformer.class);
70 private String subNodeName;
71 private int valueItemNameSize = 20;
72
73 @Inject
74 public MultiValueSubChildrenNodeTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type) {
75 super(relatedFormItem, definition, type);
76 this.subNodeName = definition.getName();
77 }
78
79 @Override
80 protected JcrNodeAdapter getRootItem() {
81 JcrNodeAdapter res = null;
82 try {
83 res = getOrCreateChildNode(subNodeName, childNodeType);
84 } catch (RepositoryException re) {
85 log.warn("Not able to retrieve or create a sub node for the parent node {}", ((JcrNodeAdapter) relatedFormItem).getItemId());
86 }
87 return res;
88 }
89
90 @Override
91 protected String createChildItemName(Set<String> childNames, Object value, JcrNodeAdapter rootItem) {
92 return Path.getValidatedLabel(StringUtils.left(value.toString(), valueItemNameSize));
93 }
94
95 @Override
96 protected void handleRootitemAndParent(JcrNodeAdapter rootItem) {
97 // Attach the child item to the root item
98 if (rootItem.getChildren() != null && !rootItem.getChildren().isEmpty()) {
99 ((JcrNodeAdapter) relatedFormItem).addChild(rootItem);
100 } else {
101 ((JcrNodeAdapter) relatedFormItem).removeChild(rootItem);
102 }
103 }
104
105 /**
106 * Return a null predicate.
107 */
108 @Override
109 protected Predicate createPredicateToEvaluateChildNode() {
110 return null;
111 }
112
113 }
114