net.sf.jasperreports.engine.data

Class AbstractXlsDataSource

java.lang.Object

net.sf.jasperreports.engine.data.JRAbstractTextDataSource

net.sf.jasperreports.engine.data.AbstractXlsDataSource

All Implemented Interfaces:

JRDataSource, JRRewindableDataSource

Direct Known Subclasses:

AbstractPoiXlsDataSource, JRXlsDataSource

public abstract class AbstractXlsDataSource
extends JRAbstractTextDataSource
implements JRRewindableDataSource

This data source implementation reads an XLSX or XLS stream.

The default naming convention is to name report fields COLUMN_x and map each column with the field found at index x in each row (these indices start with 0). To avoid this situation, users can either specify a collection of column names or set a flag to read the column names from the first row of the XLSX or XLS file.

Version:

$Id: AbstractXlsDataSource.java 7199 2014-08-27 13:58:10Z teodord $

Author:

sanda zaharia (shertage@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Integer>	columnNames
protected DateFormat	dateFormat
protected NumberFormat	numberFormat
protected String	sheetSelection
protected boolean	useFirstRowAsHeader

Constructor Summary

Constructors

Constructor and Description
AbstractXlsDataSource()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	checkReadStarted()
abstract void	close() Closes the reader.
Map<String,Integer>	getColumnNames()
DateFormat	getDateFormat() Gets the date format that will be used to parse date fields.
NumberFormat	getNumberFormat() Gets the number format that will be used to parse numeric fields.
String	getSheetSelection()
void	setColumnIndexes(Integer[] columnIndexes) Specifies an array of integers representing the column indexes in the sheet.
void	setColumnNames(String[] columnNames) Specifies an array of strings representing column names matching field names in the report template.
void	setColumnNames(String[] columnNames, int[] columnIndexes) Specifies an array of strings representing column names matching field names in the report template and an array of integers representing the column indexes in the sheet.
void	setDateFormat(DateFormat dateFormat) Sets the desired date format to be used for parsing date fields.
void	setNumberFormat(NumberFormat numberFormat) Sets the desired number format to be used for parsing numeric fields.
void	setSheetSelection(String sheetSelection)
void	setUseFirstRowAsHeader(boolean useFirstRowAsHeader) Specifies whether the first row of the XLS file should be considered a table header, containing column names matching field names in the report template.

Methods inherited from class net.sf.jasperreports.engine.data.JRAbstractTextDataSource

convertNumber, convertStringValue, getConvertBean, getDatePattern, getFormattedDate, getFormattedNumber, getLocale, getNumberPattern, getTimeZone, setDatePattern, setLocale, setLocale, setNumberPattern, setTextAttributes, setTimeZone, setTimeZone

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.engine.JRRewindableDataSource

moveFirst

Methods inherited from interface net.sf.jasperreports.engine.JRDataSource

getFieldValue, next

Field Detail

sheetSelection

protected String sheetSelection

dateFormat

protected DateFormat dateFormat

numberFormat

protected NumberFormat numberFormat

columnNames

protected Map<String,Integer> columnNames

useFirstRowAsHeader

protected boolean useFirstRowAsHeader

Constructor Detail

AbstractXlsDataSource

public AbstractXlsDataSource()

Method Detail

getDateFormat

public DateFormat getDateFormat()

Gets the date format that will be used to parse date fields.

setDateFormat

public void setDateFormat(DateFormat dateFormat)

Sets the desired date format to be used for parsing date fields.

getNumberFormat

public NumberFormat getNumberFormat()

Gets the number format that will be used to parse numeric fields.

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

Sets the desired number format to be used for parsing numeric fields.

setColumnNames

public void setColumnNames(String[] columnNames)

Specifies an array of strings representing column names matching field names in the report template.

setColumnNames

public void setColumnNames(String[] columnNames,
                  int[] columnIndexes)

Specifies an array of strings representing column names matching field names in the report template and an array of integers representing the column indexes in the sheet. Both array parameters must be not-null and have the same number of values.

setColumnIndexes

public void setColumnIndexes(Integer[] columnIndexes)

Specifies an array of integers representing the column indexes in the sheet.

setUseFirstRowAsHeader

public void setUseFirstRowAsHeader(boolean useFirstRowAsHeader)

Specifies whether the first row of the XLS file should be considered a table header, containing column names matching field names in the report template.

close

public abstract void close()

Closes the reader. Users of this data source should close it after usage.

checkReadStarted

protected abstract void checkReadStarted()

getColumnNames

public Map<String,Integer> getColumnNames()

getSheetSelection

public String getSheetSelection()

setSheetSelection

public void setSheetSelection(String sheetSelection)