public interface JRVariable extends JRCloneable
When declaring a report group, the engine will automatically create a count variable that will calculate the number of records that make up the current group (number of records processed between group ruptures). The name for this variable comes from the name of the group it corresponds to, suffixed with the "_COUNT" sequence. It can be used like any other report variable, in any report expression (even in the current group expression like you can see done in the "BreakGroup" of the jasper sample).
| Modifier and Type | Field and Description |
|---|---|
static String |
COLUMN_COUNT
This variable contains the number of records that were processed when generating the current column.
|
static String |
COLUMN_NUMBER
Built-in variable containing the current column number.
|
static String |
PAGE_COUNT
Built-in variable containing the number of records that were processed when generating the current page.
|
static String |
PAGE_NUMBER
Built-in variable containing the current page number.
|
static String |
REPORT_COUNT
Built-in variable that contains the total number of records read from the datasource.
|
| Modifier and Type | Method and Description |
|---|---|
CalculationEnum |
getCalculationValue()
Gets the variable calculation type.
|
JRExpression |
getExpression()
Returns the main expression for this variable.
|
Class<?> |
getIncrementerFactoryClass()
Returns the class of the incrementer factory used for choosing the right incrementer for the variable value.
|
String |
getIncrementerFactoryClassName()
Returns the string name of the variable value class.
|
JRGroup |
getIncrementGroup()
Returns the group whose break triggers the variable increment.
|
IncrementTypeEnum |
getIncrementTypeValue()
Gets the variable increment type.
|
JRExpression |
getInitialValueExpression()
Returns the initial value expression for this variable.
|
String |
getName()
Returns the name of the variable.
|
JRGroup |
getResetGroup()
Returns the group whose break triggers the variable reset.
|
ResetTypeEnum |
getResetTypeValue()
Gets the variable reset type.
|
Class<?> |
getValueClass()
Returns the class of the variable value.
|
String |
getValueClassName()
Returns the string name of the variable value class.
|
boolean |
isSystemDefined()
Returns
true if the variable calculation type is system defined. |
clonestatic final String REPORT_COUNT
static final String PAGE_COUNT
static final String COLUMN_COUNT
static final String PAGE_NUMBER
static final String COLUMN_NUMBER
String getName()
Class<?> getValueClass()
String getValueClassName()
Class<?> getIncrementerFactoryClass()
JRIncrementer,
JRIncrementerFactoryString getIncrementerFactoryClassName()
ResetTypeEnum getResetTypeValue()
ResetTypeEnumIncrementTypeEnum getIncrementTypeValue()
IncrementTypeEnumCalculationEnum getCalculationValue()
CalculationEnumboolean isSystemDefined()
true if the variable calculation type is system defined.CalculationEnum.SYSTEMJRExpression getExpression()
JRExpression instance containing the expression.JRExpression getInitialValueExpression()
JRExpression instance containing the initial expression.JRGroup getResetGroup()
getResetTypeValue() returns
ResetTypeEnum.GROUP.JRGroup getIncrementGroup()
getIncrementTypeValue() returns
ResetTypeEnum.GROUP.Copyright © 2012. All Rights Reserved.