Package net.sf.jasperreports.engine.data

Class XlsDataSource

java.lang.Object

net.sf.jasperreports.engine.data.JRAbstractTextDataSource

net.sf.jasperreports.engine.data.AbstractXlsDataSource

net.sf.jasperreports.engine.data.AbstractPoiXlsDataSource

net.sf.jasperreports.engine.data.XlsDataSource

All Implemented Interfaces:

JRDataSource, JRRewindableDataSource

public class XlsDataSource
extends AbstractPoiXlsDataSource

This data source implementation reads an 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 CSV file.

Author:

Teodor Danciu ([email protected])

Field Summary

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

columnIndexMap, 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, INDEXED_COLUMN_PREFIX, numberFormat, PROPERTY_FIELD_COLUMN_INDEX, PROPERTY_FIELD_COLUMN_NAME, 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	Description
XlsDataSource(File file)	Creates a data source instance from an XLS file.
XlsDataSource(InputStream inputStream)	Creates a data source instance from an XLS data input stream.
XlsDataSource(String location)
XlsDataSource(JasperReportsContext jasperReportsContext, String location)	Creates a data source instance that reads XLS data from a given location.
XlsDataSource(RepositoryContext context, String location)
XlsDataSource(org.apache.poi.ss.usermodel.Workbook workbook)	Creates a data source instance from a workbook.

Method Summary

Modifier and Type	Method	Description
protected org.apache.poi.ss.usermodel.Workbook	loadWorkbook(InputStream inputStream)

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

checkReadStarted, close, getFieldFormatPattern, getFieldValue, getStringFieldValue, moveFirst, next

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

getColumnIndex, 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, 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

XlsDataSource

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

Creates a data source instance from a workbook.

Parameters:

workbook - the workbook

XlsDataSource

public XlsDataSource(InputStream inputStream)
              throws JRException,
                     IOException

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

Parameters:

inputStream - an input stream containing XLS data

Throws:

JRException

IOException

XlsDataSource

public XlsDataSource(File file)
              throws JRException,
                     IOException

Creates a data source instance from an XLS file.

Parameters:

file - a file containing XLS data

Throws:

JRException

IOException

XlsDataSource

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

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

Parameters:

jasperReportsContext - the JasperReportsContext

location - a String representing XLS data source

Throws:

IOException

JRException

XlsDataSource

public XlsDataSource(RepositoryContext context,
                     String location)
              throws JRException,
                     IOException

Throws:

JRException

IOException

XlsDataSource

public XlsDataSource(String location)
              throws JRException,
                     IOException

Throws:

JRException

IOException

See Also:

XlsDataSource(JasperReportsContext, String)

Method Detail

loadWorkbook

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

Specified by:

loadWorkbook in class AbstractPoiXlsDataSource

Throws:

IOException