|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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()
Field Summary | |
static byte |
WHEN_RESOURCE_MISSING_TYPE_EMPTY
Return empty string when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_ERROR
Throw an exception when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_KEY
Return the key when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_NULL
Return NULL when a resource is missing. |
Method Summary | |
JRField[] |
getFields()
Returns the dataset's fields. |
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. |
JRVariable[] |
getVariables()
Returns the dataset's variables. |
byte |
getWhenResourceMissingType()
Returns the resource missing handling type. |
boolean |
isMainDataset()
Decides whether this dataset is the main report dataset or a sub dataset. |
void |
setWhenResourceMissingType(byte whenResourceMissingType)
Sets the resource missing handling type. |
Field Detail |
public static final byte WHEN_RESOURCE_MISSING_TYPE_NULL
public static final byte WHEN_RESOURCE_MISSING_TYPE_EMPTY
public static final byte WHEN_RESOURCE_MISSING_TYPE_KEY
public static final byte WHEN_RESOURCE_MISSING_TYPE_ERROR
Method Detail |
public java.lang.String getName()
public java.lang.String getScriptletClass()
public JRParameter[] getParameters()
public JRQuery getQuery()
The query is used by passing a connection is passed to the dataset when instantiating.
public JRField[] getFields()
public JRVariable[] getVariables()
public JRGroup[] getGroups()
public boolean isMainDataset()
true
iff this dataset is the main report datasetpublic java.lang.String getResourceBundle()
The resource bundle is used when evaluating expressions.
public byte getWhenResourceMissingType()
public void setWhenResourceMissingType(byte whenResourceMissingType)
whenResourceMissingType
- the resource missing handling type
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |