AggregationHelper (Maximo API)

java.lang.Object
- psdi.app.report.AggregationHelper

All Implemented Interfaces:: ReportConstants

public class AggregationHelper
extends java.lang.Object
implements ReportConstants

Nested Class Summary
- Nested classes/interfaces inherited from interface psdi.app.report.ReportConstants
  ReportConstants.EmailFileTypes, ReportConstants.EmailType, ReportConstants.ReportTypes, ReportConstants.ScheduleType

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AGGREGATION_FUNCTION_AVERAGE`
`static java.lang.String`	`AGGREGATION_FUNCTION_AVERAGE_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_COUNT`
`static java.lang.String`	`AGGREGATION_FUNCTION_COUNT_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_MAX`
`static java.lang.String`	`AGGREGATION_FUNCTION_MAX_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_MEDIAN`
`static java.lang.String`	`AGGREGATION_FUNCTION_MEDIAN_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_MIN`
`static java.lang.String`	`AGGREGATION_FUNCTION_MIN_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_MODE`
`static java.lang.String`	`AGGREGATION_FUNCTION_MODE_BIRT`
`static java.lang.String`	`AGGREGATION_FUNCTION_SUM`
`static java.lang.String`	`AGGREGATION_FUNCTION_SUM_BIRT`

Fields inherited from interface psdi.app.report.ReportConstants
APPHIERARCHY, ATTR_BOUNDARY_CHARS_PATTERN, ATTRIBUTE_BOUNDARY_CHARS, ATTRIBUTENAME, BIRTCTRLTYPE_TEXTBOX, BIRTDATATYPE_DATETIME, BIRTDATATYPE_STRING, DATA_TYPE_DATE_BIRT, DATA_TYPE_DATETIME_BIRT, DATA_TYPE_DECIMAL_BIRT, DATA_TYPE_FLOAT_BIRT, DATA_TYPE_INTEGER_BIRT, DATA_TYPE_STRING_BIRT, DATA_TYPE_TIME_BIRT, DEFAULTVALUE, DISPLAYWHERE, DPKEY_PREFIX, DQ_PROPNAME, EXPORT_ACTION, EXPORT_ACTION_ALL_REPORTS, EXPORT_ACTION_LIBRARY, EXPORT_ACTION_REPORT, EXPORT_APPNAME, EXPORT_FILENAME, FILTER, GROUP, HIDDEN, IMPORT_CRONTASK, IMPORT_INSTANCE, IMPORT_PARAM_ADMINONLY, INVALID_CHARS, INVALID_CHARS_PATTERN, JDBC_DATE, JDBC_DATETIME, JOIN_RELATION, LABELOVERRIDE, LINK_RELATION, LOOKUP_DATELOOKUP, LOOKUP_YORNLOOKUPLIST, LOOKUPNAME, MULTILOOKUP, OVERLOADED, PARAMDELIMITER, PARAMETERNAME, RELATION_NOT_USED, REPORT_APP_LOGGER, REPORT_CONTEXT_USER_STOPLIMIT, REPORTS_DISABLED, REQUIRED, RPT_STATUS_CANCELLED, RPT_STATUS_FAILED, RPT_STATUS_OK, RPT_STATUS_RECLIMIT, SEQUENCE, SORT, SUPPORTED_EXP_TYPES, THREAD_AVAILABLE, ZERO_CONCURRENT_RUN

Constructor Summary

Constructors
Constructor and Description

AggregationHelper()

Constructors
Constructor and Description
`AggregationHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getBirtAggregationFunction(java.lang.String function)` Returns the BIRT summary function name for the passed Maximo function name.
`static java.lang.String`	`getReturnType(java.lang.String functionName, MboValueInfo mvi)` Returns the BIRT data type for the aggregation, or null if the aggregation is not supported for the data type of the attribute.
`static boolean`	`isValidDataType(java.lang.String functionName, MboValueInfo mvi)` Evaluates whether the specified aggregation can be performed on the specified attribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AGGREGATION_FUNCTION_SUM_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_SUM_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_COUNT_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_COUNT_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_AVERAGE_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_AVERAGE_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MIN_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_MIN_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MAX_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_MAX_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MODE_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_MODE_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MEDIAN_BIRT
```
public static final java.lang.String AGGREGATION_FUNCTION_MEDIAN_BIRT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_SUM
```
public static final java.lang.String AGGREGATION_FUNCTION_SUM
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_COUNT
```
public static final java.lang.String AGGREGATION_FUNCTION_COUNT
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_AVERAGE
```
public static final java.lang.String AGGREGATION_FUNCTION_AVERAGE
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MIN
```
public static final java.lang.String AGGREGATION_FUNCTION_MIN
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MAX
```
public static final java.lang.String AGGREGATION_FUNCTION_MAX
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MODE
```
public static final java.lang.String AGGREGATION_FUNCTION_MODE
```
    See Also:
    
    Constant Field Values
  - AGGREGATION_FUNCTION_MEDIAN
```
public static final java.lang.String AGGREGATION_FUNCTION_MEDIAN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AggregationHelper
```
public AggregationHelper()
```
- Method Detail
  - isValidDataType
```
public static boolean isValidDataType(java.lang.String functionName,
                                      MboValueInfo mvi)
```
    Evaluates whether the specified aggregation can be performed on the specified attribute.
    
    Parameters:
    
    String - functionName the name of the function as represented in the event
    
    MboValueInfo - mvi the MboValueInfo for the attribute being aggregated
    
    Returns:
    
    true if the function is supported for the attribute, false if not.
  - getReturnType
```
public static java.lang.String getReturnType(java.lang.String functionName,
                                             MboValueInfo mvi)
```
    Returns the BIRT data type for the aggregation, or null if the aggregation is not supported for the data type of the attribute.
    
    Parameters:
    
    String - functionName the name of the function as represented in the event
    
    MboValueInfo - mvi the MboValueInfo for the attribute being aggregated
    
    Returns:
    
    the BIRT return type for the aggregation, or null if the aggregation is not supported.
  - getBirtAggregationFunction
```
public static java.lang.String getBirtAggregationFunction(java.lang.String function)
```
    Returns the BIRT summary function name for the passed Maximo function name.
    
    Parameters:
    
    String - function the name of the function as represented in the event
    
    Returns:
    
    the BIRT name for the return type of the aggregation

Nested classes/interfaces inherited from interface psdi.app.report.ReportConstants

Fields inherited from interface psdi.app.report.ReportConstants

Methods inherited from class java.lang.Object

AGGREGATION_FUNCTION_SUM_BIRT

AGGREGATION_FUNCTION_COUNT_BIRT

AGGREGATION_FUNCTION_AVERAGE_BIRT

AGGREGATION_FUNCTION_MIN_BIRT

AGGREGATION_FUNCTION_MAX_BIRT

AGGREGATION_FUNCTION_MODE_BIRT

AGGREGATION_FUNCTION_MEDIAN_BIRT

AGGREGATION_FUNCTION_SUM

AGGREGATION_FUNCTION_COUNT

AGGREGATION_FUNCTION_AVERAGE

AGGREGATION_FUNCTION_MIN

AGGREGATION_FUNCTION_MAX

AGGREGATION_FUNCTION_MODE

AGGREGATION_FUNCTION_MEDIAN

AggregationHelper

isValidDataType

getReturnType

getBirtAggregationFunction