net.sf.jasperreports.engine.xml.JRPrintXmlLoader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 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 java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import org.apache.commons.digester.SetNestedPropertiesRule;
import org.apache.commons.digester.SetPropertiesRule;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import net.sf.jasperreports.engine.DefaultJasperReportsContext;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRFont;
import net.sf.jasperreports.engine.JROrigin;
import net.sf.jasperreports.engine.JRPrintElement;
import net.sf.jasperreports.engine.JRPrintHyperlinkParameter;
import net.sf.jasperreports.engine.JRPrintPage;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRStyle;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.PrintBookmark;
import net.sf.jasperreports.engine.TabStop;
import net.sf.jasperreports.engine.util.CompositeClassloader;
/**
* Utility class that helps reconverting XML documents into
* {@link net.sf.jasperreports.engine.JasperPrint} objects.
*
* Generated documents can be stored in XML format if they are exported using the
* {@link net.sf.jasperreports.engine.export.JRXmlExporter}. After they're exported,
* one can parse them back into {@link net.sf.jasperreports.engine.JasperPrint} objects
* by using this class.
*
* @author Teodor Danciu ([email protected])
*/
public class JRPrintXmlLoader implements ErrorHandler
{
private static final Log log = LogFactory.getLog(JRPrintXmlLoader.class);
/**
*
*/
private final JasperReportsContext jasperReportsContext;
private JasperPrint jasperPrint;
private List errors = new ArrayList();
/**
*
*/
protected JRPrintXmlLoader(JasperReportsContext jasperReportsContext)
{
this.jasperReportsContext = jasperReportsContext;
}
/**
*
*/
public JasperReportsContext getJasperReportsContext()
{
return jasperReportsContext;
}
/**
*
*/
public void setJasperPrint(JasperPrint jasperPrint)
{
this.jasperPrint = jasperPrint;
}
/**
*
*/
public static JasperPrint loadFromFile(JasperReportsContext jasperReportsContext, String sourceFileName) throws JRException
{
JasperPrint jasperPrint = null;
FileInputStream fis = null;
try
{
fis = new FileInputStream(sourceFileName);
JRPrintXmlLoader printXmlLoader = new JRPrintXmlLoader(jasperReportsContext);
jasperPrint = printXmlLoader.loadXML(fis);
}
catch(IOException e)
{
throw new JRException(e);
}
finally
{
if (fis != null)
{
try
{
fis.close();
}
catch(IOException e)
{
}
}
}
return jasperPrint;
}
/**
* @see #loadFromFile(JasperReportsContext, String)
*/
public static JasperPrint loadFromFile(String sourceFileName) throws JRException
{
return loadFromFile(DefaultJasperReportsContext.getInstance(), sourceFileName);
}
/**
* @see #loadFromFile(String)
*/
public static JasperPrint load(String sourceFileName) throws JRException
{
return loadFromFile(sourceFileName);
}
/**
*
*/
public static JasperPrint load(JasperReportsContext jasperReportsContext, InputStream is) throws JRException
{
JasperPrint jasperPrint = null;
JRPrintXmlLoader printXmlLoader = new JRPrintXmlLoader(jasperReportsContext);
jasperPrint = printXmlLoader.loadXML(is);
return jasperPrint;
}
/**
* @see #load(JasperReportsContext, InputStream)
*/
public static JasperPrint load(InputStream is) throws JRException
{
return load(DefaultJasperReportsContext.getInstance(), is);
}
/**
*
*/
private JasperPrint loadXML(InputStream is) throws JRException
{
try
{
JRXmlDigester digester = prepareDigester();
/* */
digester.parse(is);
}
catch(ParserConfigurationException e)
{
throw new JRException(e);
}
catch(SAXException e)
{
throw new JRException(e);
}
catch(IOException e)
{
throw new JRException(e);
}
if (errors.size() > 0)
{
Exception e = errors.get(0);
if (e instanceof JRException)
{
throw (JRException)e;
}
throw new JRException(e);
}
return this.jasperPrint;
}
/**
*
*/
protected JRXmlDigester prepareDigester() throws ParserConfigurationException, SAXException
{
JRXmlDigester digester = new JRXmlDigester(createParser());
// use a classloader that resolves both JR classes and classes from the context classloader
CompositeClassloader digesterClassLoader = new CompositeClassloader(
JRPrintXmlLoader.class.getClassLoader(),
Thread.currentThread().getContextClassLoader());
digester.setClassLoader(digesterClassLoader);
digester.setNamespaceAware(true);
digester.setRuleNamespaceURI(JRXmlConstants.JASPERPRINT_NAMESPACE);
digester.push(this);
//digester.setDebug(3);
digester.setErrorHandler(this);
digester.setValidating(true);
/* */
digester.addFactoryCreate("jasperPrint", JasperPrintFactory.class.getName());
digester.addSetNext("jasperPrint", "setJasperPrint", JasperPrint.class.getName());
/* */
digester.addFactoryCreate("*/property", JRPropertyFactory.class.getName());
digester.addCallMethod("*/property", "setValue", 0);
/* */
digester.addFactoryCreate("jasperPrint/origin", JROriginFactory.class.getName());
digester.addSetNext("jasperPrint/origin", "addOrigin", JROrigin.class.getName());
/* */
digester.addFactoryCreate("jasperPrint/reportFont", JRStyleFactory.class.getName());
digester.addSetNext("jasperPrint/reportFont", "addStyle", JRStyle.class.getName());
/* */
digester.addFactoryCreate("jasperPrint/style", JRPrintStyleFactory.class.getName());
digester.addSetNext("jasperPrint/style", "addStyle", JRStyle.class.getName());
/* */
digester.addFactoryCreate("*/style/pen", JRPenFactory.Style.class.getName());
/* */
digester.addFactoryCreate("*/bookmark", PrintBookmarkFactory.class.getName());
digester.addSetNext("*/bookmark", "addBookmark", PrintBookmark.class.getName());
/* */
digester.addFactoryCreate("jasperPrint/part", PrintPartFactory.class.getName());
/* */
digester.addFactoryCreate("jasperPrint/page", JRPrintPageFactory.class.getName());
digester.addSetNext("jasperPrint/page", "addPage", JRPrintPage.class.getName());
/* */
digester.addFactoryCreate("*/line", JRPrintLineFactory.class.getName());
digester.addSetNext("*/line", "addElement", JRPrintElement.class.getName());
/* */
digester.addFactoryCreate("*/reportElement", JRPrintElementFactory.class.getName());
/* */
digester.addFactoryCreate("*/graphicElement", JRPrintGraphicElementFactory.class.getName());
/* */
digester.addFactoryCreate("*/pen", JRPenFactory.class.getName());
/* */
digester.addFactoryCreate("*/rectangle", JRPrintRectangleFactory.class.getName());
digester.addSetNext("*/rectangle", "addElement", JRPrintElement.class.getName());
/* */
digester.addFactoryCreate("*/ellipse", JRPrintEllipseFactory.class.getName());
digester.addSetNext("*/ellipse", "addElement", JRPrintElement.class.getName());
/* */
digester.addFactoryCreate("*/image", JRPrintImageFactory.class.getName());
digester.addSetNext("*/image", "addElement", JRPrintElement.class.getName());
/* */
digester.addFactoryCreate("*/box", JRBoxFactory.class.getName());
/* */
digester.addFactoryCreate("*/box/pen", JRPenFactory.Box.class.getName());
digester.addFactoryCreate("*/box/topPen", JRPenFactory.Top.class.getName());
digester.addFactoryCreate("*/box/leftPen", JRPenFactory.Left.class.getName());
digester.addFactoryCreate("*/box/bottomPen", JRPenFactory.Bottom.class.getName());
digester.addFactoryCreate("*/box/rightPen", JRPenFactory.Right.class.getName());
/* */
digester.addFactoryCreate("*/paragraph", JRParagraphFactory.class.getName());
digester.addFactoryCreate("*/paragraph/tabStop", TabStopFactory.class.getName());
digester.addSetNext("*/paragraph/tabStop", "addTabStop", TabStop.class.getName());
/* */
digester.addFactoryCreate("*/image/imageSource", JRPrintImageSourceFactory.class.getName());
digester.addCallMethod("*/image/imageSource", "setImageSource", 0);
/* */
digester.addFactoryCreate("*/text", JRPrintTextFactory.class.getName());
digester.addSetNext("*/text", "addElement", JRPrintElement.class.getName());
SetNestedPropertiesRule textRule = new SetNestedPropertiesRule(
new String[]{"textContent", "textTruncateSuffix", "reportElement", "box", "font",
JRXmlConstants.ELEMENT_lineBreakOffsets},
new String[]{"text", "textTruncateSuffix"});
textRule.setTrimData(false);
textRule.setAllowUnknownChildElements(true);
digester.addRule("*/text", textRule);
digester.addRule("*/text/textContent",
new SetPropertiesRule(JRXmlConstants.ATTRIBUTE_truncateIndex, "textTruncateIndex"));
/* */
digester.addFactoryCreate("*/text/font", JRPrintFontFactory.class.getName());
digester.addSetNext("*/text/font", "setFont", JRFont.class.getName());
digester.addRule("*/text/" + JRXmlConstants.ELEMENT_lineBreakOffsets,
new TextLineBreakOffsetsRule());
addFrameRules(digester);
addHyperlinkParameterRules(digester);
addGenericElementRules(digester);
return digester;
}
protected SAXParser createParser()
{
String parserFactoryClass = JRPropertiesUtil.getInstance(jasperReportsContext).getProperty(
JRSaxParserFactory.PROPERTY_PRINT_PARSER_FACTORY);
if (log.isDebugEnabled())
{
log.debug("Using SAX parser factory class " + parserFactoryClass);
}
JRSaxParserFactory factory = BaseSaxParserFactory.getFactory(jasperReportsContext, parserFactoryClass);
return factory.createParser();
}
private void addFrameRules(JRXmlDigester digester)
{
digester.addFactoryCreate("*/frame", JRPrintFrameFactory.class.getName());
digester.addSetNext("*/frame", "addElement", JRPrintElement.class.getName());
}
protected void addHyperlinkParameterRules(JRXmlDigester digester)
{
String parameterPattern = "*/" + JRXmlConstants.ELEMENT_hyperlinkParameter;
digester.addFactoryCreate(parameterPattern, JRPrintHyperlinkParameterFactory.class);
digester.addSetNext(parameterPattern, "addHyperlinkParameter", JRPrintHyperlinkParameter.class.getName());
String parameterValuePattern = parameterPattern + "/" + JRXmlConstants.ELEMENT_hyperlinkParameterValue;
digester.addFactoryCreate(parameterValuePattern, JRPrintHyperlinkParameterValueFactory.class);
digester.addCallMethod(parameterValuePattern, "setData", 0);
}
protected void addGenericElementRules(JRXmlDigester digester)
{
String elementPattern = "*/" + JRXmlConstants.ELEMENT_genericElement;
digester.addFactoryCreate(elementPattern,
JRGenericPrintElementFactory.class);
digester.addSetNext(elementPattern, "addElement",
JRPrintElement.class.getName());
String elementTypePattern = elementPattern + "/"
+ JRXmlConstants.ELEMENT_genericElementType;
digester.addFactoryCreate(elementTypePattern,
JRGenericElementTypeFactory.class);
digester.addSetNext(elementTypePattern, "setGenericType");
String elementParameterPattern = elementPattern + "/"
+ JRXmlConstants.ELEMENT_genericElementParameter;
digester.addFactoryCreate(elementParameterPattern,
JRGenericPrintElementParameterFactory.class);
digester.addCallMethod(elementParameterPattern, "addParameter");
digester.addRule(elementParameterPattern, new JRGenericPrintElementParameterFactory.ArbitraryValueSetter());
String elementParameterValuePattern = elementParameterPattern + "/"
+ JRXmlConstants.ELEMENT_genericElementParameterValue;
digester.addFactoryCreate(elementParameterValuePattern,
JRGenericPrintElementParameterFactory.ParameterValueFactory.class);
digester.addCallMethod(elementParameterValuePattern, "setData", 0);
addValueHandlerRules(digester, elementParameterPattern);
}
protected void addValueHandlerRules(JRXmlDigester digester, String elementParameterPattern)
{
List handlers = XmlValueHandlerUtils.instance().getHandlers();
for (XmlValueHandler handler : handlers)
{
XmlHandlerNamespace namespace = handler.getNamespace();
if (namespace != null)
{
String namespaceURI = namespace.getNamespaceURI();
if (log.isDebugEnabled())
{
log.debug("Configuring the digester for handler " + handler
+ " and namespace " + namespaceURI);
}
digester.setRuleNamespaceURI(namespaceURI);
handler.configureDigester(digester);
String schemaResource = namespace.getInternalSchemaResource();
digester.addInternalEntityResource(namespace.getPublicSchemaLocation(),
schemaResource);
}
}
digester.setRuleNamespaceURI(JRXmlConstants.JASPERPRINT_NAMESPACE);
}
/**
*
*/
public void addError(Exception e)
{
this.errors.add(e);
}
@Override
public void error(SAXParseException e)
{
this.errors.add(e);
}
@Override
public void fatalError(SAXParseException e)
{
this.errors.add(e);
}
@Override
public void warning(SAXParseException e)
{
this.errors.add(e);
}
}