public abstract class AbstractPoiXlsDataSource extends AbstractXlsDataSource
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.
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
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 and Description |
---|
AbstractPoiXlsDataSource(JasperReportsContext jasperReportsContext,
java.lang.String location)
Creates a data source instance that reads XLSX or XLS data from a given location.
|
AbstractPoiXlsDataSource(Workbook workbook)
Creates a data source instance from a workbook.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkReadStarted() |
void |
close()
Closes the reader.
|
java.lang.Object |
getFieldValue(JRField jrField)
Gets the field value for the current position.
|
protected abstract Workbook |
loadWorkbook(java.io.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.
|
getColumnNames, getDateFormat, getNumberFormat, getSheetSelection, setColumnIndexes, setColumnNames, setColumnNames, setDateFormat, setNumberFormat, setSheetSelection, setUseFirstRowAsHeader
convertNumber, convertStringValue, getConvertBean, getDatePattern, getFormattedDate, getFormattedNumber, getLocale, getNumberPattern, getTextAttributes, getTimeZone, setDatePattern, setLocale, setLocale, setNumberPattern, setTextAttributes, setTextAttributes, setTimeZone, setTimeZone
public AbstractPoiXlsDataSource(Workbook workbook)
workbook
- the workbookpublic AbstractPoiXlsDataSource(JasperReportsContext jasperReportsContext, java.lang.String location) throws JRException, java.io.IOException
jasperReportsContext
- the JasperReportsContextlocation
- a String representing XLSX or XLS data sourcejava.io.IOException
JRException
protected abstract Workbook loadWorkbook(java.io.InputStream is) throws java.io.IOException
java.io.IOException
public boolean next() throws JRException
JRDataSource
JRException
- if any error occurs while trying to move to the next elementpublic void moveFirst()
JRRewindableDataSource
public java.lang.Object getFieldValue(JRField jrField) throws JRException
JRDataSource
JRException
public void close()
close
in class AbstractXlsDataSource
protected void checkReadStarted()
checkReadStarted
in class AbstractXlsDataSource
© 2001-2014 TIBCO Software Inc. www.jaspersoft.com