net.sf.jasperreports.engine.xml.JRComponentRule Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2022 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.engine.xml;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.component.Component;
import net.sf.jasperreports.engine.component.ComponentKey;
import net.sf.jasperreports.engine.design.JRDesignComponentElement;
import org.apache.commons.digester.Rule;
/**
* A digester rule that links a {@link Component} object with its parent
* {@link JRDesignComponentElement}.
*
*
* This rules also sets the {@link ComponentKey component type key} on the
* component element via
* {@link JRDesignComponentElement#setComponentKey(ComponentKey)}.
* The component type key is created based on information from the XML
* component node; the node namespace is used as component type namespace
* and the node name is used as component name.
*
* @author Lucian Chirita ([email protected])
*/
public class JRComponentRule extends Rule
{
public static final String EXCEPTION_MESSAGE_KEY_INVALID_INSTANCE = "xml.component.rule.invalid.instance";
public static JRComponentRule newInstance()
{
return new JRComponentRule();
}
@Override
public void end(String namespace, String name) throws JRException
{
Object top = getDigester().peek();
if (!(top instanceof Component))
{
throw
new JRException(
EXCEPTION_MESSAGE_KEY_INVALID_INSTANCE,
new Object[]{top.getClass().getName(), Component.class.getName()});
}
Component component = (Component) top;
JRDesignComponentElement componentElement = (JRDesignComponentElement) getDigester().peek(1);
String namespacePrefix = ((JRXmlDigester) getDigester()).getLastNamespacePrefix();
ComponentKey componentKey = new ComponentKey(namespace, namespacePrefix, name);
componentElement.setComponentKey(componentKey);
componentElement.setComponent(component);
}
}