org.locationtech.geowave.analytic.nn

Class NNProcessor<PARTITION_VALUE,STORE_VALUE>

java.lang.Object

org.locationtech.geowave.analytic.nn.NNProcessor<PARTITION_VALUE,STORE_VALUE>

Type Parameters:

PARTITION_VALUE -

STORE_VALUE - @See Partitioner @See Partitioner.PartitionData

public class NNProcessor<PARTITION_VALUE,STORE_VALUE>
extends Object

This class is designed to support secondary partitioning.

(1) Partition added data using a partitioner.

(2) Process data, perform the O(N^2) (e.g. ~ n^2/2) comparisons within those partitions.

Custom plug-ins include (1) A factory for the neighbor list to track those pairings of data whose distance feel under the provided minimum. (2) A complete notification callback callback for each primary data.

The loop algorithms is For each primary compare to all remaining primary and all secondary data items

A powerful performance enhancing tool is the inference mechanism associated with the neighborhood lists. A list can have intelligence to decide that a particular neighbor can be inferred and, therefore, can be removed from the set of primaries to be inspected. This has no effect on secondaries.

The processor can be called multiple times, as the 'process' algorithm does not alter its internal state. The notification callback can be used to alter the internal state (e.g. calling 'add' or 'remove' methods). Caution should used to alter internal state within the neighbor list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NNProcessor.CompleteNotifier<STORE_VALUE>

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_UPPER_BOUND_PARTIION_SIZE
protected DistanceProfileGenerateFn<?,STORE_VALUE>	distanceProfileFn
protected NeighborIndex<STORE_VALUE>	index
protected static org.slf4j.Logger	LOGGER
protected double	maxDistance
protected Partitioner.PartitionData	parentPartition
protected Partitioner<Object>	partitioner
protected org.locationtech.geowave.core.index.ByteArray	startingPoint Run State
protected TypeConverter<STORE_VALUE>	typeConverter

Constructor Summary

Constructors

Constructor and Description
NNProcessor(Partitioner<Object> partitioner, TypeConverter<STORE_VALUE> typeConverter, DistanceProfileGenerateFn<?,STORE_VALUE> distanceProfileFn, double maxDistance, Partitioner.PartitionData parentPartition)

Method Summary

Modifier and Type	Method and Description
void	add(org.locationtech.geowave.core.index.ByteArray id, boolean isPrimary, PARTITION_VALUE partitionValue)
int	getUpperBoundPerPartition()
void	process(NeighborListFactory<STORE_VALUE> listFactory, NNProcessor.CompleteNotifier<STORE_VALUE> notification)
void	remove(org.locationtech.geowave.core.index.ByteArray id)
void	setUpperBoundPerPartition(int upperBoundPerPartition)
int	size()
boolean	trimSmallPartitions(int size)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

partitioner

protected final Partitioner<Object> partitioner

typeConverter

protected final TypeConverter<STORE_VALUE> typeConverter

distanceProfileFn

protected final DistanceProfileGenerateFn<?,STORE_VALUE> distanceProfileFn

maxDistance

protected final double maxDistance

parentPartition

protected final Partitioner.PartitionData parentPartition

DEFAULT_UPPER_BOUND_PARTIION_SIZE

public static final int DEFAULT_UPPER_BOUND_PARTIION_SIZE

See Also:

Constant Field Values

startingPoint

protected org.locationtech.geowave.core.index.ByteArray startingPoint

Run State

index

protected NeighborIndex<STORE_VALUE> index

Constructor Detail

NNProcessor

public NNProcessor(Partitioner<Object> partitioner,
                   TypeConverter<STORE_VALUE> typeConverter,
                   DistanceProfileGenerateFn<?,STORE_VALUE> distanceProfileFn,
                   double maxDistance,
                   Partitioner.PartitionData parentPartition)

Method Detail

remove

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

add

public void add(org.locationtech.geowave.core.index.ByteArray id,
                boolean isPrimary,
                PARTITION_VALUE partitionValue)
         throws IOException

Throws:

IOException

size

public int size()

trimSmallPartitions

public boolean trimSmallPartitions(int size)

Parameters:

size - the minimum size of a partition to be processed

Returns:

true if all partitions are emptt

process

public void process(NeighborListFactory<STORE_VALUE> listFactory,
                    NNProcessor.CompleteNotifier<STORE_VALUE> notification)
             throws IOException,
                    InterruptedException

Throws:

IOException

InterruptedException

getUpperBoundPerPartition

public int getUpperBoundPerPartition()

setUpperBoundPerPartition

public void setUpperBoundPerPartition(int upperBoundPerPartition)