net.sf.jasperreports.engine.export

Class JRXmlExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.JRXmlExporter

All Implemented Interfaces:

JRExporter

Direct Known Subclasses:

JRXml4SwfExporter

public class JRXmlExporter
extends JRAbstractExporter

Exports a JasperReports document to an XML file that contains the same data as a JasperPrint object, but in XML format, instead of a serialized class. Such XML files can be parsed back into JasperPrint object using the JRPrintXmlLoader utility class. Their structure is validated against an internal XSD file called jasperprint.xsd.

Version:

$Id: JRXmlExporter.java 5655 2012-09-12 13:25:21Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JRXmlExporter.ExporterContext

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.JRAbstractExporter

JRAbstractExporter.BaseExporterContext, JRAbstractExporter.ParameterOverriddenResolver, JRAbstractExporter.ParameterOverrideResolver, JRAbstractExporter.ParameterResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_OBJECT_TYPE
protected static String	DEFAULT_XML_ENCODING
protected File	destFile
protected String	encoding
protected JRXmlExporterContext	exporterContext
protected static String	IMAGE_PREFIX
protected Map<String,byte[]>	imageNameToImageDataMap
protected File	imagesDir
protected boolean	isEmbeddingImages
static XmlNamespace	JASPERPRINT_NAMESPACE
protected JRExportProgressMonitor	progressMonitor
static String	PROPERTY_REPLACE_INVALID_CHARS Stores the text sequence used to replace invalid XML characters
protected Map<Renderable,String>	rendererToImagePathMap
protected Map<String,JRStyle>	stylesMap
protected String	version
protected VersionComparator	versionComparator
static String	XML_EXPORTER_KEY The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).
protected static String	XML_FILES_SUFFIX
protected JRXmlWriteHelper	xmlWriter

Fields inherited from class net.sf.jasperreports.engine.JRAbstractExporter

allSelector, dateFormatCache, endPageIndex, filter, fontMap, globalOffsetX, globalOffsetY, hyperlinkProducerFactory, isModeBatch, jasperPrint, jasperPrintList, jasperReportsContext, noBackcolorSelector, noneSelector, numberFormatCache, parameters, propertiesUtil, PROPERTY_DEFAULT_FILTER_FACTORY, PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY, startPageIndex, styledTextUtil

Constructor Summary

Constructors

Constructor and Description
JRXmlExporter()
JRXmlExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	exportElement(JRPrintElement element)
protected void	exportElements(Collection<JRPrintElement> elements)
protected void	exportEllipse(JRPrintEllipse ellipse)
protected void	exportFont(JRFont font)
protected void	exportFrame(JRPrintFrame frame)
protected void	exportGenericElement(JRGenericPrintElement element)
protected void	exportGraphicElement(JRPrintGraphicElement element)
protected void	exportHyperlinkParameter(JRPrintHyperlinkParameter parameter)
protected void	exportHyperlinkParameters(JRPrintHyperlink hyperlink)
void	exportImage(JRPrintImage image)
protected void	exportLine(JRPrintLine line)
protected void	exportOrigin(JROrigin origin)
protected void	exportPage(JRPrintPage page)
protected void	exportPen(JRPen pen)
protected void	exportPen(String element, JRPen pen)
protected void	exportProperties(JRPropertiesHolder propertiesHolder)
protected void	exportRectangle(JRPrintRectangle rectangle)
void	exportReport() Actually starts the export process.
protected void	exportReportElement(JRPrintElement element)
protected StringBuffer	exportReportToBuffer()
protected void	exportReportToFile()
protected void	exportReportToStream(Writer writer)
protected void	exportStyle(JRStyle style)
void	exportTabStop(TabStop tabStop)
void	exportText(JRPrintText text)
protected StringBuffer	formatTextLineBreakOffsets(short[] lineBreakOffsets)
protected String	getExporterKey()
protected String	getExporterPropertiesPrefix()
protected XmlNamespace	getNamespace()
JRXmlWriteHelper	getXmlWriteHelper() Returns the XML write helper used by this exporter.
protected boolean	isNewerVersionOrEqual(String oldVersion)
protected void	setHyperlinkProducerFactory()

Methods inherited from class net.sf.jasperreports.engine.JRAbstractExporter

createFilter, defaultParseNumber, getBooleanCellValue, getBooleanParameter, getCharacterParameter, getCustomHandler, getDateCellValue, getDateFormat, getFloatParameter, getHyperlinkProducer, getIntegerParameter, getJasperReportsContext, getLocale, getNumberCellValue, getNumberFormat, getOffsetX, getOffsetY, getParameter, getParameterResolver, getParameters, getPropertiesUtil, getReportContext, getStringArrayParameter, getStringParameter, getStringParameterOrDefault, getStyledText, getStyledText, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setExportContext, setFontMap, setFrameElementsOffset, setInput, setJasperPrint, setJasperReportsContext, setOffset, setOffset, setOutput, setPageRange, setParameter, setParameters, setReportContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_EXPORTER_KEY

public static final String XML_EXPORTER_KEY

The exporter key, as used in GenericElementHandlerEnviroment.getHandler(net.sf.jasperreports.engine.JRGenericElementType, String).

See Also:

Constant Field Values

PROPERTY_REPLACE_INVALID_CHARS

public static final String PROPERTY_REPLACE_INVALID_CHARS

Stores the text sequence used to replace invalid XML characters

See Also:

Constant Field Values

DEFAULT_XML_ENCODING

protected static final String DEFAULT_XML_ENCODING

See Also:

Constant Field Values

DEFAULT_OBJECT_TYPE

protected static final String DEFAULT_OBJECT_TYPE

See Also:

Constant Field Values

XML_FILES_SUFFIX

protected static final String XML_FILES_SUFFIX

See Also:

Constant Field Values

IMAGE_PREFIX

protected static final String IMAGE_PREFIX

See Also:

Constant Field Values

JASPERPRINT_NAMESPACE

public static final XmlNamespace JASPERPRINT_NAMESPACE

xmlWriter

protected JRXmlWriteHelper xmlWriter

encoding

protected String encoding

version

protected String version

versionComparator

protected VersionComparator versionComparator

progressMonitor

protected JRExportProgressMonitor progressMonitor

rendererToImagePathMap

protected Map<Renderable,String> rendererToImagePathMap

imageNameToImageDataMap

protected Map<String,byte[]> imageNameToImageDataMap

stylesMap

protected Map<String,JRStyle> stylesMap

isEmbeddingImages

protected boolean isEmbeddingImages

destFile

protected File destFile

imagesDir

protected File imagesDir

exporterContext

protected JRXmlExporterContext exporterContext

Constructor Detail

JRXmlExporter

public JRXmlExporter()

See Also:

JRXmlExporter(JasperReportsContext)

JRXmlExporter

public JRXmlExporter(JasperReportsContext jasperReportsContext)

Method Detail

exportReport

public void exportReport()
                  throws JRException

Description copied from interface: JRExporter

Actually starts the export process.

Specified by:

exportReport in interface JRExporter

Specified by:

exportReport in class JRAbstractExporter

Throws:

JRException

setHyperlinkProducerFactory

protected void setHyperlinkProducerFactory()

Overrides:

setHyperlinkProducerFactory in class JRAbstractExporter

exportReportToFile

protected void exportReportToFile()
                           throws JRException

Throws:

JRException

exportReportToBuffer

protected StringBuffer exportReportToBuffer()
                                     throws JRException

Throws:

JRException

getNamespace

protected XmlNamespace getNamespace()

exportReportToStream

protected void exportReportToStream(Writer writer)
                             throws JRException,
                                    IOException

Throws:

JRException

IOException

exportProperties

protected void exportProperties(JRPropertiesHolder propertiesHolder)
                         throws IOException

Throws:

IOException

exportStyle

protected void exportStyle(JRStyle style)
                    throws IOException

Throws:

IOException

exportOrigin

protected void exportOrigin(JROrigin origin)
                     throws IOException

Throws:

IOException

exportPage

protected void exportPage(JRPrintPage page)
                   throws JRException,
                          IOException

Throws:

IOException

JRException

exportElements

protected void exportElements(Collection<JRPrintElement> elements)
                       throws IOException,
                              JRException

Throws:

IOException

JRException

exportElement

public void exportElement(JRPrintElement element)
                   throws IOException,
                          JRException

Throws:

IOException

JRException

exportLine

protected void exportLine(JRPrintLine line)
                   throws IOException

Throws:

IOException

exportReportElement

protected void exportReportElement(JRPrintElement element)
                            throws IOException

Throws:

IOException

exportGraphicElement

protected void exportGraphicElement(JRPrintGraphicElement element)
                             throws IOException

Throws:

IOException

exportPen

protected void exportPen(JRPen pen)
                  throws IOException

Throws:

IOException

exportPen

protected void exportPen(String element,
             JRPen pen)
                  throws IOException

Throws:

IOException

exportRectangle

protected void exportRectangle(JRPrintRectangle rectangle)
                        throws IOException

Throws:

IOException

exportEllipse

protected void exportEllipse(JRPrintEllipse ellipse)
                      throws IOException

Throws:

IOException

exportImage

public void exportImage(JRPrintImage image)
                 throws JRException,
                        IOException

Throws:

JRException

IOException

exportText

public void exportText(JRPrintText text)
                throws IOException

Throws:

IOException

formatTextLineBreakOffsets

protected StringBuffer formatTextLineBreakOffsets(short[] lineBreakOffsets)

exportTabStop

public void exportTabStop(TabStop tabStop)
                   throws IOException

Throws:

IOException

exportFont

protected void exportFont(JRFont font)
                   throws IOException

Throws:

IOException

exportFrame

protected void exportFrame(JRPrintFrame frame)
                    throws IOException,
                           JRException

Throws:

IOException

JRException

exportHyperlinkParameters

protected void exportHyperlinkParameters(JRPrintHyperlink hyperlink)
                                  throws IOException

Throws:

IOException

exportHyperlinkParameter

protected void exportHyperlinkParameter(JRPrintHyperlinkParameter parameter)
                                 throws IOException

Throws:

IOException

exportGenericElement

protected void exportGenericElement(JRGenericPrintElement element)
                             throws IOException

Throws:

IOException

getExporterPropertiesPrefix

protected String getExporterPropertiesPrefix()

getExporterKey

protected String getExporterKey()

Specified by:

getExporterKey in class JRAbstractExporter

getXmlWriteHelper

public JRXmlWriteHelper getXmlWriteHelper()

Returns the XML write helper used by this exporter. The helper can be used to output XML elements and attributes.

Returns:

the XML write helper used by this exporter

isNewerVersionOrEqual

protected boolean isNewerVersionOrEqual(String oldVersion)