ilog.views.chart

Class IlvTimeUnit

java.lang.Object

ilog.views.chart.IlvTimeUnit

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvMultipleTimeUnit

public abstract class IlvTimeUnit
extends Object
implements Serializable

Represents a time unit used to compute the step values of a time scale.

The IlvTimeUnit class supports alternate locales by utilizing resource files to store format string associated with predefined time units.

Since:

JViews 5.0

See Also:

IlvTimeStepsDefinition.setUnit(ilog.views.chart.IlvTimeUnit), IlvCalendarUtil, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IlvTimeUnit	CENTURY Predefined unit for centuries.
static IlvTimeUnit	DAY Predefined unit for days.
static IlvTimeUnit	DECADE Predefined unit for decades.
static IlvTimeUnit	HOUR Predefined unit for hours.
static IlvTimeUnit	MILLISECOND Predefined unit for milliseconds.
static IlvTimeUnit	MINUTE Predefined unit for minutes.
static IlvTimeUnit	MONTH Predefined unit for months.
static IlvTimeUnit	QUARTER Predefined unit for quarters.
static IlvTimeUnit	SECOND Predefined unit for seconds.
static IlvTimeUnit	WEEK Predefined unit for weeks.
static IlvTimeUnit	YEAR Predefined unit for years.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvTimeUnit() Initializes a new time unit.

Method Summary

Modifier and Type	Method and Description
String	format(DateFormat fmt, Calendar cal) Deprecated. Starting with JViews 8.8, please use and implement the method format(DateFormat, Calendar, Locale) instead.
String	format(DateFormat fmt, Calendar cal, Locale locale) Returns the label corresponding to the specified time.
abstract String	getFormatString() Deprecated. Starting with JViews 8.8, please use and implement the method getFormatString(Locale) instead.
String	getFormatString(Locale locale) Returns a string pattern used by the IlvTimeStepsDefinition class.
abstract double	getMillis() Returns the number of milliseconds corresponding to this unit.
abstract Calendar	incrementTime(Calendar cal) Increments the specified time according to this unit.
abstract Calendar	previousUnitTime(Calendar cal) Truncates the given Calendar downwards to the nearest multiple of this unit.

Methods inherited from class java.lang.Object

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

Field Detail

MILLISECOND

public static final IlvTimeUnit MILLISECOND

Predefined unit for milliseconds.

Since:

JViews 7.5

SECOND

public static final IlvTimeUnit SECOND

Predefined unit for seconds.

Since:

JViews 5.5

MINUTE

public static final IlvTimeUnit MINUTE

Predefined unit for minutes.

HOUR

public static final IlvTimeUnit HOUR

Predefined unit for hours.

DAY

public static final IlvTimeUnit DAY

Predefined unit for days.

WEEK

public static final IlvTimeUnit WEEK

Predefined unit for weeks.

MONTH

public static final IlvTimeUnit MONTH

Predefined unit for months.

QUARTER

public static final IlvTimeUnit QUARTER

Predefined unit for quarters.

YEAR

public static final IlvTimeUnit YEAR

Predefined unit for years.

DECADE

public static final IlvTimeUnit DECADE

Predefined unit for decades.

CENTURY

public static final IlvTimeUnit CENTURY

Predefined unit for centuries.

Constructor Detail

IlvTimeUnit

protected IlvTimeUnit()

Initializes a new time unit.

Method Detail

previousUnitTime

public abstract 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.

Parameters:

cal - The considered time.

Returns:

The previous time according to this unit.

incrementTime

public abstract Calendar incrementTime(Calendar cal)

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

Parameters:

cal - The considered time.

Returns:

The incremented time.

getMillis

public abstract double getMillis()

Returns the number of milliseconds corresponding to this unit.

getFormatString

@Deprecated
public abstract String getFormatString()

Deprecated. Starting with JViews 8.8, please use and implement the method getFormatString(Locale) instead.

Returns a string pattern used by the IlvTimeStepsDefinition class. It should be a pattern that obeys the syntax for a SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat.

getFormatString

public String getFormatString(Locale locale)

Returns a string pattern used by the IlvTimeStepsDefinition class. It should be a pattern that obeys the syntax for a SimpleDateFormat or com.ibm.icu.text.SimpleDateFormat.

Parameters:

locale - The locale of the chart.

Since:

JViews 8.8

format

@Deprecated
public String format(DateFormat fmt,
                                 Calendar cal)

Deprecated. Starting with JViews 8.8, please use and implement the method format(DateFormat, Calendar, Locale) instead.

Returns the label corresponding to the specified time.

Parameters:

fmt - The default date format used by the IlvTimeStepsDefinition class. This format is created according to the string pattern returned by getFormatString().

cal - The considered time.

Returns:

A string representation of the specified time.

format

public String format(DateFormat fmt,
                     Calendar cal,
                     Locale locale)

Returns the label corresponding to the specified time.

Parameters:

fmt - The default date format used by the IlvTimeStepsDefinition class. This format is created according to the string pattern returned by getFormatString().

cal - The considered time.

locale - The locale of the chart.

Returns:

A string representation of the specified time.

Since:

JViews 8.8