net.sf.jasperreports.engine.data

Class AbstractPoiXlsDataSource

java.lang.Object

net.sf.jasperreports.engine.data.JRAbstractTextDataSource

net.sf.jasperreports.engine.data.AbstractXlsDataSource

net.sf.jasperreports.engine.data.AbstractPoiXlsDataSource

All Implemented Interfaces:

JRDataSource, JRRewindableDataSource

Direct Known Subclasses:

ExcelDataSource, JRXlsxDataSource, XlsDataSource

public abstract class AbstractPoiXlsDataSource
extends AbstractXlsDataSource

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.

Author:

sanda zaharia (shertage@users.sourceforge.net)

Field Summary

Fields inherited from class net.sf.jasperreports.engine.data.AbstractXlsDataSource

columnNames, dateFormat, EXCEPTION_MESSAGE_KEY_XLS_COLUMN_NAMES_MISMATCH_COLUMN_INDEXES, EXCEPTION_MESSAGE_KEY_XLS_FIELD_VALUE_NOT_RETRIEVED, EXCEPTION_MESSAGE_KEY_XLS_SHEET_INDEX_OUT_OF_RANGE, EXCEPTION_MESSAGE_KEY_XLS_SHEET_NOT_FOUND, numberFormat, sheetSelection, useFirstRowAsHeader

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

EXCEPTION_MESSAGE_KEY_CANNOT_CONVERT_FIELD_TYPE, EXCEPTION_MESSAGE_KEY_CANNOT_MODIFY_PROPERTIES_AFTER_START, EXCEPTION_MESSAGE_KEY_NODE_NOT_AVAILABLE, EXCEPTION_MESSAGE_KEY_NULL_DOCUMENT, EXCEPTION_MESSAGE_KEY_NULL_SELECT_EXPRESSION, EXCEPTION_MESSAGE_KEY_UNKNOWN_COLUMN_NAME, EXCEPTION_MESSAGE_KEY_UNKNOWN_NUMBER_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractPoiXlsDataSource(File file) Creates a data source instance from an XLSX or XLS file.
AbstractPoiXlsDataSource(InputStream is) Creates a data source instance from an XLSX or XLS data input stream.
AbstractPoiXlsDataSource(JasperReportsContext jasperReportsContext, String location) Creates a data source instance that reads XLSX or XLS data from a given location.
AbstractPoiXlsDataSource(String location)
AbstractPoiXlsDataSource(org.apache.poi.ss.usermodel.Workbook workbook) Creates a data source instance from a workbook.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkReadStarted()
void	close() Closes the reader.
Object	getFieldValue(JRField jrField) Gets the field value for the current position.
protected abstract org.apache.poi.ss.usermodel.Workbook	loadWorkbook(InputStream is)
void	moveFirst() Moves back to the first element in the data source.
boolean	next() Tries to position the cursor on the next element in the data source.

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

getColumnNames, getDateFormat, getNumberFormat, getSheetSelection, setColumnIndexes, setColumnNames, setColumnNames, setDateFormat, setNumberFormat, setSheetSelection, setUseFirstRowAsHeader

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPoiXlsDataSource

public AbstractPoiXlsDataSource(org.apache.poi.ss.usermodel.Workbook workbook)

Creates a data source instance from a workbook.

Parameters:

workbook - the workbook

AbstractPoiXlsDataSource

public AbstractPoiXlsDataSource(InputStream is)
                         throws JRException,
                                IOException

Creates a data source instance from an XLSX or XLS data input stream.

Parameters:

is - an input stream containing XLSX or XLS data

Throws:

JRException

IOException

AbstractPoiXlsDataSource

public AbstractPoiXlsDataSource(File file)
                         throws JRException,
                                IOException

Creates a data source instance from an XLSX or XLS file.

Parameters:

file - a file containing XLSX or XLS data

Throws:

JRException

IOException

AbstractPoiXlsDataSource

public AbstractPoiXlsDataSource(JasperReportsContext jasperReportsContext,
                        String location)
                         throws JRException,
                                IOException

Creates a data source instance that reads XLSX or XLS data from a given location.

Parameters:

jasperReportsContext - the JasperReportsContext

location - a String representing XLSX or XLS data source

Throws:

IOException

JRException

AbstractPoiXlsDataSource

public AbstractPoiXlsDataSource(String location)
                         throws JRException,
                                IOException

Throws:

JRException

IOException

See Also:

AbstractPoiXlsDataSource(JasperReportsContext, String)

Method Detail

loadWorkbook

protected abstract org.apache.poi.ss.usermodel.Workbook loadWorkbook(InputStream is)
                                                              throws IOException

Throws:

IOException

next

public boolean next()
             throws JRException

Description copied from interface: JRDataSource

Tries to position the cursor on the next element in the data source.

Returns:

true if there is a next record, false otherwise

Throws:

JRException - if any error occurs while trying to move to the next element

moveFirst

public void moveFirst()

Description copied from interface: JRRewindableDataSource

Moves back to the first element in the data source.

getFieldValue

public Object getFieldValue(JRField jrField)
                     throws JRException

Description copied from interface: JRDataSource

Gets the field value for the current position.

Returns:

an object containing the field value. The object type must be the field object type.

Throws:

JRException

close

public void close()

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

Specified by:

close in class AbstractXlsDataSource

checkReadStarted

protected void checkReadStarted()

Specified by:

checkReadStarted in class AbstractXlsDataSource