Package org.opennms.nephron

Enum CompoundKeyType

java.lang.Object

java.lang.Enum<CompoundKeyType>

org.opennms.nephron.CompoundKeyType

All Implemented Interfaces:

Serializable, Comparable<CompoundKeyType>

public enum CompoundKeyType
extends Enum<CompoundKeyType>

Describes compound keys. Contains a sequence of RefTypes that describes the dimension flow data is grouped into. A compound key type may be derived from a parent type by adding additional grouping dimensions. Parent types are used when calculating topK aggregations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPORTER
EXPORTER_INTERFACE
EXPORTER_INTERFACE_APPLICATION
EXPORTER_INTERFACE_CONVERSATION
EXPORTER_INTERFACE_HOST
EXPORTER_INTERFACE_TOS
EXPORTER_INTERFACE_TOS_APPLICATION
EXPORTER_INTERFACE_TOS_CONVERSATION
EXPORTER_INTERFACE_TOS_HOST

Method Summary

Modifier and Type	Method	Description
CompoundKey	create(org.opennms.netmgt.flows.persistence.model.FlowDocument flow)
CompoundKeyType	getParent()
RefType[]	getParts()
boolean	isTotalNotTopK()
static CompoundKeyType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CompoundKeyType[]	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

EXPORTER

public static final CompoundKeyType EXPORTER

EXPORTER_INTERFACE

public static final CompoundKeyType EXPORTER_INTERFACE

EXPORTER_INTERFACE_APPLICATION

public static final CompoundKeyType EXPORTER_INTERFACE_APPLICATION

EXPORTER_INTERFACE_CONVERSATION

public static final CompoundKeyType EXPORTER_INTERFACE_CONVERSATION

EXPORTER_INTERFACE_HOST

public static final CompoundKeyType EXPORTER_INTERFACE_HOST

EXPORTER_INTERFACE_TOS

public static final CompoundKeyType EXPORTER_INTERFACE_TOS

EXPORTER_INTERFACE_TOS_APPLICATION

public static final CompoundKeyType EXPORTER_INTERFACE_TOS_APPLICATION

EXPORTER_INTERFACE_TOS_CONVERSATION

public static final CompoundKeyType EXPORTER_INTERFACE_TOS_CONVERSATION

EXPORTER_INTERFACE_TOS_HOST

public static final CompoundKeyType EXPORTER_INTERFACE_TOS_HOST

Method Detail

values

public static CompoundKeyType[] 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 (CompoundKeyType c : CompoundKeyType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompoundKeyType 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

isTotalNotTopK

public boolean isTotalNotTopK()

getParent

public CompoundKeyType getParent()

getParts

public RefType[] getParts()

create

public CompoundKey create(org.opennms.netmgt.flows.persistence.model.FlowDocument flow)
                   throws MissingFieldsException

Throws:

MissingFieldsException