|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRParameter
Field Summary | |
---|---|
static java.lang.String |
FILTER
A DatasetFilter to be used in addition to JRDataset.getFilterExpression()
for filtering dataset rows. |
static java.lang.String |
IS_IGNORE_PAGINATION
Whether to use pagination. |
static java.lang.String |
JASPER_REPORT
A net.sf.jasperreports.engine.JasperReport instance representing the current report template. |
static java.lang.String |
REPORT_CLASS_LOADER
Deprecated. Replaced by JasperReportsContext . |
static java.lang.String |
REPORT_CONNECTION
A java.sql.Connection needed to run the default report query. |
static java.lang.String |
REPORT_CONTEXT
|
static java.lang.String |
REPORT_DATA_SOURCE
A JRDataSource instance representing the report data source. |
static java.lang.String |
REPORT_FILE_RESOLVER
Deprecated. Replaced by JasperReportsContext . |
static java.lang.String |
REPORT_FORMAT_FACTORY
A FormatFactory instance to be used
during the report filling process to create instances of java.text.DateFormat to format date text
fields and instances of java.text.NumberFormat to format numeric text fields. |
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_TEMPLATES
A collection of templates passed to the
report at fill time. |
static java.lang.String |
REPORT_TIME_ZONE
A java.util.TimeZone instance to use for date formatting. |
static java.lang.String |
REPORT_URL_HANDLER_FACTORY
Deprecated. Replaced by JasperReportsContext . |
static java.lang.String |
REPORT_VIRTUALIZER
The JRVirtualizer to be used for page virtualization. |
static java.lang.String |
SORT_FIELDS
|
Method Summary | |
---|---|
JRExpression |
getDefaultValueExpression()
|
java.lang.String |
getDescription()
|
java.lang.String |
getName()
|
java.lang.Class<?> |
getNestedType()
Returns the parameter nested value type. |
java.lang.String |
getNestedTypeName()
Returns the name of the parameter nested value type. |
java.lang.Class<?> |
getValueClass()
|
java.lang.String |
getValueClassName()
|
boolean |
isForPrompting()
|
boolean |
isSystemDefined()
|
void |
setDescription(java.lang.String description)
|
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Field Detail |
---|
static final java.lang.String REPORT_PARAMETERS_MAP
static final java.lang.String JASPER_REPORT
static final java.lang.String REPORT_CONNECTION
static final java.lang.String REPORT_MAX_COUNT
static final java.lang.String REPORT_DATA_SOURCE
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.
static final java.lang.String REPORT_SCRIPTLET
JRAbstractScriptlet
containing an instance of the report scriptlet provided by the user.
static final java.lang.String REPORT_LOCALE
static final java.lang.String REPORT_RESOURCE_BUNDLE
static final java.lang.String REPORT_TIME_ZONE
static final java.lang.String REPORT_VIRTUALIZER
JRVirtualizer
to be used for page virtualization. This parameter is optional.
static final java.lang.String REPORT_CLASS_LOADER
JasperReportsContext
.
static final java.lang.String REPORT_URL_HANDLER_FACTORY
JasperReportsContext
.
static final java.lang.String REPORT_FILE_RESOLVER
JasperReportsContext
.FileResolver
instance to be used during the report filling process to
handle locate files on disk using relative paths.
static final java.lang.String REPORT_FORMAT_FACTORY
FormatFactory
instance to be used
during the report filling process to create instances of java.text.DateFormat to format date text
fields and instances of java.text.NumberFormat to format numeric text fields.
static final java.lang.String IS_IGNORE_PAGINATION
If set to true
the report will be generated on one long page.
static final java.lang.String REPORT_TEMPLATES
collection
of templates
passed to the
report at fill time.
These templates add to the ones specified in the report (see JRReport.getTemplates()
).
In the final templates list they are placed after the report templates; therefore styles from
these templates can use and override styles in the report templates.
They are, however, placed before the report styles hence report styles can use and override
styles from these templates.
static final java.lang.String SORT_FIELDS
static final java.lang.String REPORT_CONTEXT
static final java.lang.String FILTER
DatasetFilter
to be used in addition to JRDataset.getFilterExpression()
for filtering dataset rows.
Method Detail |
---|
java.lang.String getName()
java.lang.String getDescription()
void setDescription(java.lang.String description)
java.lang.Class<?> getValueClass()
java.lang.String getValueClassName()
boolean isSystemDefined()
boolean isForPrompting()
JRExpression getDefaultValueExpression()
java.lang.Class<?> getNestedType()
The parameter nested value type is used when the parameter value class
is not sufficient in determining the expected type of the parameter values.
The most common such scenario is when the parameter value class is
Collection
or a derived class, in which case the nested
type specifies the type of values which are to be placed inside the collection.
null
if none setgetValueClass()
java.lang.String getNestedTypeName()
null
if none setgetNestedType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |