ilog.views.util.time

Interface IlvTimeIncrementPolicy

All Known Subinterfaces:

IlvTimeIncrementPolicy2

All Known Implementing Classes:

IlvTimeIncrementPolicy.Day, IlvTimeIncrementPolicy.HalfDay, IlvTimeIncrementPolicy.Hour, IlvTimeIncrementPolicy.Minute, IlvTimeIncrementPolicy.Month, IlvTimeIncrementPolicy.Second, IlvTimeIncrementPolicy.Week, IlvTimeIncrementPolicy.Year, IlvTimeIncrementPolicy2.Day, IlvTimeIncrementPolicy2.HalfDay, IlvTimeIncrementPolicy2.Hour, IlvTimeIncrementPolicy2.Minute, IlvTimeIncrementPolicy2.Month, IlvTimeIncrementPolicy2.Second, IlvTimeIncrementPolicy2.Week, IlvTimeIncrementPolicy2.Year

public interface IlvTimeIncrementPolicy

IlvTimeIncrementPolicy defines a strategy for stepping through discrete time increments. An implementation of IlvTimeIncrementPolicy can be used to parameterize an IlvTimeIterator.

Since:

JViews 7.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IlvTimeIncrementPolicy.Day IlvTimeIncrementPolicy.Day implements a strategy for stepping through discrete day increments.
static class	IlvTimeIncrementPolicy.HalfDay IlvTimeIncrementPolicy.HalfDay implements a strategy for stepping through discrete half-day increments.
static class	IlvTimeIncrementPolicy.Hour IlvTimeIncrementPolicy.Hour implements a strategy for stepping through discrete hour increments.
static class	IlvTimeIncrementPolicy.Minute IlvTimeIncrementPolicy.Minute implements a strategy for stepping through discrete minute increments.
static class	IlvTimeIncrementPolicy.Month IlvTimeIncrementPolicy.Month implements a strategy for stepping through discrete month increments.
static class	IlvTimeIncrementPolicy.Second IlvTimeIncrementPolicy.Second implements a strategy for stepping through discrete second increments.
static class	IlvTimeIncrementPolicy.Week IlvTimeIncrementPolicy.Week implements a strategy for stepping through discrete week increments.
static class	IlvTimeIncrementPolicy.Year IlvTimeIncrementPolicy.Year implements a strategy for stepping through discrete year increments.

Method Summary

Modifier and Type	Method and Description
void	decrementTime(Calendar calendar) Decrements the given Calendar downwards to the previous time increment boundary.
void	floorTime(Calendar calendar) Truncates the given Calendar downwards to the nearest time increment boundary.
void	incrementTime(Calendar calendar) Increments the given Calendar upwards to the next time increment boundary.

Method Detail

floorTime

void floorTime(Calendar calendar)

Truncates the given Calendar downwards to the nearest time increment boundary. For example, in a minute-unit time increment policy, the floor time of January 14th, 2001, 8:12:34 is January 14th, 2001, 8:12:00 and the floor time of January 14th, 2001, 9:01:00 is January 14th, 2001, 9:01:00.

Parameters:

calendar - The calendar to floor.

incrementTime

void incrementTime(Calendar calendar)

Increments the given Calendar upwards to the next time increment boundary. It is assumed that the given Calendar is already on a time increment boundary, such as the result of calling floorTime(java.util.Calendar). If not, the results of this method are undefined.

Parameters:

calendar - The calendar to increment, which must be on a time increment boundary.

decrementTime

void decrementTime(Calendar calendar)

Decrements the given Calendar downwards to the previous time increment boundary. It is assumed that the given Calendar is already on a time increment boundary, such as the result of calling floorTime(java.util.Calendar). If not, the results of this method are undefined.

Parameters:

calendar - The calendar to decrement, which must be on a time increment boundary.