Class AggregationDefn
java.lang.Object
org.eclipse.birt.report.model.api.oda.AggregationDefn
- All Implemented Interfaces:
IAggregationDefn
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringBIRT aggregation display name.protected StringBIRT aggregation function id.protected booleanIndicate if this aggregation can ignore duplicated values.protected booleanIndicate if this aggregation can ignore null values.protected intThe max number of input variable for this aggregation function.protected intThe minimum number of input variable for this aggregation function.protected booleanIndicate if this aggregation support unlimited number of input variables.protected static final intThe initial value for max/min arguments. -
Constructor Summary
ConstructorsConstructorDescriptionAggregationDefn(String birtAggregationId) Construct aggregation definition based on BIRT predefined aggregation id. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIdentify if this aggregation implementation can ignore duplicated values.booleanIdentify if this aggregation implementation can ignore null values.Return the display name of the BIRT predefined aggregation.Returns the BIRT predefined aggregation id.Return the max number of arguments that this aggregation function accept.Returns the minimum number of arguments required by this aggregation function.Returns the oda provider defined aggregation display name.Returns the oda provider defined aggregation id.Returns the oda aggregation provider id.protected voidinitBirtAggregation(int aggregationId, String id) booleanIdentify if this aggregation function support unlimited arguments.
-
Field Details
-
UNDEFINED
protected static final int UNDEFINEDThe initial value for max/min arguments.- See Also:
-
birtAggregationId
BIRT aggregation function id. -
birtAggregationDisplayName
BIRT aggregation display name. -
minInputVar
protected int minInputVarThe minimum number of input variable for this aggregation function. -
maxInputVar
protected int maxInputVarThe max number of input variable for this aggregation function. -
supportsUnboundedMaxInputVar
protected boolean supportsUnboundedMaxInputVarIndicate if this aggregation support unlimited number of input variables. -
canIgnoreDuplicateValues
protected boolean canIgnoreDuplicateValuesIndicate if this aggregation can ignore duplicated values. -
canIgnoreNullValues
protected boolean canIgnoreNullValuesIndicate if this aggregation can ignore null values.
-
-
Constructor Details
-
AggregationDefn
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:IAggregationDefnIdentify if this aggregation implementation can ignore duplicated values.- Specified by:
canIgnoreDuplicateValuesin interfaceIAggregationDefn- Returns:
- true if this aggregation can ignore duplicated values, else false.
-
canIgnoreNullValues
public boolean canIgnoreNullValues()Description copied from interface:IAggregationDefnIdentify if this aggregation implementation can ignore null values.- Specified by:
canIgnoreNullValuesin interfaceIAggregationDefn- Returns:
- true if this aggregation can ignore null values, else false.
-
getBirtAggregationDisplayName
Description copied from interface:IAggregationDefnReturn the display name of the BIRT predefined aggregation.- Specified by:
getBirtAggregationDisplayNamein interfaceIAggregationDefn- Returns:
- display name of the BIRT predefined aggregation.
-
getBirtAggregationId
Description copied from interface:IAggregationDefnReturns the BIRT predefined aggregation id.- Specified by:
getBirtAggregationIdin interfaceIAggregationDefn- Returns:
- the BIRT predefined aggregation id.
-
getMaxInputVariables
Description copied from interface:IAggregationDefnReturn the max number of arguments that this aggregation function accept.- Specified by:
getMaxInputVariablesin interfaceIAggregationDefn- Returns:
-
getMinInputVariables
Description copied from interface:IAggregationDefnReturns the minimum number of arguments required by this aggregation function.- Specified by:
getMinInputVariablesin interfaceIAggregationDefn- Returns:
- minimum number of arguments required by this aggregation.
-
getODAAggregationDisplayName
Description copied from interface:IAggregationDefnReturns the oda provider defined aggregation display name.- Specified by:
getODAAggregationDisplayNamein interfaceIAggregationDefn- Returns:
- oda aggregation display name.
-
getODAAggregationId
Description copied from interface:IAggregationDefnReturns the oda provider defined aggregation id.- Specified by:
getODAAggregationIdin interfaceIAggregationDefn- Returns:
- oda aggregation id.
-
getProviderExtensionId
Description copied from interface:IAggregationDefnReturns the oda aggregation provider id.- Specified by:
getProviderExtensionIdin interfaceIAggregationDefn- Returns:
- oda aggregation provider id.
-
supportsUnboundedMaxInputVariables
public boolean supportsUnboundedMaxInputVariables()Description copied from interface:IAggregationDefnIdentify if this aggregation function support unlimited arguments.- Specified by:
supportsUnboundedMaxInputVariablesin interfaceIAggregationDefn- Returns:
- true if this aggregation support unlimited arguments,else false.
-
initBirtAggregation
-