View Javadoc
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.databinding;
35  
36  import info.magnolia.config.NamedDefinition;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.ui.framework.databinding.ItemProviderStrategy;
40  import info.magnolia.ui.form.FormDefinition;
41  
42  import java.util.Optional;
43  
44  import javax.inject.Inject;
45  import javax.jcr.Node;
46  import javax.jcr.RepositoryException;
47  
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Resolves child JCR node from the parent. Suitable for the sub-form only,
53   * since it relies on the parent {@link ItemProviderStrategy item provider strategy}
54   * to be available in the context.
55   * <strong>NOTE:</strong> currently sub-node name is resolved from the {@link FormDefinition form definition},
56   * which might change in the future (<- TODO check).
57   */
58  public class FetchJcrSubNode implements ItemProviderStrategy<Node> {
59  
60      private static final Logger log = LoggerFactory.getLogger(FetchJcrSubNode.class);
61  
62      private final ItemProviderStrategy<Node> parentNodeReader;
63      private final FetchJcrSubNodeDefinition definition;
64      private final NamedDefinition formDefinition;
65  
66      @Inject
67      public FetchJcrSubNode(
68              ItemProviderStrategy<Node> parentNodeProvider,
69              FetchJcrSubNodeDefinition definition,
70              NamedDefinition formDefinition) {
71          this.parentNodeReader = parentNodeProvider;
72          this.definition = definition;
73          this.formDefinition = formDefinition;
74      }
75  
76      @Override
77      public Optional<Node> read() {
78          return parentNodeReader.read().map(parentNode -> {
79              try {
80                  return NodeUtil.createPath(parentNode, getSubNodeName(), resolveTargetNodeType());
81              } catch (RepositoryException e) {
82                  log.warn("Unable to read from parent node {}", parentNode, e);
83                  return null;
84              }
85          });
86      }
87  
88      protected String getSubNodeName() {
89          return formDefinition.getName();
90      }
91  
92      private String resolveTargetNodeType() {
93          return Optional.ofNullable(definition.getNodeType()).orElse(NodeTypes.ContentNode.NAME);
94      }
95  }