All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.sf.jasperreports.engine.export.JRXmlExporter Maven / Gradle / Ivy

There is a newer version: 6.21.3
Show newest version
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2014 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 .
 */

/*
 * Contributors:
 * Joakim Sandstr�m - [email protected]
 */
package net.sf.jasperreports.engine.export;

import java.awt.Dimension;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import net.sf.jasperreports.engine.DefaultJasperReportsContext;
import net.sf.jasperreports.engine.JRAbstractExporter;
import net.sf.jasperreports.engine.JRAnchor;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRFont;
import net.sf.jasperreports.engine.JRGenericElementType;
import net.sf.jasperreports.engine.JRGenericPrintElement;
import net.sf.jasperreports.engine.JRImageRenderer;
import net.sf.jasperreports.engine.JRLineBox;
import net.sf.jasperreports.engine.JROrigin;
import net.sf.jasperreports.engine.JRParagraph;
import net.sf.jasperreports.engine.JRPen;
import net.sf.jasperreports.engine.JRPrintElement;
import net.sf.jasperreports.engine.JRPrintEllipse;
import net.sf.jasperreports.engine.JRPrintFrame;
import net.sf.jasperreports.engine.JRPrintGraphicElement;
import net.sf.jasperreports.engine.JRPrintHyperlink;
import net.sf.jasperreports.engine.JRPrintHyperlinkParameter;
import net.sf.jasperreports.engine.JRPrintHyperlinkParameters;
import net.sf.jasperreports.engine.JRPrintImage;
import net.sf.jasperreports.engine.JRPrintLine;
import net.sf.jasperreports.engine.JRPrintPage;
import net.sf.jasperreports.engine.JRPrintRectangle;
import net.sf.jasperreports.engine.JRPrintText;
import net.sf.jasperreports.engine.JRPropertiesHolder;
import net.sf.jasperreports.engine.JRPropertiesMap;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.JRStyle;
import net.sf.jasperreports.engine.JRWrappingSvgRenderer;
import net.sf.jasperreports.engine.JasperReportsContext;
import net.sf.jasperreports.engine.PrintBookmark;
import net.sf.jasperreports.engine.PrintPageFormat;
import net.sf.jasperreports.engine.PrintPart;
import net.sf.jasperreports.engine.PrintParts;
import net.sf.jasperreports.engine.Renderable;
import net.sf.jasperreports.engine.TabStop;
import net.sf.jasperreports.engine.type.HyperlinkTargetEnum;
import net.sf.jasperreports.engine.type.HyperlinkTypeEnum;
import net.sf.jasperreports.engine.type.LineDirectionEnum;
import net.sf.jasperreports.engine.type.ModeEnum;
import net.sf.jasperreports.engine.type.OnErrorTypeEnum;
import net.sf.jasperreports.engine.type.OrientationEnum;
import net.sf.jasperreports.engine.type.RenderableTypeEnum;
import net.sf.jasperreports.engine.type.RunDirectionEnum;
import net.sf.jasperreports.engine.util.JRValueStringUtils;
import net.sf.jasperreports.engine.util.JRXmlWriteHelper;
import net.sf.jasperreports.engine.util.VersionComparator;
import net.sf.jasperreports.engine.util.XmlNamespace;
import net.sf.jasperreports.engine.xml.JRXmlBaseWriter;
import net.sf.jasperreports.engine.xml.JRXmlConstants;
import net.sf.jasperreports.engine.xml.XmlValueHandlerUtils;
import net.sf.jasperreports.export.ExportInterruptedException;
import net.sf.jasperreports.export.ExporterConfiguration;
import net.sf.jasperreports.export.ReportExportConfiguration;
import net.sf.jasperreports.export.WriterExporterOutput;

import org.w3c.tools.codec.Base64Encoder;


