|
||||||||||
| 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
|
static java.lang.String |
PROPERTY_WHEN_RESOURCE_MISSING_TYPE
|
protected JRQuery |
query
|
protected java.lang.String |
resourceBundle
|
protected java.lang.String |
scriptletClass
|
protected JRScriptlet[] |
scriptlets
|
protected JRSortField[] |
sortFields
|
protected JRVariable[] |
variables
|
protected WhenResourceMissingTypeEnum |
whenResourceMissingTypeValue
|
| 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 | |
|---|---|
java.lang.Object |
clone()
|
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance. |
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. |
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults for this object. |
JRPropertiesMap |
getPropertiesMap()
Returns this object'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. |
JRScriptlet[] |
getScriptlets()
Returns the dataset's scriptlets. |
JRSortField[] |
getSortFields()
Returns the dataset's sort fields. |
JRVariable[] |
getVariables()
Returns the dataset's variables. |
byte |
getWhenResourceMissingType()
Deprecated. Replaced by getWhenResourceMissingTypeValue(). |
WhenResourceMissingTypeEnum |
getWhenResourceMissingTypeValue()
Returns the resource missing handling type. |
boolean |
hasProperties()
Checks whether the object has any properties. |
boolean |
isMainDataset()
Decides whether this dataset is the main report dataset or a sub dataset. |
void |
setWhenResourceMissingType(byte whenResourceMissingType)
Deprecated. Replaced by setWhenResourceMissingType(WhenResourceMissingTypeEnum). |
void |
setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingTypeValue)
Sets the resource missing handling type. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_WHEN_RESOURCE_MISSING_TYPE
protected final boolean isMain
protected java.lang.String name
protected java.lang.String scriptletClass
protected JRScriptlet[] scriptlets
protected JRParameter[] parameters
protected JRQuery query
protected JRField[] fields
protected JRSortField[] sortFields
protected JRVariable[] variables
protected JRGroup[] groups
protected java.lang.String resourceBundle
protected WhenResourceMissingTypeEnum whenResourceMissingTypeValue
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 JRDatasetpublic java.lang.String getScriptletClass()
JRDataset
getScriptletClass in interface JRDatasetpublic JRQuery getQuery()
JRDatasetThe query is used by passing a connection is passed to the dataset when instantiating.
getQuery in interface JRDatasetpublic JRScriptlet[] getScriptlets()
JRDataset
getScriptlets in interface JRDatasetpublic JRParameter[] getParameters()
JRDataset
getParameters in interface JRDatasetpublic JRField[] getFields()
JRDataset
getFields in interface JRDatasetpublic JRSortField[] getSortFields()
JRDataset
getSortFields in interface JRDatasetpublic JRVariable[] getVariables()
JRDataset
getVariables in interface JRDatasetpublic JRGroup[] getGroups()
JRDataset
getGroups in interface JRDatasetpublic boolean isMainDataset()
JRDataset
isMainDataset in interface JRDatasettrue if and only if this dataset is the main report datasetpublic java.lang.String getResourceBundle()
JRDatasetThe resource bundle is used when evaluating expressions.
getResourceBundle in interface JRDatasetpublic byte getWhenResourceMissingType()
getWhenResourceMissingTypeValue().
getWhenResourceMissingType in interface JRDatasetpublic WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue()
JRDataset
getWhenResourceMissingTypeValue in interface JRDatasetpublic void setWhenResourceMissingType(byte whenResourceMissingType)
setWhenResourceMissingType(WhenResourceMissingTypeEnum).
setWhenResourceMissingType in interface JRDatasetpublic void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingTypeValue)
JRDataset
setWhenResourceMissingType in interface JRDatasetwhenResourceMissingTypeValue - the resource missing handling typepublic boolean hasProperties()
JRPropertiesHolder
hasProperties in interface JRPropertiesHolderpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap in interface JRPropertiesHolderpublic JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties in interface JRPropertiesHoldernull if no parentpublic 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 JRDatasetpublic java.lang.Object clone()
clone in interface JRCloneableclone in class java.lang.Objectpublic JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport in interface JRChangeEventsSupport
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||