JRFillVariable (JasperReports 6.1.1 API)

java.lang.Object
- net.sf.jasperreports.engine.fill.JRFillVariable

All Implemented Interfaces:

Cloneable, JRCalculable, JRCloneable, JRVariable
```
public class JRFillVariable
extends Object
implements JRVariable, JRCalculable
```
Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields
Modifier and Type Field and Description

protected JRVariable parent
- Fields inherited from interface net.sf.jasperreports.engine.JRVariable
  COLUMN_COUNT, COLUMN_NUMBER, MASTER_CURRENT_PAGE, MASTER_TOTAL_PAGES, PAGE_COUNT, PAGE_NUMBER, REPORT_COUNT
- Fields inherited from interface net.sf.jasperreports.engine.fill.JRCalculable
  HELPER_COUNT, HELPER_SIZE, HELPER_SUM, HELPER_VARIANCE

Fields
Modifier and Type	Field and Description
`protected JRVariable`	`parent`

Constructor Summary

Constructors
Modifier Constructor and Description

protected JRFillVariable(JRVariable variable, JRFillObjectFactory factory)

Constructors
Modifier	Constructor and Description
`protected`	`JRFillVariable(JRVariable variable, JRFillObjectFactory factory)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`CalculationEnum`	`getCalculationValue()` Gets the variable calculation type.
`Object`	`getEstimatedValue()`
`JRExpression`	`getExpression()` Returns the main expression for this variable.
`JRCalculable`	`getHelperVariable(byte type)` Returns a helper variable.
`Object`	`getIncrementedValue()` Returns the incremented value of the calculable object.
`JRIncrementer`	`getIncrementer()`
`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.
`Object`	`getOldValue()`
`Object`	`getPreviousOldValue()`
`JRGroup`	`getResetGroup()` Returns the group whose break triggers the variable reset.
`ResetTypeEnum`	`getResetTypeValue()` Gets the variable reset type.
`Object`	`getValue()` Returns the value of the calculable object.
`Object`	`getValue(byte evaluation)`
`Class<?>`	`getValueClass()` Returns the class of the variable value.
`String`	`getValueClassName()` Returns the string name of the variable value class.
`boolean`	`isInitialized()` Returns `true` if and only if the calculable object was only initialized and not incremented.
`boolean`	`isSystemDefined()` Returns `true` if the variable calculation type is system defined.
`void`	`overwriteValue(Object newValue, byte evaluation)`
`protected void`	`reset()`
`void`	`restoreValue(byte evaluation)`
`void`	`setEstimatedValue(Object estimatedValue)`
`JRFillVariable`	`setHelperVariable(JRFillVariable helperVariable, byte type)` Sets a helper variable.
`void`	`setIncrementedValue(Object incrementedValue)`
`void`	`setInitialized(boolean isInitialized)` Sets the initialized flag for this calculable object.
`void`	`setOldValue(Object oldValue)`
`void`	`setPreviousOldValue(Object previousOldValue)`
`void`	`setValue(Object value)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - parent
```
protected JRVariable parent
```
- Constructor Detail
  - JRFillVariable
```
protected JRFillVariable(JRVariable variable,
              JRFillObjectFactory factory)
