Package org.eclipse.birt.chart.aggregate
Interface IAggregateFunction
public interface IAggregateFunction
This interface defines the extension interface for all chart aggregate
functions.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accumulate
(Object oValue) An internally generated notification indicating that a function implementer should accumulate another value (to be subsequently aggregated)Returns the aggregated value as determined by the function implementation.int
Returns the aggregation data type defined by BIRT.String[]
Returns display text of aggregate parameters.int
Returns the count of aggregate parameter.int
getType()
Returns aggregate type.void
Sends out a notification to a function implementation subclass to initialize local member variables.
-
Field Details
-
SUMMARY_AGGR
static final int SUMMARY_AGGR- See Also:
-
RUNNING_AGGR
static final int RUNNING_AGGR- See Also:
-
UNKNOWN
static final int UNKNOWN- See Also:
-
NULL
static final int NULL- See Also:
-
DATE
static final int DATE- See Also:
-
CALENDAR
static final int CALENDAR- See Also:
-
NUMBER
static final int NUMBER- See Also:
-
BIGDECIMAL
static final int BIGDECIMAL- See Also:
-
TEXT
static final int TEXT- See Also:
-
CUSTOM
static final int CUSTOM- See Also:
-
-
Method Details
-
accumulate
An internally generated notification indicating that a function implementer should accumulate another value (to be subsequently aggregated)- Parameters:
oValue
- The numeric value to be accumulated- Throws:
IllegalArgumentException
-
getAggregatedValue
Object getAggregatedValue()Returns the aggregated value as determined by the function implementation.- Returns:
- The aggregated value as determined by the function implementation.
-
initialize
void initialize()Sends out a notification to a function implementation subclass to initialize local member variables. -
getParametersCount
int getParametersCount()Returns the count of aggregate parameter.- Since:
- BIRT 2.3
-
getDisplayParameters
String[] getDisplayParameters()Returns display text of aggregate parameters.- Since:
- BIRT 2.3
-
getType
int getType()Returns aggregate type.- Since:
- BIRT 2.3
- See Also:
-
getBIRTDataType
int getBIRTDataType()Returns the aggregation data type defined by BIRT.- Returns:
- The aggregation data type defined by BIRT.
- Since:
- BIRT 2.5.2
-