net.sf.jasperreports.engine.export
Class JRXlsAbstractMetadataExporterParameter

java.lang.Object
  net.sf.jasperreports.engine.JRExporterParameter
      net.sf.jasperreports.engine.export.JRXlsAbstractExporterParameter
          net.sf.jasperreports.engine.export.JRXlsAbstractMetadataExporterParameter

public class JRXlsAbstractMetadataExporterParameter
extends JRXlsAbstractExporterParameter

Contains parameters useful for export to XLS format based on metadata.

Version:

$Id: JRXlsAbstractMetadataExporterParameter.java 5180 2012-03-29 13:23:12Z teodord $

Author:

sanda zaharia (shertage@users.sourceforge.net)

Field Summary

static JRXlsAbstractMetadataExporterParameter	COLUMN_NAMES An array of strings representing the comma-separated names of the columns that should be exported.
static String	PROPERTY_COLUMN_NAME A string that represents the name for the column that should appear in the XLS export.
static String	PROPERTY_COLUMN_NAMES_PREFIX Properties having this prefix contain comma-separated column names.
static String	PROPERTY_DATA Property that specifies what value to associate with PROPERTY_COLUMN_NAME.
static String	PROPERTY_REPEAT_VALUE Property that specifies whether the value associated with PROPERTY_COLUMN_NAME should be repeated or not when it is missing.
static String	PROPERTY_WRITE_HEADER Property whose value is used as default for the WRITE_HEADER export parameter.
static JRXlsAbstractMetadataExporterParameter	WRITE_HEADER A boolean that specifies whether the export header (the column names) should be written or not.

Fields inherited from class net.sf.jasperreports.engine.export.JRXlsAbstractExporterParameter

CREATE_CUSTOM_PALETTE, FORMAT_PATTERNS_MAP, IS_COLLAPSE_ROW_SPAN, IS_DETECT_CELL_TYPE, IS_FONT_SIZE_FIX_ENABLED, IS_IGNORE_CELL_BACKGROUND, IS_IGNORE_CELL_BORDER, IS_IGNORE_GRAPHICS, IS_IMAGE_BORDER_FIX_ENABLED, IS_ONE_PAGE_PER_SHEET, IS_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS, IS_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, IS_WHITE_PAGE_BACKGROUND, MAXIMUM_ROWS_PER_SHEET, PASSWORD, PROPERTY_COLLAPSE_ROW_SPAN, PROPERTY_CREATE_CUSTOM_PALETTE, PROPERTY_DETECT_CELL_TYPE, PROPERTY_FONT_SIZE_FIX_ENABLED, PROPERTY_IGNORE_CELL_BACKGROUND, PROPERTY_IGNORE_CELL_BORDER, PROPERTY_IGNORE_GRAPHICS, PROPERTY_IMAGE_BORDER_FIX_ENABLED, PROPERTY_MAXIMUM_ROWS_PER_SHEET, PROPERTY_ONE_PAGE_PER_SHEET, PROPERTY_PASSWORD, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, PROPERTY_SHEET_NAME, PROPERTY_SHEET_NAMES_PREFIX, PROPERTY_WHITE_PAGE_BACKGROUND, SHEET_NAMES

Fields inherited from class net.sf.jasperreports.engine.JRExporterParameter

CHARACTER_ENCODING, CLASS_LOADER, END_PAGE_INDEX, FILE_RESOLVER, FILTER, FONT_MAP, HYPERLINK_PRODUCER_FACTORY, IGNORE_PAGE_MARGINS, INPUT_FILE, INPUT_FILE_NAME, INPUT_STREAM, INPUT_URL, JASPER_PRINT, JASPER_PRINT_LIST, OFFSET_X, OFFSET_Y, OUTPUT_FILE, OUTPUT_FILE_NAME, OUTPUT_STREAM, OUTPUT_STRING_BUFFER, OUTPUT_WRITER, PAGE_INDEX, PARAMETERS_OVERRIDE_REPORT_HINTS, PROGRESS_MONITOR, PROPERTY_CHARACTER_ENCODING, PROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS, PROPERTY_IGNORE_PAGE_MARGINS, START_PAGE_INDEX, URL_HANDLER_FACTORY

Constructor Summary

protected

JRXlsAbstractMetadataExporterParameter(String name)

Method Summary

Methods inherited from class net.sf.jasperreports.engine.JRExporterParameter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLUMN_NAMES

public static final JRXlsAbstractMetadataExporterParameter COLUMN_NAMES

An array of strings representing the comma-separated names of the columns that should be exported. NOTE: The order of the columns is important and for accurate results they should be in the same order as the original columns.

PROPERTY_COLUMN_NAMES_PREFIX

public static final String PROPERTY_COLUMN_NAMES_PREFIX

Properties having this prefix contain comma-separated column names.

See Also:

JRPropertiesUtil, Constant Field Values

WRITE_HEADER

public static final JRXlsAbstractMetadataExporterParameter WRITE_HEADER

A boolean that specifies whether the export header (the column names) should be written or not.

See Also:

JRPropertiesUtil

PROPERTY_WRITE_HEADER

public static final String PROPERTY_WRITE_HEADER

Property whose value is used as default for the WRITE_HEADER export parameter.

The property itself defaults to false.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_COLUMN_NAME

public static final String PROPERTY_COLUMN_NAME

A string that represents the name for the column that should appear in the XLS export. It must be one of the values in COLUMN_NAMES, if provided.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_REPEAT_VALUE

public static final String PROPERTY_REPEAT_VALUE

Property that specifies whether the value associated with PROPERTY_COLUMN_NAME should be repeated or not when it is missing.

The property itself defaults to false.

See Also:

JRPropertiesUtil, Constant Field Values

PROPERTY_DATA

public static final String PROPERTY_DATA

Property that specifies what value to associate with PROPERTY_COLUMN_NAME.

The property itself defaults to the text value of the report element that this property is assigned to.

See Also:

JRPropertiesUtil, Constant Field Values

Constructor Detail

JRXlsAbstractMetadataExporterParameter

protected JRXlsAbstractMetadataExporterParameter(String name)