org.omnifaces.facesconfigparser.digester.rules.DescriptionTextRule Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.omnifaces.facesconfigparser.digester.rules;
import org.apache.commons.digester.NodeCreateRule;
import org.omnifaces.facesconfigparser.digester.beans.DescriptionBean;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.Attributes;
/**
*
* Digester rule for the <description> element, used to absorb the body content of the matching
* element even if it contains mixed markup and body content, and then save it as the value of the
* description property of the corresponding DescriptionBean instance..
*
*/
public class DescriptionTextRule extends NodeCreateRule {
// ------------------------------------------------------------- Constructor
/**
*
* Construct a variant of NodeCreateRule that will create a DocumentFragment object.
*
* @throws Exception something went wrong
*/
public DescriptionTextRule() throws Exception {
super(Node.DOCUMENT_FRAGMENT_NODE);
}
// ------------------------------------------------------------ Rule Methods
/**
*
* Ensure that the object at the top of the stack is a DescriptionBean, then perform the standard
* superclass processing.
*
*
* @param namespace the namespace URI of the matching element, or an empty string if the parser is not namespace aware
* or the element has no namespace
* @param name the local name if the parser is namespace aware, or just the element name otherwise
* @param attributes The attribute list of this element
*
* @exception IllegalStateException if the parent stack element is not of type FeatureBean
*/
@Override
public void begin(String namespace, String name, Attributes attributes) throws Exception {
assert digester.peek() instanceof DescriptionBean : "Assertion Error: Expected DescriptionBean to be at the top of the stack";
// Perform our standard superclass processing
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug("[DescriptionTextRule]{" + digester.getMatch() + "} Begin");
}
super.begin(namespace, name, attributes);
}
/**
*
* No body processing is required.
*
*
* @param namespace the namespace URI of the matching element, or an empty string if the parser is not namespace aware
* or the element has no namespace
* @param name the local name if the parser is namespace aware, or just the element name otherwise
* @param text The text of the body of this element
*/
@Override
public void body(String namespace, String name, String text) throws Exception {
}
/**
*
* Serialize the resulting DOM into text, and use it to set the description property of the parent
* DescriptionBean.
*
*
* @param namespace the namespace URI of the matching element, or an empty string if the parser is not namespace aware
* or the element has no namespace
* @param name the local name if the parser is namespace aware, or just the element name otherwise
*
* @exception IllegalStateException if the popped object is not of the correct type
*/
@Override
public void end(String namespace, String name) throws Exception {
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug("[DescriptionTextRule]{" + digester.getMatch() + "} End (" + digester.peek() + ")");
}
// Pop the DOM object off the stack (works around a bug in
// NodeCreateRule that won't be fixed until version 1.6 of
// commons-digester is released)
Node root = (Node) digester.pop();
// Serialize the child nodes into a StringBuffer
DescriptionBean db = (DescriptionBean) digester.peek();
StringBuffer sb = new StringBuffer();
NodeList kids = root.getChildNodes();
int n = kids.getLength();
for (int i = 0; i < n; i++) {
serialize(sb, kids.item(i));
}
// Use the StringBuffer to set the value of the description property
db.setDescription(sb.toString());
}
/**
*
* No finish processing is required.
*
*
*/
@Override
public void finish() throws Exception {
}
// ---------------------------------------------------------- Public Methods
@Override
public String toString() {
StringBuffer sb = new StringBuffer("DescriptionTextRule[]");
return (sb.toString());
}
// --------------------------------------------------------- Package Methods
// --------------------------------------------------------- Private Methods
/**
*
* Append the serialized version of the specified node to the string buffer being accumulated.
*
*
* @param sb StringBuffer to which serialized text is appended
* @param node Node to be serialized
*
* @exception Exception if any processing exception occurs
*/
private void serialize(StringBuffer sb, Node node) throws Exception {
// Processing depends on the node type
switch (node.getNodeType()) {
case Node.ELEMENT_NODE:
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug(" Processing element node '" + node.getNodeName() + "'");
}
// Open the element and echo the attributes
sb.append("<");
sb.append(node.getNodeName());
NamedNodeMap attrs = node.getAttributes();
int n = attrs.getLength();
for (int i = 0; i < n; i++) {
Node attr = attrs.item(i);
sb.append(" ");
sb.append(attr.getNodeName());
sb.append("=\"");
sb.append(attr.getNodeValue());
sb.append("\"");
}
// Does this element have any children?
NodeList kids = node.getChildNodes();
int m = kids.getLength();
if (m > 0) {
// Yes -- serialize child elements and close parent element
sb.append(">");
for (int j = 0; j < m; j++) {
serialize(sb, kids.item(j));
}
sb.append("");
} else {
// No -- shorthand close of the parent element
sb.append(" />");
}
break;
case Node.TEXT_NODE:
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug(" Processing text node '" + node.getNodeValue() + "'");
}
// Append the text to our accumulating buffer
sb.append(node.getNodeValue());
break;
default:
throw new IllegalArgumentException("Cannot process node '" + node.getNodeName() + "' of type '" + node.getNodeType());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy