|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.fill.JRFillElementDataset
public abstract class JRFillElementDataset
Abstract JRElementDataset implementation used at report fill time.
A dataset implementation usually involves a set of expressions which are used to feed data to some internal data structures. The collected data is then transformed into report output. An implementation needs to implement abstract methods that initialize, evaluate and increment the dataset.
JRFillObjectFactory.registerElementDataset(JRFillElementDataset)| Field Summary | |
|---|---|
protected JRFillDatasetRun |
datasetRun
|
protected JRGroup |
incrementGroup
|
protected JRElementDataset |
parent
|
protected JRGroup |
resetGroup
|
| Constructor Summary | |
|---|---|
protected |
JRFillElementDataset(JRElementDataset dataset,
JRFillObjectFactory factory)
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
protected abstract void |
customEvaluate(JRCalculator calculator)
Evaluates the expressions associated with the dataset. |
protected abstract void |
customIncrement()
Increments the dataset by collecting the result of the expression evaluation. |
protected abstract void |
customInitialize()
Initializes the element dataset. |
protected void |
evaluate(JRCalculator calculator)
|
void |
evaluateDatasetRun(byte evaluation)
|
protected void |
evaluateIncrementWhenExpression(JRCalculator calculator)
|
JRDatasetRun |
getDatasetRun()
Returns the sub dataset run for this chart dataset. |
JRGroup |
getIncrementGroup()
Gets the selected increment group in case of increment type group. |
byte |
getIncrementType()
Deprecated. Replaced by getIncrementTypeValue() |
IncrementTypeEnum |
getIncrementTypeValue()
Returns the increment type. |
JRExpression |
getIncrementWhenExpression()
Returns the "increment when" expression. |
JRFillDataset |
getInputDataset()
|
JRGroup |
getResetGroup()
Gets the selected reset group in case of reset type group. |
byte |
getResetType()
Deprecated. Replaced by getResetTypeValue() |
ResetTypeEnum |
getResetTypeValue()
Gets the reset type. |
protected java.util.TimeZone |
getTimeZone()
|
protected void |
increment()
|
protected void |
initialize()
|
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.sf.jasperreports.engine.JRElementDataset |
|---|
collectExpressions |
| Field Detail |
|---|
protected JRElementDataset parent
protected JRGroup resetGroup
protected JRGroup incrementGroup
protected JRFillDatasetRun datasetRun
| Constructor Detail |
|---|
protected JRFillElementDataset(JRElementDataset dataset,
JRFillObjectFactory factory)
| Method Detail |
|---|
public byte getResetType()
getResetTypeValue()
getResetType in interface JRElementDatasetpublic byte getIncrementType()
getIncrementTypeValue()
getIncrementType in interface JRElementDatasetpublic ResetTypeEnum getResetTypeValue()
JRElementDataset
getResetTypeValue in interface JRElementDatasetResetTypeEnumpublic IncrementTypeEnum getIncrementTypeValue()
JRElementDataset
getIncrementTypeValue in interface JRElementDatasetIncrementTypeEnum.public JRGroup getResetGroup()
JRElementDataset
getResetGroup in interface JRElementDatasetpublic JRGroup getIncrementGroup()
JRElementDataset
getIncrementGroup in interface JRElementDatasetprotected java.util.TimeZone getTimeZone()
protected void initialize()
protected void evaluate(JRCalculator calculator)
throws JRExpressionEvalException
JRExpressionEvalException
protected void evaluateIncrementWhenExpression(JRCalculator calculator)
throws JRExpressionEvalException
JRExpressionEvalExceptionprotected void increment()
protected abstract void customInitialize()
The dataset is initialized before being used and after each time the dataset gets reset.
getResetType()
protected abstract void customEvaluate(JRCalculator calculator)
throws JRExpressionEvalException
Usually, the result of the evaluation would be preserved so that it is
used in customIncrement()
calculator - used to evaluate expressions
JRExpressionEvalException - any exception that occurs while
evaluating expressionsprotected abstract void customIncrement()
public JRDatasetRun getDatasetRun()
JRElementDataset
getDatasetRun in interface JRElementDataset
public void evaluateDatasetRun(byte evaluation)
throws JRException
JRExceptionpublic JRFillDataset getInputDataset()
public JRExpression getIncrementWhenExpression()
JRElementDatasetThis expression determines whether a dataset will be incremented or not.
The expression (if not null) is evaluated before each increment of the dataset.
The increment will be carried on only when the result of the evaluation is Boolean.TRUE;
if the result is null or false, the increment will not be performed.
getIncrementWhenExpression in interface JRElementDatasetpublic java.lang.Object clone()
clone in interface JRCloneableclone in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||