net.sf.jasperreports.engine
Class JRAbstractExporter

java.lang.Object
  net.sf.jasperreports.engine.JRAbstractExporter

All Implemented Interfaces:

JRExporter

Direct Known Subclasses:

JRAbstractCsvExporter, JRDocxExporter, JRGraphics2DExporter, JRHtmlExporter, JROpenDocumentExporter, JRPdfExporter, JRPptxExporter, JRPrintServiceExporter, JRRtfExporter, JRTextExporter, JRXhtmlExporter, JRXlsAbstractExporter, JRXmlExporter

public abstract class JRAbstractExporter
extends Object
implements JRExporter

Version:

$Id: JRAbstractExporter.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

class	JRAbstractExporter.BaseExporterContext
protected class	JRAbstractExporter.ParameterOverriddenResolver
protected class	JRAbstractExporter.ParameterOverrideResolver
protected static interface	JRAbstractExporter.ParameterResolver

Field Summary

protected Map<String,DateFormat>	dateFormatCache
protected int	endPageIndex
protected ExporterFilter	filter
protected Map<String,String>	fontMap
protected int	globalOffsetX
protected int	globalOffsetY
protected JRHyperlinkProducerFactory	hyperlinkProducerFactory
protected boolean	isModeBatch
protected JasperPrint	jasperPrint
protected List<JasperPrint>	jasperPrintList
protected JasperReportsContext	jasperReportsContext
protected Map<String,NumberFormat>	numberFormatCache
protected Map<JRExporterParameter,Object>	parameters
static String	PROPERTY_DEFAULT_FILTER_FACTORY A property that gives the generic default filter factory class name.
static String	PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY The suffix applied to properties that give the default filter factory for a specific exporter.
protected int	startPageIndex

Constructor Summary

protected	JRAbstractExporter() Deprecated. Replaced by JRAbstractExporter(JasperReportsContext).
protected	JRAbstractExporter(JasperReportsContext jasperReportsContext)

Method Summary

protected ExporterFilter	createFilter(String exportPropertyPrefix)
protected Number	defaultParseNumber(String textStr, Class<?> valueClass)
abstract void	exportReport() Actually starts the export process.
protected TextValue	getBooleanCellValue(JRPrintText text, String textStr)
boolean	getBooleanParameter(JRExporterParameter parameter, String property, boolean defaultValue)
Character	getCharacterParameter(JRExporterParameter parameter, String property)
protected JRHyperlinkProducer	getCustomHandler(JRPrintHyperlink link) Deprecated. Replaced by getHyperlinkProducer(JRPrintHyperlink).
protected TextValue	getDateCellValue(JRPrintText text, String textStr)
protected DateFormat	getDateFormat(String formatFactoryClass, String pattern, Locale lc, TimeZone tz)
protected abstract String	getExporterKey()
float	getFloatParameter(JRExporterParameter parameter, String property, float defaultValue)
protected JRHyperlinkProducer	getHyperlinkProducer(JRPrintHyperlink link)
int	getIntegerParameter(JRExporterParameter parameter, String property, int defaultValue)
JasperReportsContext	getJasperReportsContext()
protected 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.
Object	getParameter(JRExporterParameter parameter) Gets an export parameter.
protected JRAbstractExporter.ParameterResolver	getParameterResolver()
Map<JRExporterParameter,Object>	getParameters() Gets a map containing all export parameters.
JRPropertiesUtil	getPropertiesUtil()
ReportContext	getReportContext()
String[]	getStringArrayParameter(JRExporterParameter parameter, String property)
String	getStringParameter(JRExporterParameter parameter, String property)
String	getStringParameterOrDefault(JRExporterParameter parameter, String property)
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)
void	reset()
protected void	resetClassLoader() Deprecated. replaced by resetExportContext
protected void	resetExportContext()
protected void	restoreElementOffsets() Restores offsets after a call to setFrameElementsOffset.
protected void	setClassLoader() Deprecated. replaced by setExportContext
protected void	setExportContext()
protected void	setFontMap()
protected void	setFrameElementsOffset(JRPrintFrame frame, boolean relative) Sets the offsets for exporting elements from a frame.
protected void	setHyperlinkProducerFactory()
protected void	setInput()
protected void	setJasperPrint(JasperPrint jasperPrint)
protected void	setOffset()
protected void	setOffset(boolean setElementOffsets)
protected void	setOutput()
protected void	setPageRange()
void	setParameter(JRExporterParameter parameter, Object value) Sets an export parameter for advanced customization of the export process.
void	setParameters(Map<JRExporterParameter,Object> parameters) Sets export parameters from a specified map.
void	setReportContext(ReportContext reportContext)

Methods inherited from class java.lang.Object

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

Field Detail

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

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

jasperReportsContext

protected JasperReportsContext jasperReportsContext

parameters

protected Map<JRExporterParameter,Object> parameters

jasperPrintList

protected List<JasperPrint> jasperPrintList

jasperPrint

protected JasperPrint jasperPrint

isModeBatch

protected boolean isModeBatch

startPageIndex

protected int startPageIndex

endPageIndex

protected int endPageIndex

globalOffsetX

protected int globalOffsetX

