Interface IAggregateFunction


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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      int getBIRTDataType()
      Returns the aggregation data type defined by BIRT.
      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.
    • Method Detail

      • accumulate

        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

        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

        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

        java.lang.String[] getDisplayParameters()
        Returns display text of aggregate parameters.
        Since:
        BIRT 2.3
      • getBIRTDataType

        int getBIRTDataType()
        Returns the aggregation data type defined by BIRT.
        Returns:
        The aggregation data type defined by BIRT.
        Since:
        BIRT 2.5.2