org.protempa.proposition.value

Class AbsoluteTimeGranularity

java.lang.Object

org.protempa.proposition.value.AbsoluteTimeGranularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>, Granularity

public final class AbsoluteTimeGranularity
extends Object
implements Granularity

Defines absolute time temporal granularities. The getName method provides a unique String for the unit. The base length is UTC milliseconds from the epoch.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AbsoluteTimeGranularity	DAY
static AbsoluteTimeGranularity	HOUR
static AbsoluteTimeGranularity	MINUTE
static AbsoluteTimeGranularity	MONTH
static AbsoluteTimeGranularity	SECOND
static AbsoluteTimeGranularity	YEAR

Method Summary

Modifier and Type	Method and Description
int	compareTo(Granularity o)
long	distance(long start, long finish, Granularity finishGranularity, Unit distanceUnit) Calculates the distance between two positions.
long	earliest(long pos)
boolean	equals(Object obj)
String	getAbbrevatedName() Returns a shorter version of the granularity's name.
Unit	getCorrespondingUnit()
DateFormat	getLongDateFormatNoYear()
DateFormat	getLongFormat()
DateFormat	getMediumDateFormatNoYear()
DateFormat	getMediumFormat()
String	getName() Returns the granularity's singular name.
String	getPluralName() Returns the granularity's plural name.
Format	getReprFormat()
DateFormat	getShortDateFormatNoYear()
DateFormat	getShortFormat()
DateFormat	getTimeFormat()
static AbsoluteTimeGranularity	granularityStringToGranularity(String string)
int	hashCode()
long	latest(long pos)
long	maximumDistance(long position, long distance, Unit distanceUnit)
long	minimumDistance(long position, long distance, Unit distanceUnit)
static AbsoluteTimeGranularity	nameToGranularity(String name)
static String	toSQLString(Long position) Convenience method to translate a timestamp into the format expected by SQL.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SECOND

public static final AbsoluteTimeGranularity SECOND

MINUTE

public static final AbsoluteTimeGranularity MINUTE

HOUR

public static final AbsoluteTimeGranularity HOUR

DAY

public static final AbsoluteTimeGranularity DAY

MONTH

public static final AbsoluteTimeGranularity MONTH

YEAR

public static final AbsoluteTimeGranularity YEAR

Method Detail

toSQLString

public static String toSQLString(Long position)

Convenience method to translate a timestamp into the format expected by SQL.

Parameters:

position - a date/time in milliseconds since the epoch.

Returns:

a String in JDBC timestamp escape format.

granularityStringToGranularity

public static AbsoluteTimeGranularity granularityStringToGranularity(String string)

nameToGranularity

public static AbsoluteTimeGranularity nameToGranularity(String name)

getPluralName

public String getPluralName()

Description copied from interface: Granularity

Returns the granularity's plural name.

Specified by:

getPluralName in interface Granularity

Returns:

a String

getName

public String getName()

Description copied from interface: Granularity

Returns the granularity's singular name.

Specified by:

getName in interface Granularity

Returns:

a String

getAbbrevatedName

public String getAbbrevatedName()

Description copied from interface: Granularity

Returns a shorter version of the granularity's name.

Specified by:

getAbbrevatedName in interface Granularity

Returns:

a String

toString

public String toString()

Overrides:

toString in class Object

getReprFormat

public Format getReprFormat()

getLongFormat

public DateFormat getLongFormat()

Specified by:

getLongFormat in interface Granularity

getLongDateFormatNoYear

public DateFormat getLongDateFormatNoYear()

getMediumFormat

public DateFormat getMediumFormat()

Specified by:

getMediumFormat in interface Granularity

getMediumDateFormatNoYear

public DateFormat getMediumDateFormatNoYear()

getShortFormat

public DateFormat getShortFormat()

Specified by:

getShortFormat in interface Granularity

getShortDateFormatNoYear

public DateFormat getShortDateFormatNoYear()

getTimeFormat

public DateFormat getTimeFormat()

earliest

public long earliest(long pos)

Specified by:

earliest in interface Granularity

latest

public long latest(long pos)

Specified by:

latest in interface Granularity

maximumDistance

public long maximumDistance(long position,
                            long distance,
                            Unit distanceUnit)

Specified by:

maximumDistance in interface Granularity

minimumDistance

public long minimumDistance(long position,
                            long distance,
                            Unit distanceUnit)

Specified by:

minimumDistance in interface Granularity

distance

public long distance(long start,
                     long finish,
                     Granularity finishGranularity,
                     Unit distanceUnit)

Description copied from interface: Granularity

Calculates the distance between two positions.

Specified by:

distance in interface Granularity

Returns:

compareTo

public int compareTo(Granularity o)

Specified by:

compareTo in interface Comparable<Granularity>

getCorrespondingUnit

public Unit getCorrespondingUnit()

Specified by:

getCorrespondingUnit in interface Granularity

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object