1 /**
2 * This file Copyright (c) 2009-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.nodebuilder;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.Content.ContentFilter;
38 import info.magnolia.cms.core.ItemType;
39 import info.magnolia.cms.util.ContentUtil;
40 import info.magnolia.cms.util.NodeTypeFilter;
41
42 import javax.jcr.RepositoryException;
43
44 /**
45 * Visits the hierarchy recursively and executes the operations on all nodes matching the filter. The recursion does not stop if a node does not match!
46 * The class has some static methods to build recursive operations easily.
47 *
48 * @deprecated since 5.2.4 - looks like it's not used anywhere so it'll be dropped without replacement. Raise your voice if you need a RecursiveOp operating on jcr API.
49 */
50 @Deprecated
51 public class RecursiveOp extends AbstractNodeOperation {
52
53 /**
54 * Visits the hierarchy recursively and executes the operations on all nodes excluding meta data and jcr base nodes. The recursion does not stop if a node does not match!
55 */
56 public static NodeOperation recursive(final NodeOperation... childrenOps) {
57 return recursive(ContentUtil.EXCLUDE_META_DATA_CONTENT_FILTER, childrenOps);
58 }
59
60 /**
61 * Visits the hierarchy recursively and executes the operations on all nodes matching a certain type. The recursion does not stop if a node does not match!
62 */
63 public static NodeOperation recursive(final String type, final NodeOperation... childrenOps) {
64 return recursive(new NodeTypeFilter(type), childrenOps);
65 }
66
67 /**
68 * Visits the hierarchy recursively and executes the operations on all nodes matching a certain type. The recursion does not stop if a node does not match!
69 */
70 public static NodeOperation recursive(final ItemType type, final NodeOperation... childrenOps) {
71 return recursive(new NodeTypeFilter(type), childrenOps);
72 }
73
74 public static NodeOperation recursive(final Content.ContentFilter filter, final NodeOperation... childrenOps) {
75 return new RecursiveOp(filter, childrenOps);
76 }
77
78 private final ContentFilter filter;
79
80 private final NodeOperation[] childrenOps;
81
82 /**
83 * Visits the hierarchy recursively and executes the operations on all nodes matching the filter. The recursion does not stop if a node does not match!
84 */
85 public RecursiveOp(ContentFilter filter, NodeOperation[] childrenOps) {
86 this.filter = filter;
87 this.childrenOps = childrenOps;
88 }
89
90 @Override
91 protected Content="../../../info/magnolia/cms/core/Content.html#Content">Content doExec(Content context, final ErrorHandler errorHandler) throws RepositoryException {
92 try {
93 ContentUtil.visit(context, new ContentUtil.Visitor() {
94 @Override
95 public void visit(Content node) throws Exception {
96 if (filter.accept(node)) {
97 for (NodeOperation nodeOperation : childrenOps) {
98 nodeOperation.exec(node, errorHandler);
99 }
100 }
101 }
102 }, ContentUtil.ALL_NODES_CONTENT_FILTER);
103 } catch (Exception e) {
104 if (e instanceof RepositoryException) {
105 throw (RepositoryException) e;
106 }
107 throw new RuntimeException(e);
108 }
109 return context;
110 }
111 }