public abstract class JRAbstractExporter<RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput,E extends JRExporterContext> extends java.lang.Object implements JRExporter<ExporterInput,RC,C,O>
Modifier and Type | Class and Description |
---|---|
class |
JRAbstractExporter.BaseExporterContext |
protected class |
JRAbstractExporter.PageRange |
Modifier | Constructor and Description |
---|---|
protected |
JRAbstractExporter()
Deprecated.
Replaced by
JRAbstractExporter(JasperReportsContext) . |
protected |
JRAbstractExporter(JasperReportsContext jasperReportsContext) |
Modifier and Type | Method and Description |
---|---|
protected ExporterFilter |
createFilter() |
protected java.lang.Number |
defaultParseNumber(java.lang.String textStr,
java.lang.Class<?> valueClass) |
protected void |
ensureInput() |
protected void |
ensureJasperReportsContext() |
protected abstract void |
ensureOutput() |
abstract void |
exportReport()
Performs the export.
|
protected TextValue |
getBooleanCellValue(JRPrintText text,
java.lang.String textStr) |
protected abstract java.lang.Class<C> |
getConfigurationInterface() |
protected C |
getCurrentConfiguration() |
protected RC |
getCurrentItemConfiguration() |
JasperPrint |
getCurrentJasperPrint() |
protected JRHyperlinkProducer |
getCustomHandler(JRPrintHyperlink link)
Deprecated.
Replaced by
getHyperlinkProducer(JRPrintHyperlink) . |
protected TextValue |
getDateCellValue(JRPrintText text,
java.lang.String textStr) |
protected java.text.DateFormat |
getDateFormat(java.lang.String formatFactoryClass,
java.lang.String pattern,
java.util.Locale lc,
java.util.TimeZone tz) |
E |
getExporterContext() |
protected ExporterInput |
getExporterInput() |
abstract java.lang.String |
getExporterKey() |
protected O |
getExporterOutput() |
abstract java.lang.String |
getExporterPropertiesPrefix()
Returns the properties prefix for the current exporter.
|
JRHyperlinkProducer |
getHyperlinkProducer(JRPrintHyperlink link) |
protected abstract java.lang.Class<RC> |
getItemConfigurationInterface() |
JasperReportsContext |
getJasperReportsContext() |
protected java.util.Locale |
getLocale() |
protected TextValue |
getNumberCellValue(JRPrintText text,
java.lang.String textStr) |
protected java.text.NumberFormat |
getNumberFormat(java.lang.String formatFactoryClass,
java.lang.String pattern,
java.util.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.PageRange |
getPageRange() |
java.lang.Object |
getParameter(JRExporterParameter parameter)
|
java.util.Map<JRExporterParameter,java.lang.Object> |
getParameters()
|
JRPropertiesUtil |
getPropertiesUtil() |
ReportContext |
getReportContext() |
protected JRStyledText |
getStyledText(JRPrintText textElement) |
protected JRStyledText |
getStyledText(JRPrintText textElement,
boolean setBackcolor) |
protected java.lang.String |
getTextFormatFactoryClass(JRPrintText text) |
protected java.util.Locale |
getTextLocale(JRPrintText text) |
protected java.util.TimeZone |
getTextTimeZone(JRPrintText text) |
protected TextValue |
getTextValue(JRPrintText text,
java.lang.String textStr) |
protected TextValue |
getTextValueString(JRPrintText text,
java.lang.String textStr) |
protected void |
initExport() |
protected void |
initReport() |
protected boolean |
insideFrame() |
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 |
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 |
setJasperPrint(JasperPrint jasperPrint)
Deprecated.
Replaced by
setCurrentExporterInputItem(ExporterInputItem) . |
protected void |
setJasperReportsContext(JasperReportsContext jasperReportsContext) |
protected void |
setOffset() |
protected void |
setOffset(boolean setElementOffsets) |
void |
setParameter(JRExporterParameter parameter,
java.lang.Object value)
|
void |
setParameters(java.util.Map<JRExporterParameter,java.lang.Object> parameters)
|
void |
setReportContext(ReportContext reportContext) |
public static final java.lang.String EXCEPTION_MESSAGE_KEY_START_PAGE_INDEX_OUT_OF_RANGE
public static final java.lang.String EXCEPTION_MESSAGE_KEY_END_PAGE_INDEX_OUT_OF_RANGE
public static final java.lang.String EXCEPTION_MESSAGE_KEY_INVALID_IMAGE_NAME
public static final java.lang.String EXCEPTION_MESSAGE_KEY_INVALID_ZOOM_RATIO
public static final java.lang.String EXCEPTION_MESSAGE_KEY_MIXED_CALLS_NOT_ALLOWED
public static final java.lang.String EXCEPTION_MESSAGE_KEY_PAGE_INDEX_OUT_OF_RANGE
public static final java.lang.String EXCEPTION_MESSAGE_KEY_OUTPUT_WRITER_ERROR
public static final java.lang.String PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY
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.public static final java.lang.String PROPERTY_DEFAULT_FILTER_FACTORY
protected JasperReportsContext jasperReportsContext
protected JRPropertiesUtil propertiesUtil
protected JRStyledTextAttributeSelector allSelector
protected JRStyledTextAttributeSelector noBackcolorSelector
protected JRStyledTextAttributeSelector noneSelector
protected JRStyledTextUtil styledTextUtil
protected java.util.Map<JRExporterParameter,java.lang.Object> parameters
protected ExporterInput exporterInput
protected RC extends ReportExportConfiguration itemConfiguration
protected C extends ExporterConfiguration exporterConfiguration
protected O extends ExporterOutput exporterOutput
protected ExporterInputItem crtItem
protected RC extends ReportExportConfiguration crtCompositeItemConfiguration
protected C extends ExporterConfiguration crtCompositeConfiguration
protected JasperPrint jasperPrint
protected ExporterFilter filter
protected java.util.Map<java.lang.String,java.text.DateFormat> dateFormatCache
protected java.util.Map<java.lang.String,java.text.NumberFormat> numberFormatCache
protected java.util.Map<java.lang.String,java.lang.Class<?>> textValueClasses
protected E extends JRExporterContext exporterContext
protected JRAbstractExporter()
JRAbstractExporter(JasperReportsContext)
.protected JRAbstractExporter(JasperReportsContext jasperReportsContext)
public void reset()
public void setParameter(JRExporterParameter parameter, java.lang.Object value)
setExporterInput(ExporterInput)
, setConfiguration(ExporterConfiguration)
,
setConfiguration(ReportExportConfiguration)
and setExporterOutput(ExporterOutput)
JRExporter
setParameter
in interface JRExporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
parameter
- the parameter, selected from the static parameters defined by JasperReportsvalue
- the parameter valueJRExporterParameter
public java.lang.Object getParameter(JRExporterParameter parameter)
setExporterInput(ExporterInput)
, setConfiguration(ExporterConfiguration)
,
setConfiguration(ReportExportConfiguration)
and setExporterOutput(ExporterOutput)
.JRExporter
getParameter
in interface JRExporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public void setParameters(java.util.Map<JRExporterParameter,java.lang.Object> parameters)
setExporterInput(ExporterInput)
, setConfiguration(ExporterConfiguration)
,
setConfiguration(ReportExportConfiguration)
and setExporterOutput(ExporterOutput)
JRExporter
setParameters
in interface JRExporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
JRExporter.setParameter(JRExporterParameter, Object)
public java.util.Map<JRExporterParameter,java.lang.Object> getParameters()
setExporterInput(ExporterInput)
, setConfiguration(ExporterConfiguration)
,
setConfiguration(ReportExportConfiguration)
and setExporterOutput(ExporterOutput)
JRExporter
getParameters
in interface JRExporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
protected ExporterInput getExporterInput()
public void setExporterInput(ExporterInput exporterInput)
Exporter
setExporterInput
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
protected O getExporterOutput()
public void setExporterOutput(O exporterOutput)
Exporter
setExporterOutput
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public void setConfiguration(RC configuration)
setConfiguration
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public void setConfiguration(C configuration)
setConfiguration
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public JasperReportsContext getJasperReportsContext()
protected void setJasperReportsContext(JasperReportsContext jasperReportsContext)
public void setReportContext(ReportContext reportContext)
setReportContext
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public ReportContext getReportContext()
getReportContext
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
public JRPropertiesUtil getPropertiesUtil()
public abstract void exportReport() throws JRException
Exporter
exportReport
in interface Exporter<ExporterInput,RC extends ReportExportConfiguration,C extends ExporterConfiguration,O extends ExporterOutput>
JRException
protected void setOffset()
protected void setOffset(boolean setElementOffsets)
protected void ensureJasperReportsContext()
protected void resetExportContext()
protected void setClassLoader()
setExportContext
protected void resetClassLoader()
resetExportContext
protected void setCurrentExporterInputItem(ExporterInputItem crtItem)
protected RC getCurrentItemConfiguration()
protected C getCurrentConfiguration()
protected void setJasperPrint(JasperPrint jasperPrint)
setCurrentExporterInputItem(ExporterInputItem)
.protected abstract java.lang.Class<C> getConfigurationInterface()
protected abstract java.lang.Class<RC> getItemConfigurationInterface()
protected void ensureInput()
protected abstract void ensureOutput()
protected void initExport()
protected void initReport()
protected JRAbstractExporter.PageRange getPageRange()
protected JRStyledText getStyledText(JRPrintText textElement, boolean setBackcolor)
protected JRStyledText getStyledText(JRPrintText textElement)
protected int getOffsetX()
protected int getOffsetY()
protected void setFrameElementsOffset(JRPrintFrame frame, boolean relative)
frame
.
After the frame elements are exported, a call to popElementOffsets
is required
so that the previous offsets are restored.
frame
- relative
- getOffsetX()
,
getOffsetY()
,
restoreElementOffsets()
protected void restoreElementOffsets()
setFrameElementsOffset
.protected boolean insideFrame()
protected java.lang.String getTextFormatFactoryClass(JRPrintText text)
protected java.util.Locale getLocale()
protected java.util.Locale getTextLocale(JRPrintText text)
protected java.util.TimeZone getTextTimeZone(JRPrintText text)
protected TextValue getTextValue(JRPrintText text, java.lang.String textStr)
protected TextValue getTextValueString(JRPrintText text, java.lang.String textStr)
protected TextValue getDateCellValue(JRPrintText text, java.lang.String textStr) throws java.text.ParseException
java.text.ParseException
protected TextValue getNumberCellValue(JRPrintText text, java.lang.String textStr) throws java.text.ParseException, java.lang.ClassNotFoundException
java.text.ParseException
java.lang.ClassNotFoundException
protected java.lang.Number defaultParseNumber(java.lang.String textStr, java.lang.Class<?> valueClass)
protected TextValue getBooleanCellValue(JRPrintText text, java.lang.String textStr)
protected java.text.DateFormat getDateFormat(java.lang.String formatFactoryClass, java.lang.String pattern, java.util.Locale lc, java.util.TimeZone tz)
protected java.text.NumberFormat getNumberFormat(java.lang.String formatFactoryClass, java.lang.String pattern, java.util.Locale lc)
protected ExporterFilter createFilter()
public JRHyperlinkProducer getHyperlinkProducer(JRPrintHyperlink link)
protected JRHyperlinkProducer getCustomHandler(JRPrintHyperlink link)
getHyperlinkProducer(JRPrintHyperlink)
.public abstract java.lang.String getExporterKey()
public abstract java.lang.String getExporterPropertiesPrefix()
public E getExporterContext()
public JasperPrint getCurrentJasperPrint()
© 2001-2014 TIBCO Software Inc. www.jaspersoft.com