|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRDataset
Interface representing a data set that can be used in a report.
A data set consists of parameters, fields, variables, groups and an optional query. When a data set gets instantiated, parameter values and a data source is passed to it.
A report has one main data set and multiple sub data sets that can be instantiated by charts and crosstabs.
JRDatasetRun
,
JRReport.getMainDataset()
,
JRReport.getDatasets()
Method Summary | |
---|---|
JRField[] |
getFields()
Returns the dataset's fields. |
JRExpression |
getFilterExpression()
Returns the dataset filter expression. |
JRGroup[] |
getGroups()
Returns the dataset's groups. |
java.lang.String |
getName()
Returns the dataset name. |
JRParameter[] |
getParameters()
Returns the dataset's parameters. |
JRQuery |
getQuery()
Returns the query of the dataset. |
java.lang.String |
getResourceBundle()
Returns the resource bundle base name. |
java.lang.String |
getScriptletClass()
The name of the scriptlet class to be used when iterating this dataset. |
JRScriptlet[] |
getScriptlets()
Returns the dataset's scriptlets. |
JRSortField[] |
getSortFields()
Returns the dataset's sort fields. |
JRVariable[] |
getVariables()
Returns the dataset's variables. |
WhenResourceMissingTypeEnum |
getWhenResourceMissingTypeValue()
Returns the resource missing handling type. |
boolean |
isMainDataset()
Decides whether this dataset is the main report dataset or a sub dataset. |
void |
setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
Sets the resource missing handling type. |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable |
---|
getUUID |
Method Detail |
---|
java.lang.String getName()
java.lang.String getScriptletClass()
JRScriptlet[] getScriptlets()
JRParameter[] getParameters()
JRQuery getQuery()
The query is used by passing a connection is passed to the dataset when instantiating.
JRField[] getFields()
JRSortField[] getSortFields()
JRVariable[] getVariables()
JRGroup[] getGroups()
boolean isMainDataset()
true
if and only if this dataset is the main report datasetjava.lang.String getResourceBundle()
The resource bundle is used when evaluating expressions.
WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue()
void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
whenResourceMissingType
- the resource missing handling typeJRExpression getFilterExpression()
This expression is used to filter the rows of the
data source
that this dataset will iterate on.
This expression (if not null) is evaluated immediately after a new row is
produced
by the data source.
The evaluation is performed using field and variable values corresponding to the new row.
When the result of the evaluation is Boolean.TRUE
the row gets processed by the report
filling engine.
When the result is null or Boolean.FALSE
, the current row will be skipped and the datasource will be asked for the next row.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |