|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRVariable
An interface for implementing classes that deal with report variables. This interface defines constants for names of built-in variables and for reset, increment and calculation types.
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).
Field Summary | |
---|---|
static java.lang.String |
COLUMN_COUNT
This variable contains the number of records that were processed when generating the current column. |
static java.lang.String |
COLUMN_NUMBER
Built-in variable containing the current column number. |
static java.lang.String |
PAGE_COUNT
Built-in variable containing the number of records that were processed when generating the current page. |
static java.lang.String |
PAGE_NUMBER
Built-in variable containing the current page number. |
static java.lang.String |
REPORT_COUNT
Built-in variable that contains the total number of records read from the datasource. |
Method Summary | |
---|---|
CalculationEnum |
getCalculationValue()
Gets the variable calculation type. |
JRExpression |
getExpression()
Returns the main expression for this variable. |
java.lang.Class<?> |
getIncrementerFactoryClass()
Returns the class of the incrementer factory used for choosing the right incrementer for the variable value. |
java.lang.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. |
java.lang.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. |
java.lang.Class<?> |
getValueClass()
Returns the class of the variable value. |
java.lang.String |
getValueClassName()
Returns the string name of the variable value class. |
boolean |
isSystemDefined()
Returns true if the variable calculation type is system defined. |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Field Detail |
---|
static final java.lang.String REPORT_COUNT
static final java.lang.String PAGE_COUNT
static final java.lang.String COLUMN_COUNT
static final java.lang.String PAGE_NUMBER
static final java.lang.String COLUMN_NUMBER
Method Detail |
---|
java.lang.String getName()
java.lang.Class<?> getValueClass()
java.lang.String getValueClassName()
java.lang.Class<?> getIncrementerFactoryClass()
JRIncrementer
,
JRIncrementerFactory
java.lang.String getIncrementerFactoryClassName()
ResetTypeEnum getResetTypeValue()
ResetTypeEnum
IncrementTypeEnum getIncrementTypeValue()
IncrementTypeEnum
CalculationEnum getCalculationValue()
CalculationEnum
boolean isSystemDefined()
true
if the variable calculation type is system defined.
CalculationEnum.SYSTEM
JRExpression 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
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |