org.protempa.proposition.value

Class RelativeHourGranularity

java.lang.Object

org.protempa.proposition.value.RelativeHourGranularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>, Granularity

public class RelativeHourGranularity
extends Object
implements Granularity

Defines units of relative time. The getName method provides a unique String for the unit. The base length is milliseconds.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static RelativeHourGranularity	HOUR

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.
int	getCalendarUnits()
Unit	getCorrespondingUnit()
long	getLength()
Format	getLongFormat()
Format	getMediumFormat()
String	getName() Returns the granularity's singular name.
String	getPluralName() Returns the granularity's plural name.
Format	getShortFormat()
int	hashCode()
long	latest(long pos)
long	lengthInBaseUnit(long length)
long	maximumDistance(long position, long distance, Unit distanceUnit)
long	minimumDistance(long position, long distance, Unit distanceUnit)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HOUR

public static final RelativeHourGranularity HOUR

Method Detail

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

getLongFormat

public Format getLongFormat()

Specified by:

getLongFormat in interface Granularity

getMediumFormat

public Format getMediumFormat()

Specified by:

getMediumFormat in interface Granularity

getShortFormat

public Format getShortFormat()

Specified by:

getShortFormat in interface Granularity

getLength

public long getLength()

getCalendarUnits

public int getCalendarUnits()

lengthInBaseUnit

public long lengthInBaseUnit(long length)

toString

public String toString()

Overrides:

toString in class Object

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