View Javadoc

1   /**
2    * This file Copyright (c) 2008-2011 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.templating.setup.for4_0;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.HierarchyManager;
38  import info.magnolia.cms.util.ContentUtil;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.module.delta.AllModulesNodeOperation;
41  import info.magnolia.module.delta.TaskExecutionException;
42  
43  import javax.jcr.RepositoryException;
44  import javax.jcr.Value;
45  
46  /**
47   * Renames a property found in a given subnode of all modules; typically, renames "path" to "templatePath"
48   * for all nodes under "paragraphs" for each module.
49   */
50  public class RenamePropertyAllModulesNodeTask extends AllModulesNodeOperation {
51      private final String srcPropertyName;
52      private final String destPropertyName;
53      private final String baseNodeName;
54  
55      public RenamePropertyAllModulesNodeTask(String name, String description, String baseNodeName, String srcPropertyName, String destPropertyName) {
56          super(name, description);
57          this.baseNodeName = baseNodeName;
58          this.srcPropertyName = srcPropertyName;
59          this.destPropertyName = destPropertyName;
60      }
61  
62      protected void operateOnModuleNode(Content node, HierarchyManager hm, InstallContext ctx) throws RepositoryException, TaskExecutionException {
63          try {
64              if (node.hasContent(baseNodeName)) {
65                  ContentUtil.visit(node.getContent(baseNodeName), new ContentUtil.Visitor() {
66                      public void visit(Content subNode) throws Exception {
67                          if (subNode.hasNodeData(srcPropertyName)) {
68                              final Value value = subNode.getNodeData(srcPropertyName).getValue();
69                              subNode.deleteNodeData(srcPropertyName);
70                              subNode.setNodeData(destPropertyName, value);
71                          }
72                      }
73                  });
74              }
75          } catch (RepositoryException e) {
76              throw e;
77          } catch (Exception e) {
78              // should not happen, but is a relict of info.magnolia.cms.util.ContentUtil#visit
79              throw new TaskExecutionException(e.getMessage(), e);
80          }
81      }
82  }
83