JRBaseVariable (JasperReports Library 6.10.0 API)

java.lang.Object
- net.sf.jasperreports.engine.base.JRBaseVariable

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRVariable, StoreCloneable<JRBaseVariable>

Direct Known Subclasses:

JRDesignVariable
```
public class JRBaseVariable
extends Object
implements JRVariable, Serializable, StoreCloneable<JRBaseVariable>, JRChangeEventsSupport
```
Author:

Teodor Danciu ([email protected])

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected CalculationEnum`	`calculationValue`
`protected String`	`description`
`protected JRExpression`	`expression`
`protected Class<?>`	`incrementerFactoryClass`
`protected String`	`incrementerFactoryClassName`
`protected String`	`incrementerFactoryClassRealName`
`protected JRGroup`	`incrementGroup`
`protected IncrementTypeEnum`	`incrementTypeValue`
`protected JRExpression`	`initialValueExpression`
`protected boolean`	`isSystemDefined`
`protected String`	`name`
`static String`	`PROPERTY_DESCRIPTION`
`protected JRGroup`	`resetGroup`
`protected ResetTypeEnum`	`resetTypeValue`
`protected Class<?>`	`valueClass`
`protected String`	`valueClassName`
`protected String`	`valueClassRealName`

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected JRBaseVariable()

protected JRBaseVariable(JRVariable variable, JRBaseObjectFactory factory)

Constructors
Modifier	Constructor and Description
`protected`	`JRBaseVariable()`
`protected`	`JRBaseVariable(JRVariable variable, JRBaseObjectFactory factory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`JRBaseVariable`	`clone(CloneStore cloneStore)`
`CalculationEnum`	`getCalculationValue()` Gets the variable calculation type.
`String`	`getDescription()` Gets the variable optional description.
`JRPropertyChangeSupport`	`getEventSupport()` Returns the property change support object for this instance.
`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.
`void`	`setDescription(String description)` Sets the variable description.

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

- Field Detail
  - PROPERTY_DESCRIPTION
```
public static final String PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
  - description
```
protected String description
```
  - valueClassName
```
protected String valueClassName
```
  - valueClassRealName
```
protected String valueClassRealName
```
  - incrementerFactoryClassName
```
protected String incrementerFactoryClassName
```
  - incrementerFactoryClassRealName
```
protected String incrementerFactoryClassRealName
```
  - resetTypeValue
```
protected ResetTypeEnum resetTypeValue
```
  - incrementTypeValue
```
protected IncrementTypeEnum incrementTypeValue
```
  - calculationValue
```
protected CalculationEnum calculationValue
```
  - isSystemDefined
```
protected boolean isSystemDefined
```
  - valueClass
```
protected transient Class<?> valueClass
```
  - incrementerFactoryClass
```
protected transient Class<?> incrementerFactoryClass
```
  - expression
```
protected JRExpression expression
```
  - initialValueExpression
```
protected JRExpression initialValueExpression
```
  - resetGroup
```
protected JRGroup resetGroup
```
  - incrementGroup
```
protected JRGroup incrementGroup
```
- Constructor Detail
  - JRBaseVariable
```
protected JRBaseVariable()
```
  - JRBaseVariable
```
protected JRBaseVariable(JRVariable variable,
                         JRBaseObjectFactory factory)
```
- Method Detail
  - 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
  - getDescription
```
public String getDescription()
```
    Description copied from interface: JRVariable
    
    Gets the variable optional description.
    
    Specified by:
    
    getDescription in interface JRVariable
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: JRVariable
    
    Sets the variable description.
    
    Specified by:
    
    setDescription in interface JRVariable
  - 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
  - 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
  - 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.
  - 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
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface JRCloneable
    
    Overrides:
    
    clone in class Object
  - clone
```
public JRBaseVariable clone(CloneStore cloneStore)
```
    Specified by:
    
    clone in interface StoreCloneable<JRBaseVariable>
  - getEventSupport
```
public JRPropertyChangeSupport getEventSupport()
```
    Description copied from interface: JRChangeEventsSupport
    
    Returns the property change support object for this instance.
    
    Specified by:
    
    getEventSupport in interface JRChangeEventsSupport
    
    Returns:
    
    the property change support object for this instance

Class JRBaseVariable

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_DESCRIPTION

name

description

valueClassName

valueClassRealName

incrementerFactoryClassName

incrementerFactoryClassRealName

resetTypeValue

incrementTypeValue

calculationValue

isSystemDefined

valueClass

incrementerFactoryClass

expression

initialValueExpression

resetGroup

incrementGroup

Constructor Detail

JRBaseVariable

JRBaseVariable

Method Detail

getName

getDescription

setDescription

getValueClass

getValueClassName

getIncrementerFactoryClass

getIncrementerFactoryClassName

getResetTypeValue

getIncrementTypeValue

getCalculationValue

isSystemDefined

getExpression

getInitialValueExpression

getResetGroup

getIncrementGroup

clone

clone

getEventSupport