org.locationtech.geowave.core.geotime.adapter

Class SpatialFieldDescriptorBuilder<T>

java.lang.Object

org.locationtech.geowave.core.store.adapter.FieldDescriptorBuilder<T,SpatialFieldDescriptor<T>,SpatialFieldDescriptorBuilder<T>>

org.locationtech.geowave.core.geotime.adapter.SpatialFieldDescriptorBuilder<T>

Type Parameters:

T - the adapter field type

public class SpatialFieldDescriptorBuilder<T>
extends FieldDescriptorBuilder<T,SpatialFieldDescriptor<T>,SpatialFieldDescriptorBuilder<T>>

A field descriptor builder that includes helper functions for spatial indexing hints and `CoordinateReferenceSystem`.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.opengis.referencing.crs.CoordinateReferenceSystem	crs

Fields inherited from class org.locationtech.geowave.core.store.adapter.FieldDescriptorBuilder

bindingClass, fieldName, indexHints

Constructor Summary

Constructors

Constructor and Description
SpatialFieldDescriptorBuilder(Class<T> bindingClass)

Method Summary

Modifier and Type	Method and Description
SpatialFieldDescriptor<T>	build()
SpatialFieldDescriptorBuilder<T>	crs(org.opengis.referencing.crs.CoordinateReferenceSystem crs) Specify the coordinate reference system of the spatial field.
SpatialFieldDescriptorBuilder<T>	latitudeIndexHint() Hint that the field contains latitude information and should be used in spatial indexing.
SpatialFieldDescriptorBuilder<T>	longitudeIndexHint() Hint that the field contains longitude information and should be used in spatial indexing.
SpatialFieldDescriptorBuilder<T>	spatialIndexHint() Hint that the field contains both latitude and longitude information and should be used in spatial indexing.

Methods inherited from class org.locationtech.geowave.core.store.adapter.FieldDescriptorBuilder

fieldName, indexHint

Methods inherited from class java.lang.Object

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

Field Detail

crs

protected org.opengis.referencing.crs.CoordinateReferenceSystem crs

Constructor Detail

SpatialFieldDescriptorBuilder

public SpatialFieldDescriptorBuilder(Class<T> bindingClass)

Method Detail

spatialIndexHint

public SpatialFieldDescriptorBuilder<T> spatialIndexHint()

Hint that the field contains both latitude and longitude information and should be used in spatial indexing.

Returns:

the spatial field descriptor builder

latitudeIndexHint

public SpatialFieldDescriptorBuilder<T> latitudeIndexHint()

Hint that the field contains latitude information and should be used in spatial indexing.

Returns:

the spatial field descriptor builder

longitudeIndexHint

public SpatialFieldDescriptorBuilder<T> longitudeIndexHint()

Hint that the field contains longitude information and should be used in spatial indexing.

Returns:

the spatial field descriptor builder

crs

public SpatialFieldDescriptorBuilder<T> crs(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Specify the coordinate reference system of the spatial field.

Returns:

the spatial field descriptor builder

build

public SpatialFieldDescriptor<T> build()

Overrides:

build in class FieldDescriptorBuilder<T,SpatialFieldDescriptor<T>,SpatialFieldDescriptorBuilder<T>>