1 /**
2 * This file Copyright (c) 2009-2010 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.module.delta;
35
36 import info.magnolia.cms.core.Content;
37 import info.magnolia.cms.core.ItemType;
38 import info.magnolia.cms.core.search.Query;
39 import info.magnolia.cms.util.QueryUtil;
40 import info.magnolia.module.InstallContext;
41
42 import javax.jcr.RepositoryException;
43 import java.util.Collection;
44 import java.util.Iterator;
45
46 /**
47 * An abstract task to perform operations on nodes returned by a given query.
48 * Keep in mind that results returned by a query will reflect the current
49 * content of the repository, not of your session; i.e if a previous task
50 * modified a property, the query might still return the node as if it had
51 * the previous value.
52 *
53 * @author gjoseph
54 * @version $Revision: $ ($Author: $)
55 */
56 public abstract class QueryTask extends AbstractRepositoryTask {
57 private final String repositoryName;
58 private final String query;
59
60 public QueryTask(String name, String description, String repositoryName, String query) {
61 super(name, description);
62 this.repositoryName = repositoryName;
63 this.query = query;
64 }
65
66 protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
67 final Collection<Content> nodes = QueryUtil.exceptionThrowingQuery(repositoryName, query, Query.SQL, ItemType.NT_BASE);
68 final Iterator<Content> it = nodes.iterator();
69 for (Content paragraphNode : nodes) {
70 operateOnNode(installContext, paragraphNode);
71 }
72 }
73
74 protected abstract void operateOnNode(InstallContext installContext, Content node);
75 }