edu.umn.cs.spatialHadoop.core

Class Partitioner

java.lang.Object

edu.umn.cs.spatialHadoop.core.Partitioner

Direct Known Subclasses:

GridPartitioner, HilbertCurvePartitioner, KdTreePartitioner, QuadTreePartitioner, STRPartitioner, ZCurvePartitioner

public abstract class Partitioner
extends java.lang.Object

An interface for spatially partitioning data into partitions.

Author:

Ahmed Eldawy

Constructor Summary

Constructors

Constructor and Description
Partitioner()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	createFromPoints(Rectangle mbr, Point[] points, int numPartitions) Populate this partitioner for a set of points and number of partitions
abstract CellInfo	getPartition(int partitionID) Returns the details of a specific partition given its ID.
abstract CellInfo	getPartitionAt(int index) Returns the detail of a partition given its position starting from zero and ending at partitionCount() - 1
abstract int	getPartitionCount() Returns total number of partitions
static Partitioner	getPartitioner(Configuration conf) Retrieves the value of a partitioner for a given job.
abstract int	overlapPartition(Shape shape) Returns only one overlapping partition.
abstract void	overlapPartitions(Shape shape, ResultCollector<java.lang.Integer> matcher) Overlap a shape with partitions and calls a matcher for each overlapping partition.
static void	setPartitioner(Configuration conf, Partitioner partitioner) Sets the class and value of a partitioner in the given job

Methods inherited from class java.lang.Object

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

Constructor Detail

Partitioner

public Partitioner()

Method Detail

createFromPoints

public abstract void createFromPoints(Rectangle mbr,
                    Point[] points,
                    int numPartitions)

Populate this partitioner for a set of points and number of partitions

Parameters:

mbr -

points -

numPartitions -

overlapPartitions

public abstract void overlapPartitions(Shape shape,
                     ResultCollector<java.lang.Integer> matcher)

Overlap a shape with partitions and calls a matcher for each overlapping partition.

Parameters:

shape -

matcher -

overlapPartition

public abstract int overlapPartition(Shape shape)

Returns only one overlapping partition. If the given shape overlaps more than one partitions, the partitioner returns only one of them according to its own criteria. If it does not overlap any partition, it returns -1 which is an invalid partition ID.

Parameters:

shape -

Returns:

getPartition

public abstract CellInfo getPartition(int partitionID)

Returns the details of a specific partition given its ID.

Parameters:

partitionID -

Returns:

getPartitionAt

public abstract CellInfo getPartitionAt(int index)

Returns the detail of a partition given its position starting from zero and ending at partitionCount() - 1

Parameters:

partitionID -

Returns:

getPartitionCount

public abstract int getPartitionCount()

Returns total number of partitions

Returns:

setPartitioner

public static void setPartitioner(Configuration conf,
                  Partitioner partitioner)
                           throws java.io.IOException

Sets the class and value of a partitioner in the given job

Parameters:

conf -

partitioner -

Throws:

java.io.IOException

getPartitioner

public static Partitioner getPartitioner(Configuration conf)

Retrieves the value of a partitioner for a given job.

Parameters:

conf -

Returns: