1 /**
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.decima.xml.templating.document.post.template;
28
29 import gov.nist.secauto.decima.core.util.ObjectUtil;
30
31 import org.jdom2.Element;
32 import org.jdom2.filter.Filters;
33 import org.jdom2.xpath.XPathFactory;
34
35 import java.util.List;
36 import java.util.Map;
37
38 /**
39 * Replaces existing elements returned by an XPath query over an XML document with one or more new
40 * elements.
41 */
42 public class ReplaceAction
43 extends AbstractXPathAction<Element> {
44 private final List<Element> contentNodes;
45
46 /**
47 * Construct a new ReplaceAction based on an XPath string using the provided map to map XML prefixes
48 * to namespaces within the XPath.
49 *
50 * @param xpathFactory
51 * the XPath implementation to use
52 * @param xpath
53 * the XPath string
54 * @param prefixToNamespaceMap
55 * a map of XML prefixes to namespaces used in the provided XPath
56 * @param contentNodes
57 * a list of new elements to use as the replacement
58 */
59 public ReplaceAction(XPathFactory xpathFactory, String xpath, Map<String, String> prefixToNamespaceMap,
60 List<Element> contentNodes) {
61 super(xpathFactory, xpath, Filters.element(), prefixToNamespaceMap);
62 ObjectUtil.requireNonEmpty(contentNodes);
63 this.contentNodes = contentNodes;
64 }
65
66 /**
67 * Retrieves the elements to use as the replacement.
68 *
69 * @return a list of elements
70 */
71 public List<Element> getContentNodes() {
72 return contentNodes;
73 }
74
75 /**
76 * Replaces existing elements based on the provided XPath results.
77 */
78 @Override
79 protected void process(List<Element> results) throws ActionException {
80 for (Element child : results) {
81 if (child.isRootElement()) {
82 throw new ActionProcessingException(
83 "ReplaceAction: the selected element must not be the root element of the document");
84 }
85 Element parent = child.getParentElement();
86 int index = parent.indexOf(child);
87
88 boolean extraElement = false;
89 for (Element newElement : getContentNodes()) {
90 // Make a copy to insert into the DOM
91 newElement = newElement.clone();
92
93 if (extraElement) {
94 if (index >= parent.getContentSize()) {
95 parent.addContent(newElement);
96 } else {
97 parent.addContent(index, newElement);
98 }
99 } else {
100 parent.setContent(index, newElement);
101 extraElement = true;
102 }
103 index++;
104 }
105
106 child.detach();
107 }
108 }
109 }