Interface IAggregateFunction


public interface IAggregateFunction
This interface defines the extension interface for all chart aggregate functions.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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
     
    static final int
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    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.
    Returns display text of aggregate parameters.
    int
    Returns the count of aggregate parameter.
    int
    Returns aggregate type.
    void
    Sends out a notification to a function implementation subclass to initialize local member variables.
  • Field Details

  • Method Details

    • accumulate

      void accumulate(Object oValue) throws 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:
      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