oracle.spatial.hadoop.vector.binning

Interface BinningAlg

All Known Implementing Classes:

HexBinningAlg, RectBinningAlg

public interface BinningAlg

Represents an algorithm to perform spatial binning.

Author:

hsaucedo

Method Summary

Modifier and Type	Method and Description
BinningConfig	getBinningConfig() Gets the binning configuration
void	getCell(double x, double y, int[] cell) Gets the row and column of the cell that contains the given point.
void	getCell(long cellId, int[] cell) Gets the row and column of the cell with the given id
long	getCellId(int[] cell) Gets the id of the cell represented by the given row and column
void	getCellMbr(int[] cell, double[] cellMbr) Gets the minimum bounding box of the given cell's row and column
void	getCellOrdinates(int[] cell, double[] cellOrds) Gets the ordinates of the given cell
int	getCellOrdinatesLength() Gets the number of ordinates that contains any cell created by this algorithm
boolean	isValidCell(int[] cell) Indicates whether a given cell is valid within the current binning configuration or not

Method Detail

getBinningConfig

BinningConfig getBinningConfig()

Gets the binning configuration

Returns:

a BinniningConfig instance

getCell

void getCell(double x,
             double y,
             int[] cell)

Gets the row and column of the cell that contains the given point.

Parameters:

x - The point`s x ordinate

y - The point`s y ordinate

cell - An output parameter which will hold the cell's row and column

getCell

void getCell(long cellId,
             int[] cell)

Gets the row and column of the cell with the given id

Parameters:

cellId - the cell id

cell - An output parameter which will hold the cell's row and column

getCellId

long getCellId(int[] cell)

Gets the id of the cell represented by the given row and column

Parameters:

cell - a cell's row and column

Returns:

the cell id

getCellMbr

void getCellMbr(int[] cell,
                double[] cellMbr)

Gets the minimum bounding box of the given cell's row and column

Parameters:

cell - a cell's row and column

cellMbr - An output parameter which will hold the cell's mbr

getCellOrdinates

void getCellOrdinates(int[] cell,
                      double[] cellOrds)

Gets the ordinates of the given cell

Parameters:

cell - a cell's row and column

cellOrds - An output parameter which will hold the cell's ordinates

getCellOrdinatesLength

int getCellOrdinatesLength()

Gets the number of ordinates that contains any cell created by this algorithm

Returns:

the number of ordinates

isValidCell

boolean isValidCell(int[] cell)

Indicates whether a given cell is valid within the current binning configuration or not

Parameters:

cell - a cell's row and column

Returns:

true if the cell is valid