ilog.views.chart

Class IlvMultipleTimeUnit

java.lang.Object

ilog.views.chart.IlvTimeUnit

ilog.views.chart.IlvMultipleTimeUnit

All Implemented Interfaces:

Serializable

public class IlvMultipleTimeUnit
extends IlvTimeUnit

Represents a multiple of predefined time units. The IlvMultipleTimeUnit class is used to create instances that represents multiples of the following predefined time units: IlvTimeUnit.MILLISECOND, IlvTimeUnit.SECOND, IlvTimeUnit.MINUTE, IlvTimeUnit.HOUR, IlvTimeUnit.DAY, IlvTimeUnit.WEEK, IlvTimeUnit.MONTH, IlvTimeUnit.YEAR.

For example, the following code creates a time unit equal to 15 minutes:

     IlvTimeUnit unit = new IlvMultipleTimeUnit(IlvTimeUnit.MINUTE, 15);
 

Since:

JViews 5.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.IlvTimeUnit

CENTURY, DAY, DECADE, HOUR, MILLISECOND, MINUTE, MONTH, QUARTER, SECOND, WEEK, YEAR

Constructor Summary

Constructors

Constructor and Description
IlvMultipleTimeUnit(IlvTimeUnit baseUnit, int mult) Creates a multiple of the specified time unit.
IlvMultipleTimeUnit(IlvTimeUnit baseUnit, int mult, Date origin) Creates a multiple of the specified time unit.

Method Summary

Modifier and Type	Method and Description
String	getFormatString() Returns a string pattern used by the IlvTimeStepsDefinition class to create a java.util.SimpleDateFormat object.
String	getFormatString(Locale locale) Returns a string pattern used by the IlvTimeStepsDefinition class to create a java.util.SimpleDateFormat object.
double	getMillis() Returns the number of milliseconds corresponding to this unit.
Calendar	incrementTime(Calendar cal) Increments the specified time according to this unit.
Calendar	previousUnitTime(Calendar cal) Truncates the given Calendar downwards to the nearest multiple of this unit.
String	toString() Returns a string representation of this time unit.

Methods inherited from class ilog.views.chart.IlvTimeUnit

format, format

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMultipleTimeUnit

public IlvMultipleTimeUnit(IlvTimeUnit baseUnit,
                           int mult)
                    throws IllegalArgumentException

Creates a multiple of the specified time unit.

Parameters:

baseUnit - The base unit, which must be one of the following: IlvTimeUnit.MINUTE, IlvTimeUnit.HOUR, IlvTimeUnit.DAY, IlvTimeUnit.WEEK, IlvTimeUnit.MONTH and IlvTimeUnit.YEAR.

mult - The multiplier.

Throws:

IllegalArgumentException - If the multiplier is not strictly positive.

IllegalArgumentException - If the base unit is not supported.

IlvMultipleTimeUnit

public IlvMultipleTimeUnit(IlvTimeUnit baseUnit,
                           int mult,
                           Date origin)
                    throws IllegalArgumentException

Creates a multiple of the specified time unit.

Parameters:

baseUnit - The base unit, which must be one of the following: IlvTimeUnit.MINUTE, IlvTimeUnit.HOUR, IlvTimeUnit.DAY, IlvTimeUnit.WEEK, IlvTimeUnit.MONTH and IlvTimeUnit.YEAR.

mult - The multiplier.

origin - Origin time point. Useful when this time unit does not evenly divide the next bigger time unit, for example "7 hours" or "2 weeks" or "5 months". Can also be null.

Throws:

IllegalArgumentException - If the multiplier is not strictly positive.

IllegalArgumentException - If the base unit is not supported.

Since:

JViews 8.0

Method Detail

previousUnitTime

public Calendar previousUnitTime(Calendar cal)

Truncates the given Calendar downwards to the nearest multiple of this unit. The method modifies the cal parameter and returns it.

Specified by:

previousUnitTime in class IlvTimeUnit

Parameters:

cal - The considered time.

Returns:

The previous time according to this unit.

incrementTime

public Calendar incrementTime(Calendar cal)

Increments the specified time according to this unit. The method modifies the cal parameter and returns it.

Specified by:

incrementTime in class IlvTimeUnit

Parameters:

cal - The considered time.

Returns:

The incremented time.

getMillis

public double getMillis()

Returns the number of milliseconds corresponding to this unit.

Specified by:

getMillis in class IlvTimeUnit

getFormatString

public String getFormatString()

Returns a string pattern used by the IlvTimeStepsDefinition class to create a java.util.SimpleDateFormat object. The default implementation returns the string pattern of the base unit.

Specified by:

getFormatString in class IlvTimeUnit

getFormatString

public String getFormatString(Locale locale)

Returns a string pattern used by the IlvTimeStepsDefinition class to create a java.util.SimpleDateFormat object. The default implementation returns the string pattern of the base unit.

Overrides:

getFormatString in class IlvTimeUnit

Parameters:

locale - The locale of the chart.

Since:

JViews 8.8

toString

public String toString()

Returns a string representation of this time unit.

Overrides:

toString in class Object