Package org.hortonmachine.gears.utils.clustering

Class GvmDefaultKeyer<K>

java.lang.Object

org.hortonmachine.gears.utils.clustering.GvmDefaultKeyer<K>

Type Parameters:

K - the key type

All Implemented Interfaces:

GvmKeyer<K>

public class GvmDefaultKeyer<K>
extends Object
implements GvmKeyer<K>

Merges keys by choosing the non-null key of the more massive cluster when available. Where a key is being added to a cluster, any pre-existing key is preserved.

Author:

Tom Gibara

Constructor Summary

Constructors

Constructor	Description
GvmDefaultKeyer()

Method Summary

Modifier and Type	Method	Description
K	addKey(GvmCluster<?,K> cluster, K key)	Called when a key is being added to a cluster.
K	mergeKeys(GvmCluster<?,K> c1, GvmCluster<?,K> c2)	Called when two clusters are being merged.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GvmDefaultKeyer

public GvmDefaultKeyer()

Method Detail

mergeKeys

public K mergeKeys(GvmCluster<?,K> c1,
                   GvmCluster<?,K> c2)

Description copied from interface: GvmKeyer

Called when two clusters are being merged. One key needs to be chosen/synthesized from those of the clusters being merged.

Specified by:

mergeKeys in interface GvmKeyer<K>

Parameters:

c1 - the cluster with the greater mass

c2 - the cluster with the lesser mass

Returns:

a key for the cluster that combines those of c1 and c2, may be null

addKey

public K addKey(GvmCluster<?,K> cluster,
                K key)

Description copied from interface: GvmKeyer

Called when a key is being added to a cluster.

Specified by:

addKey in interface GvmKeyer<K>

Parameters:

cluster - a cluster

key - the key for a newly clustered coordinate

Returns:

the key to be assigned to the new cluster, may be null