Module datarush.library

Package com.pervasive.datarush.functions

Enum Class DateTime.Granularity

java.lang.Object

java.lang.Enum<DateTime.Granularity>

com.pervasive.datarush.functions.DateTime.Granularity

All Implemented Interfaces:

Serializable, Comparable<DateTime.Granularity>, java.lang.constant.Constable

Enclosing class:

DateTime

public static enum DateTime.Granularity
extends Enum<DateTime.Granularity>

The desired granularity of the output.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENTURY	A unit of one century
DAY	A unit of one day.
HOUR	A unit of one hour.
MILLISECOND	A unit of one millisecond.
MINUTE	A unit of one minute.
MONTH	A unit of one month.
SECOND	A unit of one second.
WEEK	A unit of one week
YEAR	A unit of one year.

Method Summary

Modifier and Type	Method	Description
double	getFactor()	Gets the conversion factor from milliseconds.
TemporalUnit	getField()	Gets the equivalent Joda-Time field type.
static DateTime.Granularity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DateTime.Granularity[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MILLISECOND

public static final DateTime.Granularity MILLISECOND

A unit of one millisecond.

SECOND

public static final DateTime.Granularity SECOND

A unit of one second.

MINUTE

public static final DateTime.Granularity MINUTE

A unit of one minute.

HOUR

public static final DateTime.Granularity HOUR

A unit of one hour.

DAY

public static final DateTime.Granularity DAY

A unit of one day.

WEEK

public static final DateTime.Granularity WEEK

A unit of one week

MONTH

public static final DateTime.Granularity MONTH

A unit of one month.

YEAR

public static final DateTime.Granularity YEAR

A unit of one year.

CENTURY

public static final DateTime.Granularity CENTURY

A unit of one century

Method Details

values

public static DateTime.Granularity[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DateTime.Granularity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getFactor

public double getFactor()

Gets the conversion factor from milliseconds.

Returns:

the divisor to produce the specified granularity from milliseconds

getField

public TemporalUnit getField()

Gets the equivalent Joda-Time field type.

Returns:

the Joda-Time DurationFieldType for this granularity