View Javadoc
1   /**
2    * This file Copyright (c) 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.templating.predicates;
35  
36  import info.magnolia.jcr.predicate.AbstractPredicate;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.templating.functions.NavigationTemplatingFunctions;
39  
40  import javax.jcr.Node;
41  import javax.jcr.RepositoryException;
42  
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  /**
47   * Predicate returns nodes with specified nodeType which are not hidden in navigation (property {@link info.magnolia.templating.functions.NavigationTemplatingFunctions#HIDE_IN_NAVIGATION_PROPERTY_NAME} isn't set to true).
48   */
49  public class NavigationItemPredicate extends AbstractPredicate<Node> {
50  
51      private static final Logger log = LoggerFactory.getLogger(NavigationItemPredicate.class);
52  
53      private final String nodeType;
54  
55      public NavigationItemPredicate() {
56          this(NodeTypes.Page.NAME);
57      }
58  
59      public NavigationItemPredicate(String nodeType) {
60          this.nodeType = nodeType;
61      }
62  
63      @Override
64      public boolean evaluateTyped(Node node) {
65          try {
66              return node.isNodeType(nodeType) && !(node.hasProperty(NavigationTemplatingFunctions.HIDE_IN_NAVIGATION_PROPERTY_NAME) && node.getProperty(NavigationTemplatingFunctions.HIDE_IN_NAVIGATION_PROPERTY_NAME).getBoolean());
67          } catch (RepositoryException e) {
68              log.error("Failed to resolve if node {} should be visible in navigation.", node, e);
69          }
70          return false;
71      }
72  }