net.sf.jasperreports.engine.export

Class JRCsvMetadataExporter

java.lang.Object

net.sf.jasperreports.engine.JRAbstractExporter

net.sf.jasperreports.engine.export.JRAbstractCsvExporter

net.sf.jasperreports.engine.export.JRCsvMetadataExporter

All Implemented Interfaces:

JRExporter

public class JRCsvMetadataExporter
extends JRAbstractCsvExporter

Exports a JasperReports document to CSV format based on the metadata provided.

The exporter allows users to specify which columns should be included in the CSV export, what other value than the default should they contain and whether the values for some columns should be auto filled when they are empty or missing (e.g. value for group columns)

Version:

$Id: JRCsvMetadataExporter.java 5878 2013-01-07 20:23:13Z teodord $

Author:

Narcis Marcu (narcism@users.sourceforge.net)

Nested Class Summary

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 java.util.List<java.lang.String>	columnNames
protected boolean	writeHeader

Fields inherited from class net.sf.jasperreports.engine.export.JRAbstractCsvExporter

delimiter, encoding, nature, progressMonitor, recordDelimiter, writer

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
JRCsvMetadataExporter()
JRCsvMetadataExporter(JasperReportsContext jasperReportsContext)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	exportPage(JRPrintPage page)
protected void	setColumnNames()
protected void	setParameters()
protected void	writeCurrentRow(java.util.Map<java.lang.String,java.lang.String> currentRow, java.util.Map<java.lang.String,java.lang.String> repeatedValues) Writes the current row.
protected void	writeReportHeader() Writes the delimiter-separated column names

Methods inherited from class net.sf.jasperreports.engine.export.JRAbstractCsvExporter

exportReport, exportReportToWriter, getExporterKey, getExporterNature, getStyledText, prepareText

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, getTextFormatFactoryClass, getTextLocale, getTextTimeZone, getTextValue, getTextValueString, reset, resetClassLoader, resetExportContext, restoreElementOffsets, setClassLoader, setExportContext, setFontMap, setFrameElementsOffset, setHyperlinkProducerFactory, 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

writeHeader

protected boolean writeHeader

columnNames

protected java.util.List<java.lang.String> columnNames

Constructor Detail

JRCsvMetadataExporter

public JRCsvMetadataExporter()

See Also:

JRCsvMetadataExporter(JasperReportsContext)

JRCsvMetadataExporter

public JRCsvMetadataExporter(JasperReportsContext jasperReportsContext)

Method Detail

exportPage

protected void exportPage(JRPrintPage page)
                   throws java.io.IOException

Specified by:

exportPage in class JRAbstractCsvExporter

Throws:

java.io.IOException

setParameters

protected void setParameters()

Overrides:

setParameters in class JRAbstractCsvExporter

setColumnNames

protected void setColumnNames()

writeReportHeader

protected void writeReportHeader()
                          throws java.io.IOException

Writes the delimiter-separated column names

Throws:

java.io.IOException

writeCurrentRow

protected void writeCurrentRow(java.util.Map<java.lang.String,java.lang.String> currentRow,
                   java.util.Map<java.lang.String,java.lang.String> repeatedValues)
                        throws java.io.IOException

Writes the current row.

If the row is empty, nothing is written. If the are columns for auto fill (with valid data), they will be set on the current row and the row will be written only if it was not originally empty. This prevents the export file from having rows just with auto filled data.

Parameters:

currentRow -

repeatedValues -

Throws:

java.io.IOException