org.protempa.proposition.value

Interface Granularity

All Superinterfaces:

Comparable<Granularity>, Serializable

All Known Implementing Classes:

AbsoluteTimeGranularity, RelativeDayGranularity, RelativeHourGranularity

public interface Granularity
extends Comparable<Granularity>, Serializable

The units for a proposition's temporal or spatial position, represented as the distance from some origin. Each unit has a "length" in an implied "base" unit. For example, for units representing absolute time, the base unit could be milliseconds since the epoch, and each unit would have a length in milliseconds. It extends Serializable because Propositions are serializable.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
long	distance(long start, long finish, Granularity finishGranularity, Unit distanceUnit) Calculates the distance between two positions.
long	earliest(long pos)
String	getAbbrevatedName() Returns a shorter version of the granularity's name.
Unit	getCorrespondingUnit()
Format	getLongFormat()
Format	getMediumFormat()
String	getName() Returns the granularity's singular name.
String	getPluralName() Returns the granularity's plural name.
Format	getShortFormat()
long	latest(long pos)
long	maximumDistance(long position, long distance, Unit distanceUnit)
long	minimumDistance(long position, long distance, Unit distanceUnit)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPluralName

String getPluralName()

Returns the granularity's plural name.

Returns:

a String

getName

String getName()

Returns the granularity's singular name.

Returns:

a String

getAbbrevatedName

String getAbbrevatedName()

Returns a shorter version of the granularity's name.

Returns:

a String

getLongFormat

Format getLongFormat()

getMediumFormat

Format getMediumFormat()

getShortFormat

Format getShortFormat()

earliest

long earliest(long pos)

latest

long latest(long pos)

minimumDistance

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

maximumDistance

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

distance

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

Calculates the distance between two positions.

Parameters:

start -

startGranularity -

finish -

finishGranularity -

Returns:

getCorrespondingUnit

Unit getCorrespondingUnit()