org.locationtech.geowave.core.index.sfc

Class SFCDimensionDefinition

java.lang.Object

org.locationtech.geowave.core.index.sfc.SFCDimensionDefinition

All Implemented Interfaces:

NumericDimensionDefinition, Persistable

public class SFCDimensionDefinition
extends Object
implements NumericDimensionDefinition

This class wraps a dimension definition with a cardinality (bits of precision) on a space filling curve

Constructor Summary

Constructors

Constructor and Description
SFCDimensionDefinition()
SFCDimensionDefinition(NumericDimensionDefinition dimensionDefinition, int bitsOfPrecision)

Method Summary

Modifier and Type	Method and Description
double	denormalize(double value) Used to denormalize the numeric data set from a value between 0 and 1 scaled to fit within its native bounds
boolean	equals(Object obj)
void	fromBinary(byte[] bytes) Convert a stream of binary bytes to fields and data within an object.
int	getBitsOfPrecision()
NumericRange	getBounds() Returns the native bounds of the dimension definition
NumericRange	getDenormalizedRange(BinRange range) Returns a range in the native bounds of the dimension definition, denormalized from a bin and separate range
NumericDimensionDefinition	getDimensionDefinition()
int	getFixedBinIdSize() If this numeric dimension definition uses bins, it is given a fixed length for the bin ID
NumericData	getFullRange()
BinRange[]	getNormalizedRanges(NumericData range) Returns the set of normalized ranges
double	getRange()
int	hashCode()
double	normalize(double value) Used to normalize a value within the bounds of the range to a percentage of the range between 0 and 1
byte[]	toBinary() Convert fields and data within an object to binary form for transmission or storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

SFCDimensionDefinition

public SFCDimensionDefinition()

SFCDimensionDefinition

public SFCDimensionDefinition(NumericDimensionDefinition dimensionDefinition,
                              int bitsOfPrecision)

Parameters:

dimensionDefinition - an object which defines a dimension used to create a space filling curve

bitsOfPrecision - the number of bits associated with the specified dimension object

Method Detail

getFullRange

public NumericData getFullRange()

Specified by:

getFullRange in interface NumericDimensionDefinition

Returns:

the entire allowed range

getBitsOfPrecision

public int getBitsOfPrecision()

Returns:

bitsOfPrecision the bits of precision for the dimension object

getNormalizedRanges

public BinRange[] getNormalizedRanges(NumericData range)

Description copied from interface: NumericDimensionDefinition

Returns the set of normalized ranges

Specified by:

getNormalizedRanges in interface NumericDimensionDefinition

Parameters:

range - numeric data to be normalized

Returns:

a BinRange[] based on numeric data

getDimensionDefinition

public NumericDimensionDefinition getDimensionDefinition()

normalize

public double normalize(double value)

Description copied from interface: NumericDimensionDefinition

Used to normalize a value within the bounds of the range to a percentage of the range between 0 and 1

Specified by:

normalize in interface NumericDimensionDefinition

Returns:

normalized value

denormalize

public double denormalize(double value)

Description copied from interface: NumericDimensionDefinition

Used to denormalize the numeric data set from a value between 0 and 1 scaled to fit within its native bounds

Specified by:

denormalize in interface NumericDimensionDefinition

Returns:

the denormalized value

getDenormalizedRange

public NumericRange getDenormalizedRange(BinRange range)

Description copied from interface: NumericDimensionDefinition

Returns a range in the native bounds of the dimension definition, denormalized from a bin and separate range

Specified by:

getDenormalizedRange in interface NumericDimensionDefinition

Parameters:

range - a numeric range of the data set, with a bin

Returns:

a NumericRange representing the given bin and range

getFixedBinIdSize

public int getFixedBinIdSize()

Description copied from interface: NumericDimensionDefinition

If this numeric dimension definition uses bins, it is given a fixed length for the bin ID

Specified by:

getFixedBinIdSize in interface NumericDimensionDefinition

Returns:

the fixed length for this dimensions bin ID

getRange

public double getRange()

Specified by:

getRange in interface NumericDimensionDefinition

getBounds

public NumericRange getBounds()

Description copied from interface: NumericDimensionDefinition

Returns the native bounds of the dimension definition

Specified by:

getBounds in interface NumericDimensionDefinition

Returns:

a range representing the minimum value and the maximum value for this dimension definition

toBinary

public byte[] toBinary()

Description copied from interface: Persistable

Convert fields and data within an object to binary form for transmission or storage.

Specified by:

toBinary in interface Persistable

Returns:

an array of bytes representing a binary stream representation of the object.

fromBinary

public void fromBinary(byte[] bytes)

Description copied from interface: Persistable

Convert a stream of binary bytes to fields and data within an object.

Specified by:

fromBinary in interface Persistable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object