org.locationtech.geowave.analytic.nn

Class NeighborIndex<NNTYPE>

java.lang.Object

org.locationtech.geowave.analytic.nn.NeighborIndex<NNTYPE>

Type Parameters:

NNTYPE -

public class NeighborIndex<NNTYPE>
extends Object

Maintain an association between an ID of any item and its neighbors, as they are discovered. The index supports a bi-directional association, forming a graph of adjacency lists.

Constructor Summary

Constructors

Constructor and Description
NeighborIndex(NeighborListFactory<NNTYPE> listFactory)

Method Summary

Modifier and Type	Method and Description
void	add(DistanceProfile<?> distanceProfile, org.locationtech.geowave.core.index.ByteArray centerId, NNTYPE centerValue, org.locationtech.geowave.core.index.ByteArray neighborId, NNTYPE neighborValue, boolean addReciprical)
void	empty(org.locationtech.geowave.core.index.ByteArray id)
NeighborList<NNTYPE>	init(org.locationtech.geowave.core.index.ByteArray id, NNTYPE value) Invoked when the provided node is being inspected to find neighbors.

Methods inherited from class java.lang.Object

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

Constructor Detail

NeighborIndex

public NeighborIndex(NeighborListFactory<NNTYPE> listFactory)

Method Detail

init

public NeighborList<NNTYPE> init(org.locationtech.geowave.core.index.ByteArray id,
                                 NNTYPE value)

Invoked when the provided node is being inspected to find neighbors. Creates the associated neighbor list, if not already created. Notifies the neighbor list that it is formally initialized. The neighbor list may already exist and have associated neighbors. This occurs when those relationships are discovered through traversing the neighbor.

This method is designed for neighbor lists do some optimizations just prior to the neighbor discovery process.

add

public void add(DistanceProfile<?> distanceProfile,
                org.locationtech.geowave.core.index.ByteArray centerId,
                NNTYPE centerValue,
                org.locationtech.geowave.core.index.ByteArray neighborId,
                NNTYPE neighborValue,
                boolean addReciprical)

empty

public void empty(org.locationtech.geowave.core.index.ByteArray id)