org.eclipse.birt.chart.aggregate
Class AggregateFunctionAdapter

java.lang.Object
  extended by org.eclipse.birt.chart.aggregate.AggregateFunctionAdapter
All Implemented Interfaces:
IAggregateFunction

public abstract class AggregateFunctionAdapter
extends java.lang.Object
implements IAggregateFunction

The empty IAggregateFunction adapter.


Field Summary
 
Fields inherited from interface org.eclipse.birt.chart.aggregate.IAggregateFunction
BIGDECIMAL, CALENDAR, CUSTOM, DATE, NULL, NUMBER, RUNNING_AGGR, SUMMARY_AGGR, TEXT, UNKNOWN
 
Constructor Summary
AggregateFunctionAdapter()
           
 
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.
 java.lang.String[] getDisplayParameters()
          Returns display text of aggregate parameters.
 int getParametersCount()
          Returns the count of aggregate parameter.
 int getType()
          Returns aggregate type.
 void initialize()
          Sends out a notification to a function implementation subclass to initialize local member variables.
 void setLocale(com.ibm.icu.util.ULocale lcl)
          Sets a locale associated with this aggregate function instance
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AggregateFunctionAdapter

public AggregateFunctionAdapter()
Method Detail

accumulate

public void accumulate(java.lang.Object oValue)
                throws java.lang.IllegalArgumentException
Description copied from interface: IAggregateFunction
An internally generated notification indicating that a function implementer should accumulate another value (to be subsequently aggregated)

Specified by:
accumulate in interface IAggregateFunction
Parameters:
oValue - The numeric value to be accumulated
Throws:
java.lang.IllegalArgumentException

getAggregatedValue

public java.lang.Object getAggregatedValue()
Description copied from interface: IAggregateFunction
Returns the aggregated value as determined by the function implementation.

Specified by:
getAggregatedValue in interface IAggregateFunction
Returns:
The aggregated value as determined by the function implementation.

initialize

public void initialize()
Description copied from interface: IAggregateFunction
Sends out a notification to a function implementation subclass to initialize local member variables.

Specified by:
initialize in interface IAggregateFunction

setLocale

public final void setLocale(com.ibm.icu.util.ULocale lcl)
Sets a locale associated with this aggregate function instance

Parameters:
lcl - A locale associated with this aggregate function instance

getDisplayParameters

public java.lang.String[] getDisplayParameters()
Description copied from interface: IAggregateFunction
Returns display text of aggregate parameters.

Specified by:
getDisplayParameters in interface IAggregateFunction

getParametersCount

public int getParametersCount()
Description copied from interface: IAggregateFunction
Returns the count of aggregate parameter.

Specified by:
getParametersCount in interface IAggregateFunction

getType

public int getType()
Description copied from interface: IAggregateFunction
Returns aggregate type.

Specified by:
getType in interface IAggregateFunction
See Also:
IAggregateFunction.SUMMARY_AGGR, IAggregateFunction.RUNNING_AGGR


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