org.locationtech.geowave.core.geotime.store.query.aggregate

Class SpatialBinningStrategy<T>

java.lang.Object

org.locationtech.geowave.core.geotime.store.query.aggregate.SpatialBinningStrategy<T>

Type Parameters:

T - The type of the entry. The geometry inside of it is queried, and the geohash of that geometry is used as the bin.

All Implemented Interfaces:

Persistable, BinningStrategy

Direct Known Subclasses:

SpatialCommonIndexedBinningStrategy, SpatialFieldBinningStrategy, SpatialSimpleFeatureBinningStrategy

public abstract class SpatialBinningStrategy<T>
extends Object
implements BinningStrategy

This strategy uses a spatial binning type (such as H3, S2, GeoHash) on geometry fields to bin data.

Field Summary

Fields

Modifier and Type	Field and Description
protected ComplexGeometryBinningOption	complexGeometryBinning
protected String	geometryFieldName
protected int	precision The precision/resolution/length used by the binning strategy (it usually is equivalent to character length).
protected SpatialBinningType	type

Constructor Summary

Constructors

Constructor and Description
SpatialBinningStrategy()
SpatialBinningStrategy(SpatialBinningType type, int precision, boolean useCentroidOnly, String geometryFieldName) Use the given precision to bin objects

Method Summary

Modifier and Type	Method and Description
void	fromBinary(byte[] bytes)
<I> ByteArray[]	getBins(DataTypeAdapter<I> adapter, I entry, GeoWaveRow... rows) calculates appropriate bins for a given entry.
int	getPrecision()
byte[]	toBinary()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.locationtech.geowave.core.store.api.BinningStrategy

getWeight

Field Detail

geometryFieldName

protected String geometryFieldName

precision

protected int precision

The precision/resolution/length used by the binning strategy (it usually is equivalent to character length).

complexGeometryBinning

protected ComplexGeometryBinningOption complexGeometryBinning

type

protected SpatialBinningType type

Constructor Detail

SpatialBinningStrategy

public SpatialBinningStrategy()

SpatialBinningStrategy

public SpatialBinningStrategy(SpatialBinningType type,
                              int precision,
                              boolean useCentroidOnly,
                              String geometryFieldName)

Use the given precision to bin objects

Parameters:

type - The type (such as S3, H2, or GeoHash)

precision - The Geohash precision to calculate bins.

useCentroidOnly - for complex geometry such as lines and polygons whether to just aggregate one hash value based on the centroid or to apply the aggregation to all overlapping centroids

geometryFieldName - the field name for the geometry to bin by

Method Detail

getPrecision

public int getPrecision()

Returns:

The precision that is used when calculating bins for entries.

getBins

public <I> ByteArray[] getBins(DataTypeAdapter<I> adapter,
                               I entry,
                               GeoWaveRow... rows)

calculates appropriate bins for a given entry. GeohashBinningStrategy only ever bins into singleton-arrays.

Specified by:

getBins in interface BinningStrategy

Parameters:

entry - An entry to bin, utilizing its' geohash.

Returns:

a length-1 array of the bin that this entry can be placed into. `null` if no Geometry was found in the entry.

toBinary

public byte[] toBinary()

Specified by:

toBinary in interface Persistable

fromBinary

public void fromBinary(byte[] bytes)

Specified by:

fromBinary in interface Persistable