Package lumis.service.analytics.eventanalytics.bean

Enum Metric.MetricType

java.lang.Object

java.lang.Enum<Metric.MetricType>

lumis.service.analytics.eventanalytics.bean.Metric.MetricType

All Implemented Interfaces:

Serializable, Comparable<Metric.MetricType>, IGroupingType

Enclosing class:

Metric

public static enum Metric.MetricType
extends Enum<Metric.MetricType>
implements IGroupingType

The metric type.

Since:

14.0.0

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVG
CARDINALITY
COUNT
MAX
MIN
SUM

Method Summary

Modifier and Type	Method	Description
String	getFormattedDescription(IMonitorField field)	Returns a formatted description for the metric and the given field.
String	getKey()	Returns the (JSON) key.
boolean	isTargetFieldRequired()	Returns whether a target field is required.
static Metric.MetricType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Metric.MetricType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COUNT

public static final Metric.MetricType COUNT

AVG

public static final Metric.MetricType AVG

SUM

public static final Metric.MetricType SUM

MAX

public static final Metric.MetricType MAX

MIN

public static final Metric.MetricType MIN

CARDINALITY

public static final Metric.MetricType CARDINALITY

Method Detail

values

public static Metric.MetricType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Metric.MetricType c : Metric.MetricType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Metric.MetricType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Description copied from interface: IGroupingType

Returns the (JSON) key.

Specified by:

getKey in interface IGroupingType

Returns:

the (JSON) key.

isTargetFieldRequired

public boolean isTargetFieldRequired()

Description copied from interface: IGroupingType

Returns whether a target field is required.

Specified by:

isTargetFieldRequired in interface IGroupingType

Returns:

whether a target field is required.

getFormattedDescription

public String getFormattedDescription(IMonitorField field)
                               throws PortalException

Returns a formatted description for the metric and the given field.

Parameters:

field - the field.

Returns:

a formatted description for the metric and the given field.

Throws:

PortalException

Since:

14.0.0