/**
 * Exports a JasperReports document to an XML file that contains the same data as a 
 * {@link net.sf.jasperreports.engine.JasperPrint} object, but in XML format, instead 
 * of a serialized class. As report templates are defined using the
 * special XML syntax JRXML, the JasperReports library also has a special XML structure
 * for storing generated documents in XML format. This format is called JRPXML because
 * the files produced by the JRXmlExporter usually have the *.jrpxml extension.
 * 

* Such XML files can be parsed back into * {@link net.sf.jasperreports.engine.JasperPrint} * object using the {@link net.sf.jasperreports.engine.xml.JRPrintXmlLoader} utility class. * Their structure is validated against an internal XSD file called jasperprint.xsd, * that provides the details of the JRPXML structure. Valid JRPXML files * should point to the internal XSD file using a public location, as follows: *

 * <?xml version="1.0" encoding="UTF-8"?>
 * <jasperPrint 
 *   xmlns="http://jasperreports.sourceforge.net/jasperreports/print" 
 *   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 *   xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports/print http://jasperreports.sourceforge.net/xsd/jasperprint.xsd"
 *   ...>
 * 
* The root element of a JRPXML document is <jasperPrint>, which contains a list of * report custom properties (<property> tags), a list of element origins * (<origin> tags), a list of * report style definitions (<style> tags) that are reused by report elements throughout * the document, and a list of pages (<page> tags), each of which contains a nested list of * elements like lines, rectangles, ellipses, images, and texts. *

* The quality of this exporter is equal to the Graphics2D exporter because it preserves * 100% of the initial document content and properties. There is no loss in document * quality when exporting to XML because the resulting XML content can be loaded back * into a {@link net.sf.jasperreports.engine.JasperPrint} object that will look the same as the original one. *

* The built-in viewers can display documents exported in JRPXML format because they * actually rely on the {@link net.sf.jasperreports.engine.xml.JRPrintXmlLoader} to load the * document back into a {@link net.sf.jasperreports.engine.JasperPrint} object before * rendering it on the screen. *

Embedding Images

* When exporting XML, pay special attention to how images are stored. The two ways are * as follows: *
    *
  • If the exporter outputs to a file on disk, it stores the images contained by the source * document in separate files that accompany the main JRPXML file. The image files * are put in a directory that takes its name from the original destination file name * plus the _files suffix, the same directory as the JRPXML file.
  • *
  • The exporter can embed images in the JRPXML file itself by encoding their binary * data using a Base64 encoder. This simplifies transfer over the network or by direct * output to streams.
  • *
*

* To determine how to handle images, set the * {@link net.sf.jasperreports.export.XmlExporterOutput#isEmbeddingImages() isEmbeddingImages()} * exporter output flag, * which expects a java.lang.Boolean. By default, the images are embedded in the * resulting XML. * * @see net.sf.jasperreports.engine.JasperPrint * @see net.sf.jasperreports.engine.xml.JRPrintXmlLoader * @author Teodor Danciu ([email protected]) */ public class JRXmlExporter extends JRAbstractExporter { /** * */ private static final String XML_EXPORTER_PROPERTIES_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "export.xml."; /** * The exporter key, as used in * {@link GenericElementHandlerEnviroment#getElementHandler(JRGenericElementType, String)}. */ public static final String XML_EXPORTER_KEY = JRPropertiesUtil.PROPERTY_PREFIX + "xml"; private static final String PROPERTY_START_PAGE_INDEX = JRPropertiesUtil.PROPERTY_PREFIX + "export.xml.start.page.index"; private static final String PROPERTY_END_PAGE_INDEX = JRPropertiesUtil.PROPERTY_PREFIX + "export.xml.end.page.index"; private static final String PROPERTY_PAGE_COUNT = JRPropertiesUtil.PROPERTY_PREFIX + "export.xml.page.count"; /** * Stores the text sequence used to replace invalid XML characters */ public static final String PROPERTY_REPLACE_INVALID_CHARS = JRPropertiesUtil.PROPERTY_PREFIX + "export.xml.replace.invalid.chars";//FIXMEEXPORT do something about it protected static final String DEFAULT_OBJECT_TYPE = "java.lang.String"; protected static final String IMAGE_PREFIX = "img_"; public static final XmlNamespace JASPERPRINT_NAMESPACE = new XmlNamespace(JRXmlConstants.JASPERPRINT_NAMESPACE, null, JRXmlConstants.JASPERPRINT_XSD_SYSTEM_ID); /** * */ protected JRXmlWriteHelper xmlWriter; protected String version; protected VersionComparator versionComparator = new VersionComparator(); protected Map rendererToImagePathMap; // protected Map fontsMap = new HashMap(); protected Map stylesMap = new HashMap(); /** * */ protected boolean isEmbeddingImages = true; protected File destFile; protected File imagesDir; /** * */ private static int imageId; protected class ExporterContext extends BaseExporterContext implements JRXmlExporterContext { } /** * @see #JRXmlExporter(JasperReportsContext) */ public JRXmlExporter() { this(DefaultJasperReportsContext.getInstance()); } /** * */ public JRXmlExporter(JasperReportsContext jasperReportsContext) { super(jasperReportsContext); exporterContext = new ExporterContext(); } /** * */ protected Class getConfigurationInterface() { return ExporterConfiguration.class; } /** * */ protected Class getItemConfigurationInterface() { return ReportExportConfiguration.class; } /** * */ @SuppressWarnings("deprecation") protected void ensureOutput() { if (exporterOutput == null) { exporterOutput = new net.sf.jasperreports.export.parameters.ParametersXmlExporterOutput( getJasperReportsContext(), getParameters(), getCurrentJasperPrint() ); } } /** * */ public void exportReport() throws JRException { /* */ ensureJasperReportsContext(); ensureInput(); initExport(); ensureOutput(); if (!isEmbeddingImages) { rendererToImagePathMap = new HashMap(); } Writer writer = getExporterOutput().getWriter(); try { exportReportToStream(writer); } catch (IOException e) { throw new JRRuntimeException(e); } finally { getExporterOutput().close(); resetExportContext(); } } @Override protected void initExport() { super.initExport(); } @Override protected void initReport() { super.initReport(); } /** * */ protected XmlNamespace getNamespace() { return JASPERPRINT_NAMESPACE; } protected void exportReportToStream(Writer writer) throws JRException, IOException { version = getPropertiesUtil().getProperty(jasperPrint, JRXmlBaseWriter.PROPERTY_REPORT_VERSION); xmlWriter = new JRXmlWriteHelper(writer); xmlWriter.writeProlog(getExporterOutput().getEncoding()); xmlWriter.startElement(JRXmlConstants.ELEMENT_jasperPrint, getNamespace()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, jasperPrint.getName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageWidth, jasperPrint.getPageWidth()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageHeight, jasperPrint.getPageHeight()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_topMargin, jasperPrint.getTopMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_leftMargin, jasperPrint.getLeftMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_bottomMargin, jasperPrint.getBottomMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rightMargin, jasperPrint.getRightMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_orientation, jasperPrint.getOrientationValue(), OrientationEnum.PORTRAIT); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_formatFactoryClass, jasperPrint.getFormatFactoryClass()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_locale, jasperPrint.getLocaleCode()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_timezone, jasperPrint.getTimeZoneId()); setCurrentExporterInputItem(exporterInput.getItems().get(0)); List pages = jasperPrint.getPages(); PageRange pageRange = getPageRange(); int startPageIndex = (pageRange == null || pageRange.getStartPageIndex() == null) ? 0 : pageRange.getStartPageIndex(); int endPageIndex = (pageRange == null || pageRange.getEndPageIndex() == null) ? (pages.size() - 1) : pageRange.getEndPageIndex(); //FIXME this leads to property duplication if a JasperPrint is loaded //from a *.jrpxml and exported back to xml xmlWriter.startElement(JRXmlConstants.ELEMENT_property); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, PROPERTY_START_PAGE_INDEX); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_value, String.valueOf(startPageIndex)); xmlWriter.closeElement(); xmlWriter.startElement(JRXmlConstants.ELEMENT_property); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, PROPERTY_END_PAGE_INDEX); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_value, String.valueOf(endPageIndex)); xmlWriter.closeElement(); xmlWriter.startElement(JRXmlConstants.ELEMENT_property); //FIXME make this configurable? xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, PROPERTY_PAGE_COUNT); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_value, jasperPrint.getPages() == null ? null : String.valueOf(jasperPrint.getPages().size())); xmlWriter.closeElement(); exportProperties(jasperPrint); JROrigin[] origins = jasperPrint.getOrigins(); if (origins != null && origins.length > 0) { for(int i = 0; i < origins.length; i++) { exportOrigin(origins[i]); } } JRStyle[] styles = jasperPrint.getStyles(); if (styles != null && styles.length > 0) { for(int i = 0; i < styles.length; i++) { stylesMap.put(styles[i].getName(), styles[i]); exportStyle(styles[i]); } } exportBookmarks(jasperPrint.getBookmarks()); PrintParts parts = jasperPrint.getParts(); if (parts != null && parts.hasParts()) { for (Iterator> it = parts.partsIterator(); it.hasNext();) { Map.Entry partsEntry = it.next(); /* */ exportPart(partsEntry.getKey(), partsEntry.getValue()); } } if (pages != null && pages.size() > 0) { JRPrintPage page = null; for(int i = startPageIndex; i <= endPageIndex; i++) { if (Thread.interrupted()) { throw new ExportInterruptedException(); } page = pages.get(i); /* */ exportPage(page); } } xmlWriter.closeElement(); writer.flush(); } protected void exportProperties(JRPropertiesHolder propertiesHolder) throws IOException { if (propertiesHolder.hasProperties()) { JRPropertiesMap propertiesMap = propertiesHolder.getPropertiesMap(); String[] propertyNames = propertiesMap.getPropertyNames(); if (propertyNames != null && propertyNames.length > 0) { for(int i = 0; i < propertyNames.length; i++) { xmlWriter.startElement(JRXmlConstants.ELEMENT_property); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, propertyNames[i]); String value = propertiesMap.getProperty(propertyNames[i]); if (value != null) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_value, value); } xmlWriter.closeElement(); } } } } /** * @throws IOException */ protected void exportStyle(JRStyle style) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_style); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, style.getName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isDefault, style.isDefault(), false); if (style.getStyle() != null) { JRStyle baseStyle = stylesMap.get(style.getStyle().getName()); if(baseStyle != null) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_style, style.getStyle().getName()); } else { throw new JRRuntimeException( "Referenced report style not found : " + style.getStyle().getName() ); } } xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_mode, style.getOwnModeValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_forecolor, style.getOwnForecolor()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_backcolor, style.getOwnBackcolor()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_fill, style.getOwnFillValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_radius, style.getOwnRadius()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_scaleImage, style.getOwnScaleImageValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hTextAlign, style.getOwnHorizontalTextAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hImageAlign, style.getOwnHorizontalImageAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_vTextAlign, style.getOwnVerticalTextAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_vImageAlign, style.getOwnVerticalImageAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rotation, style.getOwnRotationValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_markup, style.getOwnMarkup()); //xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pattern, style.getOwnPattern());//FIXME if pattern in text field is equal to this, then it should be removed there (inheritance) //xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isBlankWhenNull, style.isOwnBlankWhenNull()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_fontName, style.getOwnFontName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_fontSize, style.getOwnFontsize(), true); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isBold, style.isOwnBold()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isItalic, style.isOwnItalic()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isUnderline, style.isOwnUnderline()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isStrikeThrough, style.isOwnStrikeThrough()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pdfFontName, style.getOwnPdfFontName()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pdfEncoding, style.getOwnPdfEncoding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isPdfEmbedded, style.isOwnPdfEmbedded()); exportPen(style.getLinePen()); exportBox(style.getLineBox()); exportParagraph(style.getParagraph()); xmlWriter.closeElement(); } /** * @throws IOException */ protected void exportOrigin(JROrigin origin) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_origin); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_report, origin.getReportName()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_group, origin.getGroupName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_band, origin.getBandTypeValue()); xmlWriter.closeElement(); } protected void exportBookmarks(List bookmarks) throws IOException { if (bookmarks != null && bookmarks.size() > 0) { for(PrintBookmark bookmark : bookmarks) { exportBookmark(bookmark); } } } protected void exportBookmark(PrintBookmark bookmark) throws IOException { if (bookmark != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_bookmark); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_label, bookmark.getLabel()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageIndex, bookmark.getPageIndex()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_elementAddress, bookmark.getElementAddress()); exportBookmarks(bookmark.getBookmarks()); xmlWriter.closeElement(); } } /** * */ protected void exportPart(Integer pageIndex, PrintPart part) throws JRException, IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_part); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageIndex, pageIndex); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, part.getName()); PrintPageFormat pageFormat = part.getPageFormat(); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageWidth, pageFormat.getPageWidth()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_pageHeight, pageFormat.getPageHeight()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_topMargin, pageFormat.getTopMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_leftMargin, pageFormat.getLeftMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_bottomMargin, pageFormat.getBottomMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rightMargin, pageFormat.getRightMargin()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_orientation, pageFormat.getOrientation(), OrientationEnum.PORTRAIT); xmlWriter.closeElement(); } /** * @throws IOException * */ protected void exportPage(JRPrintPage page) throws JRException, IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_page); exportElements(page.getElements()); xmlWriter.closeElement(); JRExportProgressMonitor progressMonitor = getCurrentItemConfiguration().getProgressMonitor(); if (progressMonitor != null) { progressMonitor.afterPageExport(); } } protected void exportElements(Collection elements) throws IOException, JRException { if (elements != null && elements.size() > 0) { for(Iterator it = elements.iterator(); it.hasNext();) { exportElement(it.next()); } } } public void exportElement(JRPrintElement element) throws IOException, JRException { if (filter == null || filter.isToExport(element)) { if (element instanceof JRPrintLine) { exportLine((JRPrintLine)element); } else if (element instanceof JRPrintRectangle) { exportRectangle((JRPrintRectangle)element); } else if (element instanceof JRPrintEllipse) { exportEllipse((JRPrintEllipse)element); } else if (element instanceof JRPrintImage) { exportImage((JRPrintImage)element); } else if (element instanceof JRPrintText) { exportText((JRPrintText)element); } else if (element instanceof JRPrintFrame) { exportFrame((JRPrintFrame) element); } else if (element instanceof JRGenericPrintElement) { exportGenericElement((JRGenericPrintElement) element); } } } /** * @throws IOException * */ protected void exportLine(JRPrintLine line) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_line); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_direction, line.getDirectionValue(), LineDirectionEnum.TOP_DOWN); exportReportElement(line); exportGraphicElement(line); xmlWriter.closeElement(); } /** * @throws IOException * */ protected void exportReportElement(JRPrintElement element) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_reportElement); if(isNewerVersionOrEqual(JRConstants.VERSION_4_7_0)) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_uuid, element.getUUID() == null ? null : element.getUUID().toString()); } xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_key, element.getKey()); JRStyle style = element.getStyle(); if (style != null) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_style, style.getName()); } xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_mode, element.getOwnModeValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_x, element.getX() + getOffsetX()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_y, element.getY() + getOffsetY()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_width, element.getWidth()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_height, element.getHeight()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_forecolor, element.getOwnForecolor()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_backcolor, element.getOwnBackcolor()); JROrigin origin = element.getOrigin(); if (origin != null) { xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_origin, jasperPrint.getOriginsMap().get(origin)); } int elementId = element.getSourceElementId(); if (elementId != JRPrintElement.UNSET_SOURCE_ELEMENT_ID) { xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_srcId, elementId); } int printId = element.getPrintElementId(); if (printId != JRPrintElement.UNSET_PRINT_ELEMENT_ID) { xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_printId, printId); } exportProperties(element); xmlWriter.closeElement(); } /** * @throws IOException * */ protected void exportGraphicElement(JRPrintGraphicElement element) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_graphicElement); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_fill, element.getOwnFillValue()); exportPen(element.getLinePen()); xmlWriter.closeElement(true); } /** * @throws IOException * */ protected void exportPen(JRPen pen) throws IOException { exportPen(JRXmlConstants.ELEMENT_pen, pen); } /** * @throws IOException * */ protected void exportPen(String element, JRPen pen) throws IOException { xmlWriter.startElement(element); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineWidth, pen.getOwnLineWidth()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineStyle, pen.getOwnLineStyleValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineColor, pen.getOwnLineColor()); xmlWriter.closeElement(true); } /** * @throws IOException * */ protected void exportRectangle(JRPrintRectangle rectangle) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_rectangle); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_radius, rectangle.getOwnRadius()); exportReportElement(rectangle); exportGraphicElement(rectangle); xmlWriter.closeElement(); } /** * @throws IOException * */ protected void exportEllipse(JRPrintEllipse ellipse) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_ellipse); exportReportElement(ellipse); exportGraphicElement(ellipse); xmlWriter.closeElement(); } /** * @throws JRException * @throws IOException * */ public void exportImage(JRPrintImage image) throws JRException, IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_image); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_scaleImage, image.getOwnScaleImageValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hAlign, image.getOwnHorizontalImageAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_vAlign, image.getOwnVerticalImageAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isLazy, image.isLazy(), false); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_onErrorType, image.getOnErrorTypeValue(), OnErrorTypeEnum.ERROR); JRHyperlinkProducerFactory hyperlinkProducerFactory = getCurrentItemConfiguration().getHyperlinkProducerFactory(); if (hyperlinkProducerFactory == null) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkType, image.getLinkType(), HyperlinkTypeEnum.NONE.getName()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkReference, image.getHyperlinkReference()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkAnchor, image.getHyperlinkAnchor()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkPage, image.getHyperlinkPage()); } else { String reference = hyperlinkProducerFactory.produceHyperlink(image); if (reference != null) { xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkType, HyperlinkTypeEnum.REFERENCE); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkReference, reference); } } xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkTarget, image.getLinkTarget(), HyperlinkTargetEnum.SELF.getName());//FIXMETARGET this exporter is used in the Flash viewer xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkTooltip, image.getHyperlinkTooltip()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_anchorName, image.getAnchorName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_bookmarkLevel, image.getBookmarkLevel(), JRAnchor.NO_BOOKMARK); exportReportElement(image); exportBox(image.getLineBox()); exportGraphicElement(image); Renderable renderer = image.getRenderable(); if (renderer != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_imageSource); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isEmbedded, isEmbeddingImages && !image.isLazy(), false); String imageSource = ""; if (renderer.getTypeValue() == RenderableTypeEnum.SVG) { renderer = new JRWrappingSvgRenderer( renderer, new Dimension(image.getWidth(), image.getHeight()), ModeEnum.OPAQUE == image.getModeValue() ? image.getBackcolor() : null ); } if (image.isLazy()) { imageSource = ((JRImageRenderer)renderer).getImageLocation(); } else if (isEmbeddingImages) { try { ByteArrayInputStream bais = new ByteArrayInputStream(renderer.getImageData(jasperReportsContext)); ByteArrayOutputStream baos = new ByteArrayOutputStream(); Base64Encoder encoder = new Base64Encoder(bais, baos); encoder.process(); String encoding = getExporterOutput().getEncoding(); imageSource = new String(baos.toByteArray(), encoding); } catch (IOException e) { throw new JRException("Error embedding image into XML.", e); } } else { if (renderer.getTypeValue() == RenderableTypeEnum.IMAGE && rendererToImagePathMap.containsKey(renderer)) { imageSource = rendererToImagePathMap.get(renderer); } else { String imageName = IMAGE_PREFIX + getNextImageId(); byte[] imageData = renderer.getImageData(jasperReportsContext); if (!imagesDir.exists()) { imagesDir.mkdir(); } File imageFile = new File(imagesDir, imageName); OutputStream fos = null; try { fos = new FileOutputStream(imageFile); fos.write(imageData, 0, imageData.length); } catch (IOException e) { throw new JRException("Error writing to image file : " + imageFile, e); } finally { if (fos != null) { try { fos.close(); } catch(IOException e) { } } } imageSource = imageFile.getPath(); rendererToImagePathMap.put(renderer, imageSource); } } xmlWriter.writeCDATA(imageSource); xmlWriter.closeElement(); } if (hyperlinkProducerFactory == null) { exportHyperlinkParameters(image); } xmlWriter.closeElement(); } /** * @throws IOException * */ public void exportText(JRPrintText text) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_text); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_textAlignment, text.getOwnHorizontalTextAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_verticalAlignment, text.getOwnVerticalTextAlign()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_textHeight, text.getTextHeight()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rotation, text.getOwnRotationValue()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_runDirection, text.getRunDirectionValue(), RunDirectionEnum.LTR); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_markup, text.getOwnMarkup()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineSpacingFactor, text.getLineSpacingFactor(), 0f); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_leadingOffset, text.getLeadingOffset(), 0f); JRHyperlinkProducerFactory hyperlinkProducerFactory = getCurrentItemConfiguration().getHyperlinkProducerFactory(); if (hyperlinkProducerFactory == null) { xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkType, text.getLinkType()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkReference, text.getHyperlinkReference()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkAnchor, text.getHyperlinkAnchor()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkPage, text.getHyperlinkPage()); } else { String reference = hyperlinkProducerFactory.produceHyperlink(text); if (reference != null) { xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkType, HyperlinkTypeEnum.REFERENCE); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkReference, reference); } } xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkTarget, text.getLinkTarget()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_hyperlinkTooltip, text.getHyperlinkTooltip()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_anchorName, text.getAnchorName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_bookmarkLevel, text.getBookmarkLevel(), JRAnchor.NO_BOOKMARK); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_valueClass, text.getValueClassName()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pattern, text.getPattern()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_formatFactoryClass, text.getFormatFactoryClass()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_locale, text.getLocaleCode()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_timezone, text.getTimeZoneId()); exportReportElement(text); exportBox(text.getLineBox()); exportFont(text); exportParagraph(text.getParagraph()); if (text.getOriginalText() != null) { xmlWriter.writeCDATAElement(JRXmlConstants.ELEMENT_textContent, text.getOriginalText(), JRXmlConstants.ATTRIBUTE_truncateIndex, text.getTextTruncateIndex()); } xmlWriter.writeCDATAElement(JRXmlConstants.ELEMENT_textTruncateSuffix, text.getTextTruncateSuffix()); short[] lineBreakOffsets = text.getLineBreakOffsets(); if (lineBreakOffsets != null) { StringBuffer offsetsString = formatTextLineBreakOffsets(lineBreakOffsets); xmlWriter.writeCDATAElement(JRXmlConstants.ELEMENT_lineBreakOffsets, offsetsString.toString()); } if (hyperlinkProducerFactory == null) { exportHyperlinkParameters(text); } xmlWriter.closeElement(); } protected StringBuffer formatTextLineBreakOffsets(short[] lineBreakOffsets) { StringBuffer offsetsString = new StringBuffer(); for (int i = 0; i < lineBreakOffsets.length; i++) { if (i > 0) { offsetsString.append(JRXmlConstants.LINE_BREAK_OFFSET_SEPARATOR); } offsetsString.append(lineBreakOffsets[i]); } return offsetsString; } /** * @throws IOException * */ private void exportBox(JRLineBox box) throws IOException { if (box != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_box); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_padding, box.getOwnPadding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_topPadding, box.getOwnTopPadding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_leftPadding, box.getOwnLeftPadding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_bottomPadding, box.getOwnBottomPadding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rightPadding, box.getOwnRightPadding()); exportPen(JRXmlConstants.ELEMENT_pen, box.getPen()); exportPen(JRXmlConstants.ELEMENT_topPen, box.getTopPen()); exportPen(JRXmlConstants.ELEMENT_leftPen, box.getLeftPen()); exportPen(JRXmlConstants.ELEMENT_bottomPen, box.getBottomPen()); exportPen(JRXmlConstants.ELEMENT_rightPen, box.getRightPen()); xmlWriter.closeElement(true); } } /** * @throws IOException * */ private void exportParagraph(JRParagraph paragraph) throws IOException { if (paragraph != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_paragraph); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineSpacing, paragraph.getOwnLineSpacing()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_lineSpacingSize, paragraph.getOwnLineSpacingSize()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_firstLineIndent, paragraph.getOwnFirstLineIndent()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_leftIndent, paragraph.getOwnLeftIndent()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_rightIndent, paragraph.getOwnRightIndent()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_spacingBefore, paragraph.getOwnSpacingBefore()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_spacingAfter, paragraph.getOwnSpacingAfter()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_tabStopWidth, paragraph.getOwnTabStopWidth()); /* */ TabStop[] tabStops = paragraph.getTabStops(); if (tabStops != null && tabStops.length > 0) { for(int i = 0; i < tabStops.length; i++) { exportTabStop(tabStops[i]); } } xmlWriter.closeElement(true); } } /** * */ public void exportTabStop(TabStop tabStop) throws IOException { if (tabStop != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_tabStop); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_position, tabStop.getPosition()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_alignment, tabStop.getAlignment()); xmlWriter.closeElement(true); } } /** * */ protected void exportFont(JRFont font) throws IOException { if (font != null) { xmlWriter.startElement(JRXmlConstants.ELEMENT_font); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_fontName, font.getOwnFontName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_size, font.getOwnFontsize(), true); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isBold, font.isOwnBold()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isItalic, font.isOwnItalic()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isUnderline, font.isOwnUnderline()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isStrikeThrough, font.isOwnStrikeThrough()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pdfFontName, font.getOwnPdfFontName()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_pdfEncoding, font.getOwnPdfEncoding()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_isPdfEmbedded, font.isOwnPdfEmbedded()); xmlWriter.closeElement(true); } } protected void exportFrame(JRPrintFrame frame) throws IOException, JRException { xmlWriter.startElement(JRXmlConstants.ELEMENT_frame); setFrameElementsOffset(frame, true); try { exportReportElement(frame); exportBox(frame.getLineBox()); exportElements(frame.getElements()); xmlWriter.closeElement(); } finally { restoreElementOffsets(); } } /** * */ private static synchronized int getNextImageId(){ return imageId++; } protected void exportHyperlinkParameters(JRPrintHyperlink hyperlink) throws IOException { JRPrintHyperlinkParameters hyperlinkParameters = hyperlink.getHyperlinkParameters(); if (hyperlinkParameters != null) { for (Iterator it = hyperlinkParameters.getParameters().iterator(); it.hasNext();) { JRPrintHyperlinkParameter parameter = it.next(); exportHyperlinkParameter(parameter); } } } protected void exportHyperlinkParameter(JRPrintHyperlinkParameter parameter) throws IOException { xmlWriter.startElement(JRXmlConstants.ELEMENT_hyperlinkParameter); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, parameter.getName()); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_class, parameter.getValueClass(), DEFAULT_OBJECT_TYPE); if (parameter.getValue() != null) { String data = JRValueStringUtils.serialize(parameter.getValueClass(), parameter.getValue()); xmlWriter.writeCDATAElement(JRXmlConstants.ELEMENT_hyperlinkParameterValue, data); } xmlWriter.closeElement(); } /** * */ protected void exportGenericElement(JRGenericPrintElement element) throws IOException { GenericElementXmlHandler handler = (GenericElementXmlHandler) GenericElementHandlerEnviroment.getInstance(jasperReportsContext).getElementHandler( element.getGenericType(), getExporterKey()); if (handler != null) { handler.exportElement(exporterContext, element); } else { xmlWriter.startElement(JRXmlConstants.ELEMENT_genericElement); exportReportElement(element); JRGenericElementType genericType = element.getGenericType(); xmlWriter.startElement(JRXmlConstants.ELEMENT_genericElementType); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_namespace, genericType.getNamespace()); xmlWriter.addEncodedAttribute(JRXmlConstants.ATTRIBUTE_name, genericType.getName()); xmlWriter.closeElement();//genericElementType Set names = element.getParameterNames(); for (Iterator it = names.iterator(); it.hasNext();) { String name = it.next(); Object value = element.getParameterValue(name); xmlWriter.startElement(JRXmlConstants.ELEMENT_genericElementParameter); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_name, name); if (value != null) { String valueClass = value.getClass().getName(); // check if there's a builtin serializer for the value boolean builtinSerialization = JRValueStringUtils.hasSerializer(valueClass); if (!builtinSerialization) { // try XML handlers, if none works then default back to the builtin serialization builtinSerialization = !XmlValueHandlerUtils.instance().writeToXml(value, this); } if (builtinSerialization) { String data = JRValueStringUtils.serialize(valueClass, value); xmlWriter.startElement(JRXmlConstants.ELEMENT_genericElementParameterValue); xmlWriter.addAttribute(JRXmlConstants.ATTRIBUTE_class, valueClass); xmlWriter.writeCDATA(data); xmlWriter.closeElement();//genericElementParameterValue } } xmlWriter.closeElement();//genericElementParameter } xmlWriter.closeElement();//genericElement } } /** * */ public String getExporterPropertiesPrefix() { return XML_EXPORTER_PROPERTIES_PREFIX; } /** * */ public String getExporterKey() { return XML_EXPORTER_KEY; } /** * Returns the XML write helper used by this exporter. * * The helper can be used to output XML elements and attributes. * * @return the XML write helper used by this exporter */ public JRXmlWriteHelper getXmlWriteHelper() { return xmlWriter; } /** * */ protected boolean isNewerVersionOrEqual(String oldVersion) { return versionComparator.compare(version, oldVersion) >= 0; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy