org.opennms.nephron

Class CompoundKey

java.lang.Object

org.opennms.nephron.CompoundKey

@DefaultCoder(value=CompoundKey.CompoundKeyCoder.class)
public class CompoundKey
extends Object

Represents a compound key. A compound key is used to group flows into different dimensions. A compound key is made up from a list of Ref values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompoundKey.CompoundKeyCoder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CompoundKey	getOuterKey() Build the parent, or "outer" key for the current key.
List<org.opennms.nephron.Ref>	getRefs()
CompoundKeyType	getType()
String	groupedByKey()
int	hashCode()
void	populate(FlowSummary flow)
CompoundKey	project(CompoundKeyType projectedType) Project this key into a key of the given type.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public CompoundKeyType getType()

getRefs

public List<org.opennms.nephron.Ref> getRefs()

getOuterKey

public CompoundKey getOuterKey()

Build the parent, or "outer" key for the current key.

Returns:

the outer key, or null if no such key exists

project

public CompoundKey project(CompoundKeyType projectedType)

Project this key into a key of the given type. The projection is done by removing the key parts from this key that have no corresponding RefType in the given type.

groupedByKey

public String groupedByKey()

populate

public void populate(FlowSummary flow)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object