globalOffsetY

protected int globalOffsetY

filter

protected ExporterFilter filter

fontMap

protected Map<String,String> fontMap

dateFormatCache

protected Map<String,DateFormat> dateFormatCache

numberFormatCache

protected Map<String,NumberFormat> numberFormatCache

hyperlinkProducerFactory

protected JRHyperlinkProducerFactory hyperlinkProducerFactory

Constructor Detail

JRAbstractExporter

protected JRAbstractExporter()

Deprecated. Replaced by JRAbstractExporter(JasperReportsContext).

JRAbstractExporter

protected JRAbstractExporter(JasperReportsContext jasperReportsContext)

Method Detail

reset

public void reset()

setParameter

public void setParameter(JRExporterParameter parameter,
                         Object value)

Description copied from interface: JRExporter

Sets an export parameter for advanced customization of the export process. Parameters can be either common parameters or specialized ones, depending on the exporter type.

Specified by:

setParameter in interface JRExporter

Parameters:

parameter - the parameter, selected from the static parameters defined by JasperReports

value - the parameter value

See Also:

JRExporterParameter

getParameter

public Object getParameter(JRExporterParameter parameter)

Description copied from interface: JRExporter

Gets an export parameter.

Specified by:

getParameter in interface JRExporter

setParameters

public void setParameters(Map<JRExporterParameter,Object> parameters)

Description copied from interface: JRExporter

Sets export parameters from a specified map.

Specified by:

setParameters in interface JRExporter

See Also:

JRExporter.setParameter(JRExporterParameter, Object)

getParameters

public Map<JRExporterParameter,Object> getParameters()

Description copied from interface: JRExporter

Gets a map containing all export parameters.

Specified by:

getParameters in interface JRExporter

getParameterResolver

protected JRAbstractExporter.ParameterResolver getParameterResolver()

getStringParameter

public String getStringParameter(JRExporterParameter parameter,
                                 String property)

getStringArrayParameter

public String[] getStringArrayParameter(JRExporterParameter parameter,
                                        String property)

getStringParameterOrDefault

public String getStringParameterOrDefault(JRExporterParameter parameter,
                                          String property)

getBooleanParameter

public boolean getBooleanParameter(JRExporterParameter parameter,
                                   String property,
                                   boolean defaultValue)

getIntegerParameter

public int getIntegerParameter(JRExporterParameter parameter,
                               String property,
                               int defaultValue)

getFloatParameter

public float getFloatParameter(JRExporterParameter parameter,
                               String property,
                               float defaultValue)

getCharacterParameter

public Character getCharacterParameter(JRExporterParameter parameter,
                                       String property)

getJasperReportsContext

public JasperReportsContext getJasperReportsContext()

setReportContext

public void setReportContext(ReportContext reportContext)

Specified by:

setReportContext in interface JRExporter

getReportContext

public ReportContext getReportContext()

Specified by:

getReportContext in interface JRExporter

getPropertiesUtil

public JRPropertiesUtil getPropertiesUtil()

exportReport

public abstract void exportReport()
                           throws JRException

Description copied from interface: JRExporter

Actually starts the export process.

Specified by:

exportReport in interface JRExporter

Throws:

JRException

setOffset

protected void setOffset()

setOffset

protected void setOffset(boolean setElementOffsets)

setExportContext

protected void setExportContext()

resetExportContext

protected void resetExportContext()

setClassLoader

protected void setClassLoader()

Deprecated. replaced by setExportContext

resetClassLoader

protected void resetClassLoader()

Deprecated. replaced by resetExportContext

setJasperPrint

protected void setJasperPrint(JasperPrint jasperPrint)

setInput

protected void setInput()
                 throws JRException

Throws:

JRException

setPageRange

protected void setPageRange()
                     throws JRException

Throws:

JRException

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
                                     boolean setBackcolor)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement)

setOutput

protected void setOutput()

getOffsetX

protected int getOffsetX()

Returns the X axis offset used for element export.

This method should be used istead of globalOffsetX when exporting elements.

Returns:

the X axis offset

getOffsetY

protected int getOffsetY()

Returns the Y axis offset used for element export.

This method should be used istead of globalOffsetY when exporting elements.

Returns:

the Y axis offset

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 resored.

Parameters:

frame -

relative -

See Also:

getOffsetX(), getOffsetY(), restoreElementOffsets()

restoreElementOffsets

protected void restoreElementOffsets()

Restores offsets after a call to setFrameElementsOffset.

getTextFormatFactoryClass

protected String getTextFormatFactoryClass(JRPrintText text)

getLocale

protected 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(String exportPropertyPrefix)
                               throws JRException

Throws:

JRException

setFontMap

protected void setFontMap()

setHyperlinkProducerFactory

protected void setHyperlinkProducerFactory()

getHyperlinkProducer

protected JRHyperlinkProducer getHyperlinkProducer(JRPrintHyperlink link)

getCustomHandler

protected JRHyperlinkProducer getCustomHandler(JRPrintHyperlink link)

Deprecated. Replaced by getHyperlinkProducer(JRPrintHyperlink).

getExporterKey

protected abstract String getExporterKey()
                                  throws JRException

Throws:

JRException