net.sf.jasperreports.engine.data

Class JRXlsDataSource

java.lang.Object

net.sf.jasperreports.engine.data.JRAbstractTextDataSource

net.sf.jasperreports.engine.data.JRXlsDataSource

All Implemented Interfaces:

JRDataSource, JRRewindableDataSource

public class JRXlsDataSource
extends JRAbstractTextDataSource
implements JRRewindableDataSource

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.

Version:

$Id: JRXlsDataSource.java 5346 2012-05-08 12:08:01Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
JRXlsDataSource(File file) Creates a data source instance from an XLS file.
JRXlsDataSource(InputStream is) Creates a data source instance from an XLS data input stream.
JRXlsDataSource(JasperReportsContext jasperReportsContext, String location) Creates a datasource instance that reads XLS data from a given location.
JRXlsDataSource(String location)
JRXlsDataSource(jxl.Workbook workbook) Creates a data source instance from a workbook.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the reader.
Map<String,Integer>	getColumnNames()
DateFormat	getDateFormat() Gets the date format that will be used to parse date fields.
Object	getFieldValue(JRField jrField) Gets the field value for the current position.
NumberFormat	getNumberFormat() Gets the number format that will be used to parse numeric fields.
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.
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	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

Constructor Detail

JRXlsDataSource

public JRXlsDataSource(jxl.Workbook workbook)

Creates a data source instance from a workbook.

Parameters:

workbook - the workbook

JRXlsDataSource

public JRXlsDataSource(InputStream is)
                throws JRException,
                       IOException

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

Parameters:

is - an input stream containing XLS data

Throws:

JRException

IOException

JRXlsDataSource

public JRXlsDataSource(File file)
                throws JRException,
                       FileNotFoundException,
                       IOException

Creates a data source instance from an XLS file.

Parameters:

file - a file containing XLS data

Throws:

JRException

FileNotFoundException

IOException

JRXlsDataSource

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

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

Parameters:

jasperReportsContext - the JasperReportsContext

location - a String representing XLS data source

Throws:

IOException

JRException

JRXlsDataSource

public JRXlsDataSource(String location)
                throws JRException,
                       IOException

Throws:

JRException

IOException

See Also:

JRXlsDataSource(JasperReportsContext, String)

Method Detail

next

public boolean next()
             throws JRException

Description copied from interface: JRDataSource

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

Specified by:

next in interface JRDataSource

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.

Specified by:

moveFirst in interface JRRewindableDataSource

getFieldValue

public Object getFieldValue(JRField jrField)
                     throws JRException

Description copied from interface: JRDataSource

Gets the field value for the current position.

Specified by:

getFieldValue in interface JRDataSource

Returns:

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

Throws:

JRException

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 void close()

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

getColumnNames

public Map<String,Integer> getColumnNames()