net.sf.jasperreports.engine.export.GenericElementXlsMetadataHandler Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. 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 .
*/
package net.sf.jasperreports.engine.export;
import java.util.List;
import java.util.Map;
import net.sf.jasperreports.engine.JRGenericPrintElement;
/**
* A generic print element XLS export handler.
*
* @author Sanda Zaharia ([email protected])
*/
public interface GenericElementXlsMetadataHandler extends GenericElementHandler
{
/**
* Exports a generic element.
*
*
* Access to the exporter output and environment is provided via the
* {@link JRXlsExporterContext} argument.
*
* @param exporterContext the exporter context
* @param element the generic element to export
* @param currentRow the map with column names as keys and exported CellSettings objects as values
* @param repeatedValues the map containing CellSettings objects to be placed instead in the currentRow map when the exported object is null
* @param columnNames the list of column names
* @param columnNamesMap the map containing the mapping between column names and column indexes
* @param currentColumnName the current column's name
* @param colIndex the current column index
* @param rowIndex the current row index
* @param repeatValue the flag specifying if null values should be replaced with objects from the repeatedValues map
*
* @return int value representing the resulting row index, if this was incremented during export
*/
int exportElement(
JRXlsExporterContext exporterContext,
JRGenericPrintElement element,
Map currentRow,
Map repeatedValues,
List columnNames,
Map columnNamesMap,
String currentColumnName,
int colIndex,
int rowIndex,
boolean repeatValue
);
}