org.locationtech.geowave.migration.legacy.core.geotime

Class LegacySpatialField<T extends SpatialField>

java.lang.Object

org.locationtech.geowave.migration.legacy.core.geotime.LegacySpatialField<T>

All Implemented Interfaces:

NumericDimensionDefinition, Persistable, NumericDimensionField<org.locationtech.jts.geom.Geometry>

Direct Known Subclasses:

LegacyCustomCRSSpatialField, LegacyLatitudeField, LegacyLongitudeField

public abstract class LegacySpatialField<T extends SpatialField>
extends Object
implements Persistable, NumericDimensionField<org.locationtech.jts.geom.Geometry>

Field Summary

Fields

Modifier and Type	Field and Description
protected NumericDimensionDefinition	baseDefinition
protected String	fieldName
protected Integer	geometryPrecision
protected T	updatedField

Constructor Summary

Constructors

Constructor and Description
LegacySpatialField()
LegacySpatialField(NumericDimensionDefinition baseDefinition, Integer geometryPrecision)

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
void	fromBinary(byte[] bytes) Convert a stream of binary bytes to fields and data within an object.
NumericDimensionDefinition	getBaseDefinition() Get the basic index definition for this field
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
Set<IndexDimensionHint>	getDimensionHints()
Class<org.locationtech.jts.geom.Geometry>	getFieldClass()
String	getFieldName() Returns an identifier that is unique for a given data type (field IDs should be distinct per row)
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
NumericData	getNumericData(org.locationtech.jts.geom.Geometry dataElement) Decode a numeric value or range from the raw field value
double	getRange()
FieldReader<org.locationtech.jts.geom.Geometry>	getReader() Get a reader that can handle deserializing binary data into values for this field
abstract T	getUpdatedField(Index index)
FieldWriter<org.locationtech.jts.geom.Geometry>	getWriter() Get a writer that can handle serializing values for this field
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.locationtech.geowave.core.store.dimension.NumericDimensionField

getIndexFieldOptions, isCompatibleWith

Field Detail

fieldName

protected String fieldName

baseDefinition

protected NumericDimensionDefinition baseDefinition

geometryPrecision

protected Integer geometryPrecision

updatedField

protected T extends SpatialField updatedField

Constructor Detail

LegacySpatialField

public LegacySpatialField()

LegacySpatialField

public LegacySpatialField(NumericDimensionDefinition baseDefinition,
                          @Nullable
                          Integer geometryPrecision)

Method Detail

getUpdatedField

public abstract T getUpdatedField(Index index)

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

getRange

public double getRange()

Specified by:

getRange in interface NumericDimensionDefinition

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

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 - a numeric range of the data set

Returns:

an array of BinRange[] objects

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

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

getFullRange

public NumericData getFullRange()

Specified by:

getFullRange in interface NumericDimensionDefinition

Returns:

the entire allowed range

getNumericData

public NumericData getNumericData(org.locationtech.jts.geom.Geometry dataElement)

Description copied from interface: NumericDimensionField

Decode a numeric value or range from the raw field value

Specified by:

getNumericData in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

Parameters:

dataElement - the raw field value

Returns:

a numeric value or range

getFieldName

public String getFieldName()

Description copied from interface: NumericDimensionField

Returns an identifier that is unique for a given data type (field IDs should be distinct per row)

Specified by:

getFieldName in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

Returns:

the field name

getDimensionHints

public Set<IndexDimensionHint> getDimensionHints()

Specified by:

getDimensionHints in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

getWriter

public FieldWriter<org.locationtech.jts.geom.Geometry> getWriter()

Description copied from interface: NumericDimensionField

Get a writer that can handle serializing values for this field

Specified by:

getWriter in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

Returns:

the field writer for this field

getReader

public FieldReader<org.locationtech.jts.geom.Geometry> getReader()

Description copied from interface: NumericDimensionField

Get a reader that can handle deserializing binary data into values for this field

Specified by:

getReader in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

Returns:

the field reader for this field

getBaseDefinition

public NumericDimensionDefinition getBaseDefinition()

Description copied from interface: NumericDimensionField

Get the basic index definition for this field

Specified by:

getBaseDefinition in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>

Returns:

the base index definition for this dimension

getFieldClass

public Class<org.locationtech.jts.geom.Geometry> getFieldClass()

Specified by:

getFieldClass in interface NumericDimensionField<org.locationtech.jts.geom.Geometry>