net.sf.jasperreports.engine.data.JRXlsDataSource Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2011 Jaspersoft Corporation. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see
* 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])
* @version $Id: JRXlsDataSource.java 5346 2012-05-08 12:08:01Z teodord $
*/
public class JRXlsDataSource extends JRAbstractTextDataSource implements JRRewindableDataSource
{
private Workbook workbook;
private DateFormat dateFormat = new SimpleDateFormat();
private NumberFormat numberFormat = new DecimalFormat();
private Map columnNames = new LinkedHashMap();
private boolean useFirstRowAsHeader;
private int recordIndex = -1;
private InputStream inputStream;
private boolean closeWorkbook;
private boolean closeInputStream;
/**
* Creates a data source instance from a workbook.
* @param workbook the workbook
*/
public JRXlsDataSource(Workbook workbook)
{
this.workbook = workbook;
this.closeWorkbook = false;
}
/**
* Creates a data source instance from an XLS data input stream.
* @param is an input stream containing XLS data
*/
public JRXlsDataSource(InputStream is) throws JRException, IOException
{
try
{
this.inputStream = is;
this.workbook = Workbook.getWorkbook(is);
this.closeWorkbook = true;
this.closeInputStream = false;
}
catch (BiffException e)
{
throw new JRException(e);
}
}
/**
* Creates a data source instance from an XLS file.
* @param file a file containing XLS data
*/
public JRXlsDataSource(File file) throws JRException, FileNotFoundException, IOException
{
this(new FileInputStream(file));
this.closeInputStream = true;
}
/**
* Creates a datasource instance that reads XLS data from a given location.
* @param jasperReportsContext the JasperReportsContext
* @param location a String representing XLS data source
* @throws IOException
*/
public JRXlsDataSource(JasperReportsContext jasperReportsContext, String location) throws JRException, IOException
{
this(RepositoryUtil.getInstance(jasperReportsContext).getInputStreamFromLocation(location));
this.closeInputStream = true;
}
/**
* @see #JRXlsDataSource(JasperReportsContext, String)
*/
public JRXlsDataSource(String location) throws JRException, IOException
{
this(DefaultJasperReportsContext.getInstance(), location);
}
/**
*
*/
public boolean next() throws JRException
{
recordIndex++;
if (workbook != null)
{
if (recordIndex == 0 && useFirstRowAsHeader)
{
readHeader();
recordIndex++;
}
if (recordIndex < workbook.getSheet(0).getRows())
{
return true;
}
else
{
if (closeWorkbook)
{
workbook.close();
}
}
}
return false;
}
/**
*
*/
public void moveFirst()
{
this.recordIndex = -1;
}
/**
*
*/
public Object getFieldValue(JRField jrField) throws JRException
{
String fieldName = jrField.getName();
Integer columnIndex = columnNames.get(fieldName);
if (columnIndex == null && fieldName.startsWith("COLUMN_")) {
columnIndex = Integer.valueOf(fieldName.substring(7));
}
if (columnIndex == null)
{
throw new JRException("Unknown column name : " + fieldName);
}
Sheet sheet = workbook.getSheet(0);
Cell cell = sheet.getCell(columnIndex.intValue(), recordIndex);
String fieldValue = cell.getContents();
Class valueClass = jrField.getValueClass();
if (valueClass.equals(String.class))
{
return fieldValue;
}
fieldValue = fieldValue.trim();
if (fieldValue.length() == 0)
{
return null;
}
try {
if (valueClass.equals(Boolean.class)) {
return fieldValue.equalsIgnoreCase("true") ? Boolean.TRUE : Boolean.FALSE;
}
else if (Number.class.isAssignableFrom(valueClass))
{
if (numberFormat != null)
{
return FormatUtils.getFormattedNumber(numberFormat, fieldValue, valueClass);
}
else
{
return convertStringValue(fieldValue, valueClass);
}
}
else if (Date.class.isAssignableFrom(valueClass)){
if (dateFormat != null)
{
return FormatUtils.getFormattedDate(dateFormat, fieldValue, valueClass);
}
else
{
return convertStringValue(fieldValue, valueClass);
}
}
else
{
throw new JRException("Field '" + jrField.getName() + "' is of class '" + valueClass.getName() + "' and can not be converted");
}
} catch (Exception e) {
throw new JRException("Unable to get value for field '" + jrField.getName() + "' of class '" + valueClass.getName() + "'", e);
}
}
/**
*
*/
private void readHeader()
{
Sheet sheet = workbook.getSheet(0);
if (columnNames.size() == 0)
{
for(int columnIndex = 0; columnIndex < sheet.getColumns(); columnIndex++)
{
Cell cell = sheet.getCell(columnIndex, recordIndex);
String columnName = cell.getContents();
if (columnName != null && columnName.trim().length() > 0)
{
columnNames.put(columnName, Integer.valueOf(columnIndex));
}
}
}
else
{
Map newColumnNames = new LinkedHashMap();
for(Iterator it = columnNames.values().iterator(); it.hasNext();)
{
Integer columnIndex = it.next();
Cell cell = sheet.getCell(columnIndex.intValue(), recordIndex);
String columnName = cell.getContents();
newColumnNames.put(columnName, columnIndex);
}
columnNames = newColumnNames;
}
}
/**
* Gets the date format that will be used to parse date fields.
*/
public DateFormat getDateFormat()
{
return dateFormat;
}
/**
* Sets the desired date format to be used for parsing date fields.
*/
public void setDateFormat(DateFormat dateFormat)
{
checkReadStarted();
this.dateFormat = dateFormat;
}
/**
* Gets the number format that will be used to parse numeric fields.
*/
public NumberFormat getNumberFormat()
{
return numberFormat;
}
/**
* Sets the desired number format to be used for parsing numeric fields.
*/
public void setNumberFormat(NumberFormat numberFormat)
{
checkReadStarted();
this.numberFormat = numberFormat;
}
/**
* Specifies an array of strings representing column names matching field names in the report template.
*/
public void setColumnNames(String[] columnNames)
{
checkReadStarted();
for (int i = 0; i < columnNames.length; i++)
{
this.columnNames.put(columnNames[i], Integer.valueOf(i));
}
}
/**
* 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.
*/
public void setColumnNames(String[] columnNames, int[] columnIndexes)
{
checkReadStarted();
if (columnNames.length != columnIndexes.length)
{
throw new JRRuntimeException("The number of column names must be equal to the number of column indexes.");
}
for (int i = 0; i < columnNames.length; i++)
{
this.columnNames.put(columnNames[i], Integer.valueOf(columnIndexes[i]));
}
}
/**
* Specifies an array of integers representing the column indexes in the sheet.
*/
public void setColumnIndexes(Integer[] columnIndexes)
{
checkReadStarted();
for (int i = 0; i < columnIndexes.length; i++)
{
this.columnNames.put("COLUMN_" + i, columnIndexes[i]);
}
}
/**
* 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.
*/
public void setUseFirstRowAsHeader(boolean useFirstRowAsHeader)
{
checkReadStarted();
this.useFirstRowAsHeader = useFirstRowAsHeader;
}
/**
* Closes the reader. Users of this data source should close it after usage.
*/
public void close()
{
try
{
if (closeInputStream)
{
inputStream.close();
}
}
catch(IOException e)
{
//nothing to do
}
}
private void checkReadStarted()
{
if (recordIndex > 0)
{
throw new JRRuntimeException("Cannot modify data source properties after data reading has started.");
}
}
public Map getColumnNames() {
return columnNames;
}
}