1 /**
2 * This file Copyright (c) 2011-2012 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.jcr.iterator;
35
36 import info.magnolia.jcr.decoration.ContentDecorator;
37 import info.magnolia.jcr.predicate.AbstractPredicate;
38 import info.magnolia.jcr.wrapper.NodeWrapperFactory;
39
40 import javax.jcr.Node;
41 import javax.jcr.NodeIterator;
42
43 /**
44 * NodeIterator hiding all nodes that do not pass the predicate, returned nodes can also be wrapped effectively
45 * extending the condition to the whole hierarchy.
46 */
47 public class FilteringNodeIterator extends FilteringRangeIterator<Node> implements NodeIterator {
48
49 /**
50 * @deprecated since 4.5.9 use {@link ContentDecorator} instead.
51 */
52 private NodeWrapperFactory wrapperFactory;
53 private AbstractPredicate<Node> predicate;
54 private ContentDecorator decorator;
55
56 public FilteringNodeIterator(NodeIterator nodeIterator, AbstractPredicate<Node> predicate) {
57 super(nodeIterator);
58 this.predicate = predicate;
59 }
60
61 public FilteringNodeIterator(NodeIterator nodeIterator, AbstractPredicate<Node> predicate, ContentDecorator decorator) {
62 super(nodeIterator);
63 this.predicate = predicate;
64 this.decorator = decorator;
65 }
66
67 /**
68 * @deprecated since 4.5.9 use {@link FilteringNodeIterator#FilteringNodeIterator(NodeIterator, AbstractPredicate, ContentDecorator)} instead.
69 */
70 public FilteringNodeIterator(NodeIterator nodeIterator, AbstractPredicate<Node> predicate, NodeWrapperFactory wrapperFactory) {
71 super(nodeIterator);
72 this.wrapperFactory = wrapperFactory;
73 this.predicate = predicate;
74 }
75
76 @Override
77 public Node next() {
78 return wrapNode(super.next());
79 }
80
81 @Override
82 public Node nextNode() {
83 return wrapNode(super.next());
84 }
85
86 protected Node wrapNode(Node node) {
87 if (decorator != null) {
88 return decorator.wrapNode(node);
89 } else if (wrapperFactory != null) {
90 return wrapperFactory.wrapNode(node);
91 } else {
92 return node;
93 }
94 }
95
96 @Override
97 protected boolean evaluate(Node node) {
98 return predicate == null || predicate.evaluate(node);
99 }
100 }