ilog.views.util.time

Class IlvTimeIncrementPolicy.Year

java.lang.Object

ilog.views.util.time.IlvTimeIncrementPolicy.Year

All Implemented Interfaces:

IlvTimeIncrementPolicy

Direct Known Subclasses:

IlvTimeIncrementPolicy2.Year

Enclosing interface:

IlvTimeIncrementPolicy

public static class IlvTimeIncrementPolicy.Year
extends Object
implements IlvTimeIncrementPolicy

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

Method Summary

Modifier and Type	Method and Description
void	decrementTime(Calendar calendar) Decrements the given Calendar downwards by yearStep years.
void	floorTime(Calendar calendar) Truncates the given Calendar downwards to the nearest yearStep year boundary.
int	getYearStep() Returns the number of years in a step increment.
void	incrementTime(Calendar calendar) Increments the given Calendar upwards by yearStep years.
void	setYearStep(int yearStep) Sets the number of years in a step increment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Year

public Year()

Creates a new IlvTimeIncrementPolicy.Year policy.

Method Detail

getYearStep

public int getYearStep()

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

Returns:

The number of years in a step increment.

See Also:

setYearStep(int)

setYearStep

public void setYearStep(int yearStep)

Sets the number of years in a step increment.

Parameters:

yearStep - The number of years in a step increment.

See Also:

getYearStep()

floorTime

public void floorTime(Calendar calendar)

Truncates the given Calendar downwards to the nearest yearStep year 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 yearStep years.

Specified by:

incrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to increment.

decrementTime

public void decrementTime(Calendar calendar)

Decrements the given Calendar downwards by yearStep years.

Specified by:

decrementTime in interface IlvTimeIncrementPolicy

Parameters:

calendar - The calendar to decrement.