Class AggregationDefn

java.lang.Object
org.eclipse.birt.report.model.api.oda.AggregationDefn
All Implemented Interfaces:
IAggregationDefn

public class AggregationDefn extends Object implements IAggregationDefn
  • Field Details

    • UNDEFINED

      protected static final int UNDEFINED
      The initial value for max/min arguments.
      See Also:
    • birtAggregationId

      protected String birtAggregationId
      BIRT aggregation function id.
    • birtAggregationDisplayName

      protected String birtAggregationDisplayName
      BIRT aggregation display name.
    • minInputVar

      protected int minInputVar
      The minimum number of input variable for this aggregation function.
    • maxInputVar

      protected int maxInputVar
      The max number of input variable for this aggregation function.
    • supportsUnboundedMaxInputVar

      protected boolean supportsUnboundedMaxInputVar
      Indicate if this aggregation support unlimited number of input variables.
    • canIgnoreDuplicateValues

      protected boolean canIgnoreDuplicateValues
      Indicate if this aggregation can ignore duplicated values.
    • canIgnoreNullValues

      protected boolean canIgnoreNullValues
      Indicate if this aggregation can ignore null values.
  • Constructor Details

    • AggregationDefn

      public AggregationDefn(String birtAggregationId) throws IllegalArgumentException
      Construct aggregation definition based on BIRT predefined aggregation id.
      Parameters:
      birtAggregationId - birt predefined aggregation id.
      Throws:
      IllegalArgumentException - exception when the passed in birt aggregation id is not predefined.
  • Method Details

    • canIgnoreDuplicateValues

      public boolean canIgnoreDuplicateValues()
      Description copied from interface: IAggregationDefn
      Identify if this aggregation implementation can ignore duplicated values.
      Specified by:
      canIgnoreDuplicateValues in interface IAggregationDefn
      Returns:
      true if this aggregation can ignore duplicated values, else false.
    • canIgnoreNullValues

      public boolean canIgnoreNullValues()
      Description copied from interface: IAggregationDefn
      Identify if this aggregation implementation can ignore null values.
      Specified by:
      canIgnoreNullValues in interface IAggregationDefn
      Returns:
      true if this aggregation can ignore null values, else false.
    • getBirtAggregationDisplayName

      public String getBirtAggregationDisplayName()
      Description copied from interface: IAggregationDefn
      Return the display name of the BIRT predefined aggregation.
      Specified by:
      getBirtAggregationDisplayName in interface IAggregationDefn
      Returns:
      display name of the BIRT predefined aggregation.
    • getBirtAggregationId

      public String getBirtAggregationId()
      Description copied from interface: IAggregationDefn
      Returns the BIRT predefined aggregation id.
      Specified by:
      getBirtAggregationId in interface IAggregationDefn
      Returns:
      the BIRT predefined aggregation id.
    • getMaxInputVariables

      public Integer getMaxInputVariables()
      Description copied from interface: IAggregationDefn
      Return the max number of arguments that this aggregation function accept.
      Specified by:
      getMaxInputVariables in interface IAggregationDefn
      Returns:
    • getMinInputVariables

      public Integer getMinInputVariables()
      Description copied from interface: IAggregationDefn
      Returns the minimum number of arguments required by this aggregation function.
      Specified by:
      getMinInputVariables in interface IAggregationDefn
      Returns:
      minimum number of arguments required by this aggregation.
    • getODAAggregationDisplayName

      public String getODAAggregationDisplayName()
      Description copied from interface: IAggregationDefn
      Returns the oda provider defined aggregation display name.
      Specified by:
      getODAAggregationDisplayName in interface IAggregationDefn
      Returns:
      oda aggregation display name.
    • getODAAggregationId

      public String getODAAggregationId()
      Description copied from interface: IAggregationDefn
      Returns the oda provider defined aggregation id.
      Specified by:
      getODAAggregationId in interface IAggregationDefn
      Returns:
      oda aggregation id.
    • getProviderExtensionId

      public String getProviderExtensionId()
      Description copied from interface: IAggregationDefn
      Returns the oda aggregation provider id.
      Specified by:
      getProviderExtensionId in interface IAggregationDefn
      Returns:
      oda aggregation provider id.
    • supportsUnboundedMaxInputVariables

      public boolean supportsUnboundedMaxInputVariables()
      Description copied from interface: IAggregationDefn
      Identify if this aggregation function support unlimited arguments.
      Specified by:
      supportsUnboundedMaxInputVariables in interface IAggregationDefn
      Returns:
      true if this aggregation support unlimited arguments,else false.
    • initBirtAggregation

      protected void initBirtAggregation(int aggregationId, String id)