net.sf.jasperreports.engine
Interface JRParameter

All Known Implementing Classes:

JRBaseParameter, JRDesignParameter, JRFillParameter

public interface JRParameter

Version:

$Id: JRParameter.java,v 1.17 2005/10/07 09:27:31 teodord Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

static java.lang.String	IS_IGNORE_PAGINATION Whether to use pagination.
static java.lang.String	REPORT_CLASS_LOADER A java.lang.ClassLoader instance to be used during the report filling process to load resources such as images, fonts and subreport templates.
static java.lang.String	REPORT_CONNECTION A java.sql.Connection needed to run the default report query.
static java.lang.String	REPORT_DATA_SOURCE A JRDataSource instance representing the report data source.
static java.lang.String	REPORT_LOCALE A java.util.Locale instance containing the resource bundle desired locale.
static java.lang.String	REPORT_MAX_COUNT An integer allowing users to limit the datasource size.
static java.lang.String	REPORT_PARAMETERS_MAP A Map containing report parameters passed by users at fill time.
static java.lang.String	REPORT_RESOURCE_BUNDLE The java.util.ResourceBundle containing localized messages.
static java.lang.String	REPORT_SCRIPTLET A JRAbstractScriptlet containing an instance of the report scriptlet provided by the user.
static java.lang.String	REPORT_VIRTUALIZER The JRVirtualizer to be used for page virtualization.

Method Summary

JRExpression	getDefaultValueExpression()
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.Class	getValueClass()
java.lang.String	getValueClassName()
boolean	isForPrompting()
boolean	isSystemDefined()
void	setDescription(java.lang.String description)

Field Detail

REPORT_PARAMETERS_MAP

static final java.lang.String REPORT_PARAMETERS_MAP

A Map containing report parameters passed by users at fill time.

See Also:

Constant Field Values

REPORT_CONNECTION

static final java.lang.String REPORT_CONNECTION

A java.sql.Connection needed to run the default report query.

See Also:

Constant Field Values

REPORT_MAX_COUNT

static final java.lang.String REPORT_MAX_COUNT

An integer allowing users to limit the datasource size.

See Also:

Constant Field Values

REPORT_DATA_SOURCE

static final java.lang.String REPORT_DATA_SOURCE

A JRDataSource instance representing the report data source. JasperReports defines some convenience implementations of JRDataSource, but users may create their own data sources for specific needs.

See Also:

Constant Field Values

REPORT_SCRIPTLET

static final java.lang.String REPORT_SCRIPTLET

A JRAbstractScriptlet containing an instance of the report scriptlet provided by the user.

See Also:

Constant Field Values

REPORT_LOCALE

static final java.lang.String REPORT_LOCALE

A java.util.Locale instance containing the resource bundle desired locale. This parameter should be used in conjunction with REPORT_RESOURCE_BUNDLE.

See Also:

Constant Field Values

REPORT_RESOURCE_BUNDLE

static final java.lang.String REPORT_RESOURCE_BUNDLE

The java.util.ResourceBundle containing localized messages. If the resource bundle base name is specified at design time, the engine will try to load the resource bundle using specified name and locale.

See Also:

Constant Field Values

REPORT_VIRTUALIZER

static final java.lang.String REPORT_VIRTUALIZER

The JRVirtualizer to be used for page virtualization. This parameter is optional.

See Also:

Constant Field Values

REPORT_CLASS_LOADER

static final java.lang.String REPORT_CLASS_LOADER

A java.lang.ClassLoader instance to be used during the report filling process to load resources such as images, fonts and subreport templates.

See Also:

Constant Field Values

IS_IGNORE_PAGINATION

static final java.lang.String IS_IGNORE_PAGINATION

Whether to use pagination. If set to true the report will be generated on one long page.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

getValueClass

java.lang.Class getValueClass()

getValueClassName

java.lang.String getValueClassName()

isSystemDefined

boolean isSystemDefined()

isForPrompting

boolean isForPrompting()

getDefaultValueExpression

JRExpression getDefaultValueExpression()