ilog.views.util.time

Class IlvTimeIncrementPolicy.Week

java.lang.Object

ilog.views.util.time.IlvTimeIncrementPolicy.Week

All Implemented Interfaces:

IlvTimeIncrementPolicy

Direct Known Subclasses:

IlvTimeIncrementPolicy2.Week

Enclosing interface:

IlvTimeIncrementPolicy

public static class IlvTimeIncrementPolicy.Week
extends Object
implements IlvTimeIncrementPolicy

IlvTimeIncrementPolicy.Week implements a strategy for stepping through discrete week 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
Week() Creates a new IlvTimeIncrementPolicy.Week policy.

Method Summary

Modifier and Type	Method and Description
void	decrementTime(Calendar calendar) Decrements the given Calendar downwards by weekStep weeks.
void	floorTime(Calendar calendar) Truncates the given Calendar downwards to the nearest weekStep week boundary.
int	getWeekStep() Returns the number of weeks in a step increment.
void	incrementTime(Calendar calendar) Increments the given Calendar upwards by weekStep weeks.
void	setWeekStep(int weekStep) Sets the number of weeks in a step increment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Week

public Week()

Creates a new IlvTimeIncrementPolicy.Week policy.

Method Detail

getWeekStep

public int getWeekStep()

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

Returns:

The number of weeks in a step increment.

See Also:

setWeekStep(int)

setWeekStep

public void setWeekStep(int weekStep)

Sets the number of weeks in a step increment.

Parameters:

weekStep - The number of weeks in a step increment.

See Also:

getWeekStep()

floorTime

public void floorTime(Calendar calendar)

Truncates the given Calendar downwards to the nearest weekStep week 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 weekStep weeks.

Specified by:

incrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to increment.

decrementTime

public void decrementTime(Calendar calendar)

Decrements the given Calendar downwards by weekStep weeks.

Specified by:

decrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to decrement.