org.eclipse.birt.chart.aggregate
Interface IAggregateFunction

All Known Implementing Classes:
AggregateFunctionAdapter

public interface IAggregateFunction

This interface defines the extension interface for all chart aggregate functions.


Field Summary
static int BIGDECIMAL
           
static int CALENDAR
           
static int CUSTOM
           
static int DATE
           
static int NULL
           
static int NUMBER
           
static int TEXT
           
static int UNKNOWN
           
 
Method Summary
 void accumulate(java.lang.Object oValue)
          An internally generated notification indicating that a function implementer should accumulate another value (to be subsequently aggregated)
 java.lang.Object getAggregatedValue()
          Returns the aggregated value as determined by the function implementation.
 void initialize()
          Sends out a notification to a function implementation subclass to initialize local member variables.
 

Field Detail

UNKNOWN

public static final int UNKNOWN
See Also:
Constant Field Values

NULL

public static final int NULL
See Also:
Constant Field Values

DATE

public static final int DATE
See Also:
Constant Field Values

CALENDAR

public static final int CALENDAR
See Also:
Constant Field Values

NUMBER

public static final int NUMBER
See Also:
Constant Field Values

BIGDECIMAL

public static final int BIGDECIMAL
See Also:
Constant Field Values

TEXT

public static final int TEXT
See Also:
Constant Field Values

CUSTOM

public static final int CUSTOM
See Also:
Constant Field Values
Method Detail

accumulate

public void accumulate(java.lang.Object oValue)
                throws java.lang.IllegalArgumentException
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:
java.lang.IllegalArgumentException

getAggregatedValue

public java.lang.Object getAggregatedValue()
Returns the aggregated value as determined by the function implementation.

Returns:
The aggregated value as determined by the function implementation.

initialize

public void initialize()
Sends out a notification to a function implementation subclass to initialize local member variables.



Copyright © 2005-2007 Actuate Corp. All rights reserved.