|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseDataset
public class JRBaseDataset
The base implementation of JRDataset
.
Field Summary | |
---|---|
protected JRField[] |
fields
|
protected JRExpression |
filterExpression
|
protected JRGroup[] |
groups
|
protected boolean |
isMain
|
protected java.lang.String |
name
|
protected JRParameter[] |
parameters
|
protected JRPropertiesMap |
propertiesMap
|
protected JRQuery |
query
|
protected java.lang.String |
resourceBundle
|
protected java.lang.String |
scriptletClass
|
protected JRSortField[] |
sortFields
|
protected JRVariable[] |
variables
|
protected byte |
whenResourceMissingType
|
Fields inherited from interface net.sf.jasperreports.engine.JRDataset |
---|
WHEN_RESOURCE_MISSING_TYPE_EMPTY, WHEN_RESOURCE_MISSING_TYPE_ERROR, WHEN_RESOURCE_MISSING_TYPE_KEY, WHEN_RESOURCE_MISSING_TYPE_NULL |
Constructor Summary | |
---|---|
protected |
JRBaseDataset(boolean isMain)
|
protected |
JRBaseDataset(JRDataset dataset,
JRBaseObjectFactory factory)
|
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. |
JRPropertiesMap |
getPropertiesMap()
Returns this dataset's properties map. |
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. |
JRSortField[] |
getSortFields()
Returns the dataset's sort fields. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final boolean isMain
protected java.lang.String name
protected java.lang.String scriptletClass
protected JRParameter[] parameters
protected JRQuery query
protected JRField[] fields
protected JRSortField[] sortFields
protected JRVariable[] variables
protected JRGroup[] groups
protected java.lang.String resourceBundle
protected byte whenResourceMissingType
protected JRPropertiesMap propertiesMap
protected JRExpression filterExpression
Constructor Detail |
---|
protected JRBaseDataset(boolean isMain)
protected JRBaseDataset(JRDataset dataset, JRBaseObjectFactory factory)
Method Detail |
---|
public java.lang.String getName()
JRDataset
getName
in interface JRDataset
public java.lang.String getScriptletClass()
JRDataset
getScriptletClass
in interface JRDataset
public JRQuery getQuery()
JRDataset
The query is used by passing a connection is passed to the dataset when instantiating.
getQuery
in interface JRDataset
public JRParameter[] getParameters()
JRDataset
getParameters
in interface JRDataset
public JRField[] getFields()
JRDataset
getFields
in interface JRDataset
public JRSortField[] getSortFields()
JRDataset
getSortFields
in interface JRDataset
public JRVariable[] getVariables()
JRDataset
getVariables
in interface JRDataset
public JRGroup[] getGroups()
JRDataset
getGroups
in interface JRDataset
public boolean isMainDataset()
JRDataset
isMainDataset
in interface JRDataset
true
iff this dataset is the main report datasetpublic java.lang.String getResourceBundle()
JRDataset
The resource bundle is used when evaluating expressions.
getResourceBundle
in interface JRDataset
public byte getWhenResourceMissingType()
JRDataset
getWhenResourceMissingType
in interface JRDataset
public void setWhenResourceMissingType(byte whenResourceMissingType)
JRDataset
setWhenResourceMissingType
in interface JRDataset
whenResourceMissingType
- the resource missing handling typepublic JRPropertiesMap getPropertiesMap()
JRDataset
getPropertiesMap
in interface JRDataset
public JRExpression getFilterExpression()
JRDataset
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.
getFilterExpression
in interface JRDataset
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |