Package net.sf.jasperreports.engine

Class JRAbstractExporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter<RC,C,O,E>

All Implemented Interfaces:

Exporter<ExporterInput,RC,C,O>

Direct Known Subclasses:

AbstractHtmlExporter, AbstractMetadataExporter, ExcelAbstractExporter, JRAbstractCsvExporter, JRDocxExporter, JRGraphics2DExporter, JROdtExporter, JRPptxExporter, JRPrintServiceExporter, JRRtfExporter, JRTextExporter, JRXmlExporter, JsonExporter

public abstract class JRAbstractExporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>
extends Object
implements Exporter<ExporterInput,RC,C,O>

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JRAbstractExporter.BaseExporterContext
class	JRAbstractExporter.PageRange

Field Summary

Fields

Modifier and Type	Field	Description
protected JRStyledTextAttributeSelector	allSelector
protected C	crtCompositeConfiguration
protected RC	crtCompositeItemConfiguration
protected ExporterInputItem	crtItem
protected Map<String,DateFormat>	dateFormatCache
static final String	EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME
protected static final String	EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO
protected static final String	EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR
protected C	exporterConfiguration
protected E	exporterContext
protected ExporterInput	exporterInput
protected O	exporterOutput
protected ExporterFilter	filter
protected FontUtil	fontUtil
protected JRHyperlinkProducerFactory	hyperlinkProducerFactory
protected RC	itemConfiguration
protected JasperPrint	jasperPrint
protected JasperReportsContext	jasperReportsContext
protected JRStyledTextAttributeSelector	noBackcolorSelector
protected JRStyledTextAttributeSelector	noneSelector
protected Map<String,NumberFormat>	numberFormatCache
protected JRPropertiesUtil	propertiesUtil
static final String	PROPERTY_DEFAULT_FILTER_FACTORY	A property that gives the generic default filter factory class name.
static final String	PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY	The suffix applied to properties that give the default filter factory for a specific exporter.
protected RendererUtil	rendererUtil
protected JRStyledTextUtil	styledTextUtil
protected Map<String,Class<?>>	textValueClasses

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRAbstractExporter(JasperReportsContext jasperReportsContext)

Method Summary

Modifier and Type	Method	Description
void	cancelExport()	Requests the cancellation of a running export.
protected void	checkInterrupted()
protected ExporterFilter	createFilter()
protected Number	defaultParseNumber(String textStr, Class<?> valueClass)
protected void	ensureInput()
protected void	ensureJasperReportsContext()
protected void	ensureOutput()
abstract void	exportReport()	Performs the export.
protected TextValue	getBooleanCellValue(JRPrintText text, String textStr)
protected abstract Class<C>	getConfigurationInterface()
protected C	getCurrentConfiguration()
protected RC	getCurrentItemConfiguration()
JasperPrint	getCurrentJasperPrint()
PrintPageFormat	getCurrentPageFormat()	Returns the page format of the page which is currently exported.
protected TextValue	getDateCellValue(JRPrintText text, String textStr)
protected DateFormat	getDateFormat(String formatFactoryClass, String pattern, Locale lc, TimeZone tz)
C	getExporterConfiguration()
E	getExporterContext()
protected ExporterInput	getExporterInput()
abstract String	getExporterKey()
O	getExporterOutput()
abstract String	getExporterPropertiesPrefix()	Returns the properties prefix for the current exporter.
JRHyperlinkProducer	getHyperlinkProducer(JRPrintHyperlink link)
protected abstract Class<RC>	getItemConfigurationInterface()
JasperReportsContext	getJasperReportsContext()
Locale	getLocale()
protected TextValue	getNumberCellValue(JRPrintText text, String textStr)
protected NumberFormat	getNumberFormat(String formatFactoryClass, String pattern, Locale lc)
protected int	getOffsetX()	Returns the X axis offset used for element export.
protected int	getOffsetY()	Returns the Y axis offset used for element export.
protected JRAbstractExporter<RC,C,O,E>.PageRange	getPageRange()
JRPropertiesUtil	getPropertiesUtil()
RendererUtil	getRendererUtil()
ReportContext	getReportContext()
RC	getReportExportConfiguration()
RepositoryUtil	getRepository()
protected JRStyledText	getStyledText(JRPrintText textElement)
protected JRStyledText	getStyledText(JRPrintText textElement, boolean setBackcolor)
protected String	getTextFormatFactoryClass(JRPrintText text)
protected Locale	getTextLocale(JRPrintText text)
protected TimeZone	getTextTimeZone(JRPrintText text)
protected TextValue	getTextValue(JRPrintText text, String textStr)
protected TextValue	getTextValueString(JRPrintText text, String textStr)
protected void	initExport()
protected void	initReport()
protected boolean	insideFrame()
boolean	isExportCancelled()	Determines whether the export has been cancelled via cancelExport().
void	reset()
protected void	resetExportContext()
protected void	restoreElementOffsets()	Restores offsets after a call to setFrameElementsOffset.
void	setConfiguration(C configuration)
void	setConfiguration(RC configuration)
protected void	setCurrentExporterInputItem(ExporterInputItem crtItem)
void	setExporterInput(ExporterInput exporterInput)	Provides the input for this exporter.
void	setExporterOutput(O exporterOutput)	Provides the output for this exporter.
protected void	setFrameElementsOffset(JRPrintFrame frame, boolean relative)	Sets the offsets for exporting elements from a frame.
protected void	setJasperReportsContext(JasperReportsContext jasperReportsContext)
protected void	setOffset()
protected void	setOffset(boolean setElementOffsets)
void	setReportContext(ReportContext reportContext)

Methods inherited from class java.lang.Object

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

Field Details

EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME

public static final String EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO

protected static final String EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR

protected static final String EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR

See Also:

• Constant Field Values

PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY

public static final String PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY

The suffix applied to properties that give the default filter factory for a specific exporter. For instance, the default filter factory for XLS exporters is net.sf.jasperreports.export.xls.default.filter.factory. If this property is not defined for a specific exporter, the generic exporter factory given by PROPERTY_DEFAULT_FILTER_FACTORY is used.

See Also:

• Constant Field Values

PROPERTY_DEFAULT_FILTER_FACTORY

public static final String PROPERTY_DEFAULT_FILTER_FACTORY

A property that gives the generic default filter factory class name.

See Also:

• PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY
• Constant Field Values

jasperReportsContext

protected JasperReportsContext jasperReportsContext

propertiesUtil

protected JRPropertiesUtil propertiesUtil

rendererUtil

protected RendererUtil rendererUtil

allSelector

protected JRStyledTextAttributeSelector allSelector

noBackcolorSelector

protected JRStyledTextAttributeSelector noBackcolorSelector

noneSelector

protected JRStyledTextAttributeSelector noneSelector

styledTextUtil

protected JRStyledTextUtil styledTextUtil

fontUtil

protected FontUtil fontUtil

exporterInput

protected ExporterInput exporterInput

itemConfiguration

protected RC extends ReportExportConfiguration itemConfiguration

exporterConfiguration

protected C extends ExporterConfiguration exporterConfiguration

exporterOutput

protected O extends ExporterOutput exporterOutput

crtItem

protected ExporterInputItem crtItem

crtCompositeItemConfiguration

protected RC extends ReportExportConfiguration crtCompositeItemConfiguration

crtCompositeConfiguration

protected C extends ExporterConfiguration crtCompositeConfiguration

jasperPrint

protected JasperPrint jasperPrint

filter

protected ExporterFilter filter

dateFormatCache

protected Map<String,DateFormat> dateFormatCache

numberFormatCache

protected Map<String,NumberFormat> numberFormatCache

textValueClasses

protected Map<String,Class<?>> textValueClasses

exporterContext

protected E extends JRExporterContext exporterContext

hyperlinkProducerFactory

protected JRHyperlinkProducerFactory hyperlinkProducerFactory

Constructor Details

JRAbstractExporter

protected JRAbstractExporter(JasperReportsContext jasperReportsContext)

Method Details

reset

public void reset()

getExporterInput

protected ExporterInput getExporterInput()

setExporterInput

public void setExporterInput(ExporterInput exporterInput)

Description copied from interface: Exporter

Provides the input for this exporter.

Specified by:

setExporterInput in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

getExporterOutput

public O getExporterOutput()

setExporterOutput

public void setExporterOutput(O exporterOutput)

Description copied from interface: Exporter

Provides the output for this exporter.

Specified by:

setExporterOutput in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

getReportExportConfiguration

public RC getReportExportConfiguration()

getExporterConfiguration

public C getExporterConfiguration()

setConfiguration

public void setConfiguration(RC configuration)

Specified by:

setConfiguration in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

setConfiguration

public void setConfiguration(C configuration)

Specified by:

setConfiguration in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

getJasperReportsContext

public JasperReportsContext getJasperReportsContext()

setJasperReportsContext

protected void setJasperReportsContext(JasperReportsContext jasperReportsContext)

setReportContext

public void setReportContext(ReportContext reportContext)

Specified by:

setReportContext in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

getReportContext

public ReportContext getReportContext()

Specified by:

getReportContext in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

getPropertiesUtil

public JRPropertiesUtil getPropertiesUtil()

getRendererUtil

public RendererUtil getRendererUtil()

getRepository

public RepositoryUtil getRepository()

exportReport

public abstract void exportReport()
                           throws JRException

Description copied from interface: Exporter

Performs the export.

Specified by:

exportReport in interface Exporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext>

Throws:

JRException

cancelExport

public void cancelExport()

Requests the cancellation of a running export.

This method is meant to be called from a thread other than the one performing the export. The export is not stopped immediately; the exporter checks the cancellation request between pages, after which exportReport() fails with an ExportInterruptedException. The output produced up to that point is incomplete and should be discarded.

The cancellation request is not reset, any subsequent export performed with this exporter instance will also be interrupted.

See Also:

• isExportCancelled()

isExportCancelled

public boolean isExportCancelled()

Determines whether the export has been cancelled via cancelExport().

checkInterrupted

protected void checkInterrupted()
                         throws ExportInterruptedException

Throws:

ExportInterruptedException

setOffset

protected void setOffset()

setOffset

protected void setOffset(boolean setElementOffsets)

ensureJasperReportsContext

protected void ensureJasperReportsContext()

resetExportContext

protected void resetExportContext()

setCurrentExporterInputItem

protected void setCurrentExporterInputItem(ExporterInputItem crtItem)

getCurrentItemConfiguration

protected RC getCurrentItemConfiguration()

getCurrentConfiguration

protected C getCurrentConfiguration()

getConfigurationInterface

protected abstract Class<C> getConfigurationInterface()

getItemConfigurationInterface

protected abstract Class<RC> getItemConfigurationInterface()

ensureInput

protected void ensureInput()

ensureOutput

protected void ensureOutput()

initExport

protected void initExport()

initReport

protected void initReport()

getPageRange

protected JRAbstractExporter<RC,C,O,E>.PageRange getPageRange()

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
 boolean setBackcolor)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement)

getOffsetX

protected int getOffsetX()

Returns the X axis offset used for element export.

Returns:

the X axis offset

getOffsetY

protected int getOffsetY()

Returns the Y axis offset used for element export.

Returns:

the Y axis offset

getCurrentPageFormat

public PrintPageFormat getCurrentPageFormat()

Returns the page format of the page which is currently exported.

The implementation here returns the page format of the document, which is the correct one for pages that do not belong to a part. Exporters that iterate the pages of a document made of parts override this method in order to return the format of the page being exported, as parts can have page formats of their own.

Returns:

the page format of the page currently exported

setFrameElementsOffset

protected void setFrameElementsOffset(JRPrintFrame frame,
 boolean relative)

Sets the offsets for exporting elements from a frame.

After the frame elements are exported, a call to popElementOffsets is required so that the previous offsets are restored.

Parameters:

frame -

relative -

See Also:

• getOffsetX()
• getOffsetY()
• restoreElementOffsets()

restoreElementOffsets

protected void restoreElementOffsets()

Restores offsets after a call to setFrameElementsOffset.

insideFrame

protected boolean insideFrame()

getTextFormatFactoryClass

protected String getTextFormatFactoryClass(JRPrintText text)

getLocale

public Locale getLocale()

getTextLocale

protected Locale getTextLocale(JRPrintText text)

getTextTimeZone

protected TimeZone getTextTimeZone(JRPrintText text)

getTextValue

protected TextValue getTextValue(JRPrintText text,
 String textStr)

getTextValueString

protected TextValue getTextValueString(JRPrintText text,
 String textStr)

getDateCellValue

protected TextValue getDateCellValue(JRPrintText text,
 String textStr)
                              throws ParseException

Throws:

ParseException

getNumberCellValue

protected TextValue getNumberCellValue(JRPrintText text,
 String textStr)
                                throws ParseException,
ClassNotFoundException

Throws:

ParseException

ClassNotFoundException

defaultParseNumber

protected Number defaultParseNumber(String textStr,
 Class<?> valueClass)

getBooleanCellValue

protected TextValue getBooleanCellValue(JRPrintText text,
 String textStr)

getDateFormat

protected DateFormat getDateFormat(String formatFactoryClass,
 String pattern,
 Locale lc,
 TimeZone tz)

getNumberFormat

protected NumberFormat getNumberFormat(String formatFactoryClass,
 String pattern,
 Locale lc)

createFilter

protected ExporterFilter createFilter()

getHyperlinkProducer

public JRHyperlinkProducer getHyperlinkProducer(JRPrintHyperlink link)

getExporterKey

public abstract String getExporterKey()

getExporterPropertiesPrefix

public abstract String getExporterPropertiesPrefix()

Returns the properties prefix for the current exporter.

Returns:

the properties prefix for the current exporter

getExporterContext

public E getExporterContext()

getCurrentJasperPrint

public JasperPrint getCurrentJasperPrint()