```
- Method Detail
  - reset
```
protected void reset()
```
  - getName
```
public String getName()
```
    Description copied from interface: JRVariable
    
    Returns the name of the variable. Since all variables are stored in a map, the variable names are the keys in the map.
    
    Specified by:
    
    getName in interface JRVariable
    
    Returns:
    a string containing the variable name
  - getValueClass
```
public Class<?> getValueClass()
```
    Description copied from interface: JRVariable
    
    Returns the class of the variable value. Any class is allowed as long as it is in the classpath at compile and run time.
    
    Specified by:
    
    getValueClass in interface JRVariable
    
    Returns:
    a Class instance representing the variable value class
  - getValueClassName
```
public String getValueClassName()
```
    Description copied from interface: JRVariable
    
    Returns the string name of the variable value class.
    
    Specified by:
    
    getValueClassName in interface JRVariable
  - getIncrementerFactoryClass
```
public Class<?> getIncrementerFactoryClass()
```
    Description copied from interface: JRVariable
    
    Returns the class of the incrementer factory used for choosing the right incrementer for the variable value.
    
    Specified by:
    
    getIncrementerFactoryClass in interface JRVariable
    
    Returns:
    the Class instance of the incrementer factory
    See Also:
    JRIncrementer, JRIncrementerFactory
  - getIncrementerFactoryClassName
```
public String getIncrementerFactoryClassName()
```
    Description copied from interface: JRVariable
    
    Returns the string name of the variable value class.
    
    Specified by:
    
    getIncrementerFactoryClassName in interface JRVariable
  - getExpression
```
public JRExpression getExpression()
```
    Description copied from interface: JRVariable
    
    Returns the main expression for this variable. The expression must be numeric for certain calculation types.
    
    Specified by:
    
    getExpression in interface JRVariable
    
    Returns:
    a JRExpression instance containing the expression.
  - getInitialValueExpression
```
public JRExpression getInitialValueExpression()
```
    Description copied from interface: JRVariable
    
    Returns the initial value expression for this variable. The expression must be numeric for certain calculation types.
    
    Specified by:
    
    getInitialValueExpression in interface JRVariable
    
    Returns:
    a JRExpression instance containing the initial expression.
  - getResetTypeValue
```
public ResetTypeEnum getResetTypeValue()
```
    Description copied from interface: JRVariable
    
    Gets the variable reset type.
    
    Specified by:
    
    getResetTypeValue in interface JRVariable
    
    Returns:
    a value representing one of the reset type constants in ResetTypeEnum
  - getIncrementTypeValue
```
public IncrementTypeEnum getIncrementTypeValue()
```
    Description copied from interface: JRVariable
    
    Gets the variable increment type.
    
    Specified by:
    
    getIncrementTypeValue in interface JRVariable
    
    Returns:
    a value representing one of the reset type constants in IncrementTypeEnum
  - getCalculationValue
```
public CalculationEnum getCalculationValue()
```
    Description copied from interface: JRVariable
    
    Gets the variable calculation type.
    
    Specified by:
    
    getCalculationValue in interface JRVariable
    
    Returns:
    a value representing one of the calculation type constants in CalculationEnum
  - isSystemDefined
```
public boolean isSystemDefined()
```
    Description copied from interface: JRVariable
    
    Returns true if the variable calculation type is system defined.
    
    Specified by:
    
    isSystemDefined in interface JRVariable
    
    See Also:
    CalculationEnum.SYSTEM
  - getResetGroup
```
public JRGroup getResetGroup()
```
    Description copied from interface: JRVariable
    
    Returns the group whose break triggers the variable reset. Only used when JRVariable.getResetTypeValue() returns ResetTypeEnum.GROUP.
    
    Specified by:
    
    getResetGroup in interface JRVariable
  - getIncrementGroup
```
public JRGroup getIncrementGroup()
```
    Description copied from interface: JRVariable
    
    Returns the group whose break triggers the variable increment. Only used when JRVariable.getIncrementTypeValue() returns IncrementTypeEnum.GROUP.
    
    Specified by:
    
    getIncrementGroup in interface JRVariable
  - getOldValue
```
public Object getOldValue()
```
  - setOldValue
```
public void setOldValue(Object oldValue)
```
  - getEstimatedValue
```
public Object getEstimatedValue()
```
  - setEstimatedValue
```
public void setEstimatedValue(Object estimatedValue)
```
  - getIncrementedValue
```
public Object getIncrementedValue()
```
    Description copied from interface: JRCalculable
    
    Returns the incremented value of the calculable object.
    
    Specified by:
    
    getIncrementedValue in interface JRCalculable
    
    Returns:
    the incremented value
  - setIncrementedValue
```
public void setIncrementedValue(Object incrementedValue)
```
  - getValue
```
public Object getValue()
```
    Description copied from interface: JRCalculable
    
    Returns the value of the calculable object.
    
    Specified by:
    
    getValue in interface JRCalculable
    
    Returns:
    the value
  - setValue
```
public void setValue(Object value)
```
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: JRCalculable
    
    Returns true if and only if the calculable object was only initialized and not incremented.
    
    Specified by:
    
    isInitialized in interface JRCalculable
    
    Returns:
    true if and only if the calculable object was only initialized and not incremented
  - setInitialized
```
public void setInitialized(boolean isInitialized)
```
    Description copied from interface: JRCalculable
    
    Sets the initialized flag for this calculable object.
    
    Specified by:
    
    setInitialized in interface JRCalculable
    
    Parameters:
    isInitialized - the initialized flag
    See Also:
    JRCalculable.isInitialized()
  - getIncrementer
```
public JRIncrementer getIncrementer()
```
  - setHelperVariable
```
public JRFillVariable setHelperVariable(JRFillVariable helperVariable,
                               byte type)
```
    Sets a helper variable.
    
    Parameters:
    helperVariable - the helper variable
    type - the helper type
    
    Returns:
    the previous helper variable for the type
  - getHelperVariable
```
public JRCalculable getHelperVariable(byte type)
```
    Returns a helper variable.
    
    Specified by:
    
    getHelperVariable in interface JRCalculable
    
    Parameters:
    type - the helper type
    
    Returns:
    the helper variable for the specified type
  - getValue
```
public Object getValue(byte evaluation)
```
  - overwriteValue
```
public void overwriteValue(Object newValue,
                  byte evaluation)
```
  - restoreValue
```
public void restoreValue(byte evaluation)
```
  - getPreviousOldValue
```
public Object getPreviousOldValue()
```
  - setPreviousOldValue
```
public void setPreviousOldValue(Object previousOldValue)
```
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface JRCloneable
    
    Overrides:
    
    clone in class Object

Class JRFillVariable

Field Summary

Fields inherited from interface net.sf.jasperreports.engine.JRVariable

Fields inherited from interface net.sf.jasperreports.engine.fill.JRCalculable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parent

Constructor Detail

JRFillVariable

Method Detail

reset

getName

getValueClass

getValueClassName

getIncrementerFactoryClass

getIncrementerFactoryClassName

getExpression

getInitialValueExpression

getResetTypeValue

getIncrementTypeValue

getCalculationValue

isSystemDefined

getResetGroup

getIncrementGroup

getOldValue

setOldValue

getEstimatedValue

setEstimatedValue

getIncrementedValue

setIncrementedValue

getValue

setValue

isInitialized

setInitialized

getIncrementer

setHelperVariable

getHelperVariable

getValue

overwriteValue

restoreValue

getPreviousOldValue

setPreviousOldValue

clone