org.locationtech.geowave.core.geotime.index.dimension

Class TemporalBinningStrategy

java.lang.Object

org.locationtech.geowave.core.geotime.index.dimension.TemporalBinningStrategy

All Implemented Interfaces:

IndexBinningStrategy, Persistable

public class TemporalBinningStrategy
extends Object
implements IndexBinningStrategy

This class is useful for establishing a consistent binning strategy using a unit of time. Each bin will then be defined by the boundaries of that unit within the timezone given in the constructor. So if the unit is year and the data spreads across 2011-2013, the bins will be 2011, 2012, and 2013. The unit chosen should represent a much more significant range than the average query range (at least 20x larger) for efficiency purposes. So if the average query is for a 24 hour period, the unit should not be a day, but could be perhaps a month or a year (depending on the temporal extent of the dataset).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemporalBinningStrategy.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	MILLIS_PER_DAY

Constructor Summary

Constructors

Constructor and Description
TemporalBinningStrategy()
TemporalBinningStrategy(TemporalBinningStrategy.Unit unit)
TemporalBinningStrategy(TemporalBinningStrategy.Unit unit, String timezone)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	fromBinary(byte[] bytes)
byte[]	getBinId(long millis)
double	getBinMax()
double	getBinMin()
BinValue	getBinnedValue(double value) Method used to bin a raw date in milliseconds to a binned value of the Binning Strategy.
NumericRange	getDenormalizedRanges(BinRange binnedRange)
int	getFixedBinIdSize()
org.threeten.extra.Interval	getInterval(byte[] binId)
BinRange[]	getNormalizedRanges(org.threeten.extra.Interval range)
BinRange[]	getNormalizedRanges(NumericData range)
int	hashCode()
protected void	setToEpoch(Calendar value)
byte[]	toBinary()

Methods inherited from class java.lang.Object

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

Field Detail

MILLIS_PER_DAY

protected static final long MILLIS_PER_DAY

See Also:

Constant Field Values

Constructor Detail

TemporalBinningStrategy

public TemporalBinningStrategy()

TemporalBinningStrategy

public TemporalBinningStrategy(TemporalBinningStrategy.Unit unit)

TemporalBinningStrategy

public TemporalBinningStrategy(TemporalBinningStrategy.Unit unit,
                               String timezone)

Method Detail

getBinMin

public double getBinMin()

Specified by:

getBinMin in interface IndexBinningStrategy

getBinMax

public double getBinMax()

Specified by:

getBinMax in interface IndexBinningStrategy

getBinnedValue

public BinValue getBinnedValue(double value)

Method used to bin a raw date in milliseconds to a binned value of the Binning Strategy.

Specified by:

getBinnedValue in interface IndexBinningStrategy

setToEpoch

protected void setToEpoch(Calendar value)

getFixedBinIdSize

public int getFixedBinIdSize()

Specified by:

getFixedBinIdSize in interface IndexBinningStrategy

getBinId

public byte[] getBinId(long millis)

getNormalizedRanges

public BinRange[] getNormalizedRanges(org.threeten.extra.Interval range)

getNormalizedRanges

public BinRange[] getNormalizedRanges(NumericData range)

Specified by:

getNormalizedRanges in interface IndexBinningStrategy

toBinary

public byte[] toBinary()

Specified by:

toBinary in interface Persistable

fromBinary

public void fromBinary(byte[] bytes)

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

getDenormalizedRanges

public NumericRange getDenormalizedRanges(BinRange binnedRange)

Specified by:

getDenormalizedRanges in interface IndexBinningStrategy

getInterval

public org.threeten.extra.Interval getInterval(byte[] binId)