org.locationtech.geowave.core.geotime.adapter

Class TemporalFieldDescriptorBuilder<T>

java.lang.Object

org.locationtech.geowave.core.store.adapter.FieldDescriptorBuilder<T,TemporalFieldDescriptor<T>,TemporalFieldDescriptorBuilder<T>>

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

Type Parameters:

T - the adapter field type

public class TemporalFieldDescriptorBuilder<T>
extends FieldDescriptorBuilder<T,TemporalFieldDescriptor<T>,TemporalFieldDescriptorBuilder<T>>

A field descriptor builder for adapter fields that contain time information.

Field Summary

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

bindingClass, fieldName, indexHints

Constructor Summary

Constructors

Constructor and Description
TemporalFieldDescriptorBuilder(Class<T> bindingClass)

Method Summary

Modifier and Type	Method and Description
TemporalFieldDescriptor<T>	build()
TemporalFieldDescriptorBuilder<T>	endTimeIndexHint() Hint that the field is the end of a time range and should be used for temporal indexing.
TemporalFieldDescriptorBuilder<T>	startTimeIndexHint() Hint that the field is the start of a time range and should be used for temporal indexing.
TemporalFieldDescriptorBuilder<T>	timeIndexHint() Hint that the field is a time instant and should be used for temporal 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

Constructor Detail

TemporalFieldDescriptorBuilder

public TemporalFieldDescriptorBuilder(Class<T> bindingClass)

Method Detail

timeIndexHint

public TemporalFieldDescriptorBuilder<T> timeIndexHint()

Hint that the field is a time instant and should be used for temporal indexing.

Returns:

the temporal field descriptor builder

startTimeIndexHint

public TemporalFieldDescriptorBuilder<T> startTimeIndexHint()

Hint that the field is the start of a time range and should be used for temporal indexing. There should be a corresponding end time index hint specified in the schema.

Returns:

the temporal field descriptor builder

endTimeIndexHint

public TemporalFieldDescriptorBuilder<T> endTimeIndexHint()

Hint that the field is the end of a time range and should be used for temporal indexing. There should be a corresponding start time index hint specified in the schema.

Returns:

the temporal field descriptor builder

build

public TemporalFieldDescriptor<T> build()

Overrides:

build in class FieldDescriptorBuilder<T,TemporalFieldDescriptor<T>,TemporalFieldDescriptorBuilder<T>>