org.locationtech.geowave.core.geotime.util

Class TimeUtils

java.lang.Object

org.locationtech.geowave.core.geotime.util.TimeUtils

public class TimeUtils
extends Object

This class contains a set of Temporal utility methods that are generally useful throughout the GeoWave core codebase.

Field Summary

Fields

Modifier and Type	Field and Description
static long	RESERVED_MILLIS_FOR_NULL

Constructor Summary

Constructors

Constructor and Description
TimeUtils()

Method Summary

Modifier and Type	Method and Description
static long	calendarToGMTMillis(Calendar cal) Convert a calendar object to a long in the form of milliseconds since the epoch of January 1, 1970.
static TemporalConstraints	composeRangeTemporalConstraints(TimeDescriptors timeDescriptors, TemporalConstraintsSet constraintsSet) Compose temporal constraints given the constraint set and the descriptors for the index.
static Instant	getInstant(Object timeObject)
static org.threeten.extra.Interval	getInterval(Object timeObject)
static org.threeten.extra.Interval	getInterval(Object startTimeObject, Object endTimeObject)
static org.threeten.extra.Interval	getInterval(org.opengis.feature.simple.SimpleFeature entry, String fieldName)
static Instant	getIntervalEnd(org.threeten.extra.Interval interval)
static TemporalConstraints	getTemporalConstraintsForDescriptors(TimeDescriptors timeDescriptors, TemporalConstraintsSet timeBoundsSet)
static long	getTimeMillis(Object timeObj) Get the time in millis of this temporal object (either numeric interpreted as millisecond time in GMT, Date, or Calendar)
static Object	getTimeValue(Class<?> bindingClass, long longVal) Instantiates the class type as a new object with the temporal value being the longVal interpreted as milliseconds since the epoch in GMT
static TimeDescriptors	inferTimeAttributeDescriptor(org.opengis.feature.simple.SimpleFeatureType persistType) Determine if a time or range descriptor is set.
static boolean	isTemporal(Class<?> bindingClass) Determine if this class is a supported temporal class.
static org.opengis.filter.Filter	toDuringFilter(long startTimeMillis, long endTimeMillis, String singleTimeField)
static org.opengis.filter.Filter	toFilter(long startTimeMillis, long endTimeMillis, String startTimeField, String endTimeField)

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_MILLIS_FOR_NULL

public static long RESERVED_MILLIS_FOR_NULL

Constructor Detail

TimeUtils

public TimeUtils()

Method Detail

calendarToGMTMillis

public static long calendarToGMTMillis(Calendar cal)

Convert a calendar object to a long in the form of milliseconds since the epoch of January 1, 1970. The time is converted to GMT if it is not already in that timezone so that all times will be in a standard timezone.

Parameters:

cal - The calendar object

Returns:

The time in milliseconds

toDuringFilter

public static org.opengis.filter.Filter toDuringFilter(long startTimeMillis,
                                                       long endTimeMillis,
                                                       String singleTimeField)

Parameters:

startTimeMillis - start time (inclusive)

endTimeMillis - end time (exclusive)

singleTimeField -

Returns:

the during filter

toFilter

public static org.opengis.filter.Filter toFilter(long startTimeMillis,
                                                 long endTimeMillis,
                                                 String startTimeField,
                                                 String endTimeField)

getTimeMillis

public static long getTimeMillis(Object timeObj)

Get the time in millis of this temporal object (either numeric interpreted as millisecond time in GMT, Date, or Calendar)

Parameters:

timeObj - The temporal object

Returns:

The time in milliseconds since the epoch in GMT

isTemporal

public static boolean isTemporal(Class<?> bindingClass)

Determine if this class is a supported temporal class. Numeric classes are not determined to be temporal in this case even though they can be interpreted as milliseconds because we do not want to be over-selective and mis-interpret numeric fields

Parameters:

bindingClass - The binding class of the attribute

Returns:

A flag indicating whether the class is temporal

getTimeValue

public static Object getTimeValue(Class<?> bindingClass,
                                  long longVal)

Instantiates the class type as a new object with the temporal value being the longVal interpreted as milliseconds since the epoch in GMT

Parameters:

bindingClass - The class to try to instantiate for this time value. Currently java.util.Calendar, java.util.Date, and java.lang.Long are supported.

longVal - A value to be interpreted as milliseconds since the epoch in GMT

Returns:

An instance of the binding class with the value interpreted from longVal

getTemporalConstraintsForDescriptors

public static TemporalConstraints getTemporalConstraintsForDescriptors(TimeDescriptors timeDescriptors,
                                                                       TemporalConstraintsSet timeBoundsSet)

composeRangeTemporalConstraints

public static TemporalConstraints composeRangeTemporalConstraints(TimeDescriptors timeDescriptors,
                                                                  TemporalConstraintsSet constraintsSet)

Compose temporal constraints given the constraint set and the descriptors for the index.

Parameters:

timeDescriptors -

constraintsSet -

Returns:

null if the constraints does not have the fields required by the time descriptors

getInterval

public static org.threeten.extra.Interval getInterval(org.opengis.feature.simple.SimpleFeature entry,
                                                      String fieldName)

getInstant

public static Instant getInstant(Object timeObject)

getInterval

public static org.threeten.extra.Interval getInterval(Object timeObject)

getInterval

public static org.threeten.extra.Interval getInterval(Object startTimeObject,
                                                      Object endTimeObject)

getIntervalEnd

public static Instant getIntervalEnd(org.threeten.extra.Interval interval)

inferTimeAttributeDescriptor

public static final TimeDescriptors inferTimeAttributeDescriptor(org.opengis.feature.simple.SimpleFeatureType persistType)

Determine if a time or range descriptor is set. If so, then use it, otherwise infer.

Parameters:

persistType - - FeatureType that will be scanned for TimeAttributes

Returns:

the time descriptors