ilog.views.util.time

Class IlvTimeIncrementPolicy.Month

java.lang.Object

ilog.views.util.time.IlvTimeIncrementPolicy.Month

All Implemented Interfaces:

IlvTimeIncrementPolicy

Direct Known Subclasses:

IlvTimeIncrementPolicy2.Month

Enclosing interface:

IlvTimeIncrementPolicy

public static class IlvTimeIncrementPolicy.Month
extends Object
implements IlvTimeIncrementPolicy

IlvTimeIncrementPolicy.Month implements a strategy for stepping through discrete month increments.

Since:

JViews 7.5

Nested Class Summary

Nested classes/interfaces inherited from interface ilog.views.util.time.IlvTimeIncrementPolicy

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

Constructor Summary

Constructors

Constructor and Description
Month() Creates a new IlvTimeIncrementPolicy.Month policy.

Method Summary

Modifier and Type	Method and Description
void	decrementTime(Calendar calendar) Decrements the given Calendar downwards by monthStep months.
void	floorTime(Calendar calendar) Truncates the given Calendar downwards to the nearest monthStep month boundary.
int	getMonthStep() Returns the number of months in a step increment.
void	incrementTime(Calendar calendar) Increments the given Calendar upwards by monthStep months.
void	setMonthStep(int monthStep) Sets the number of months in a step increment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Month

public Month()

Creates a new IlvTimeIncrementPolicy.Month policy.

Method Detail

getMonthStep

public int getMonthStep()

Returns the number of months in a step increment. The default value is 1.

Returns:

The number of months in a step increment.

See Also:

setMonthStep(int)

setMonthStep

public void setMonthStep(int monthStep)

Sets the number of months in a step increment.

Parameters:

monthStep - The number of months in a step increment.

See Also:

getMonthStep()

floorTime

public void floorTime(Calendar calendar)

Truncates the given Calendar downwards to the nearest monthStep month boundary.

Specified by:

floorTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to floor.

incrementTime

public void incrementTime(Calendar calendar)

Increments the given Calendar upwards by monthStep months.

Specified by:

incrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to increment.

decrementTime

public void decrementTime(Calendar calendar)

Decrements the given Calendar downwards by monthStep months.

Specified by:

decrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to decrement.