ilog.views.util.time

Class IlvTimeIncrementPolicy2.Year

java.lang.Object

ilog.views.util.time.IlvTimeIncrementPolicy.Year

ilog.views.util.time.IlvTimeIncrementPolicy2.Year

All Implemented Interfaces:

IlvTimeIncrementPolicy, IlvTimeIncrementPolicy2

Enclosing interface:

IlvTimeIncrementPolicy2

public static class IlvTimeIncrementPolicy2.Year
extends IlvTimeIncrementPolicy.Year
implements IlvTimeIncrementPolicy2

IlvTimeIncrementPolicy.Year implements a strategy for stepping through discrete year increments.

Since:

JViews 8.8

Nested Class Summary

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

IlvTimeIncrementPolicy2.Day, IlvTimeIncrementPolicy2.HalfDay, IlvTimeIncrementPolicy2.Hour, IlvTimeIncrementPolicy2.Minute, IlvTimeIncrementPolicy2.Month, IlvTimeIncrementPolicy2.Second, IlvTimeIncrementPolicy2.Week, IlvTimeIncrementPolicy2.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 ilog.views.util.time.IlvTimeIncrementPolicy.Year

decrementTime, floorTime, incrementTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.util.time.IlvTimeIncrementPolicy

decrementTime, floorTime, incrementTime

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.

Overrides:

getYearStep in class IlvTimeIncrementPolicy.Year

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.

Overrides:

setYearStep in class IlvTimeIncrementPolicy.Year

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 IlvTimeIncrementPolicy2

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 IlvTimeIncrementPolicy2

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 IlvTimeIncrementPolicy2

Parameters:

calendar - The calendar to decrement.