org.jfree.chart.axis
Class DateTickUnit

java.lang.Object
  |
  +--org.jfree.chart.axis.TickUnit
        |
        +--org.jfree.chart.axis.DateTickUnit

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class DateTickUnit

extends TickUnit

implements java.io.Serializable

A tick unit for use by subclasses of DateAxis. This class is immutable, a requirement for all tick units.

Author:

David Gilbert

See Also:

Serialized Form

Field Summary

static int	DAY A constant for days.
static int	HOUR A constant for hours.
static int	MILLISECOND A constant for milliseconds.
static int	MINUTE A constant for minutes.
static int	MONTH A constant for months.
static int	SECOND A constant for seconds.
static int	YEAR A constant for years.

Constructor Summary

DateTickUnit(int unit, int count)
Creates a new date tick unit.

DateTickUnit(int unit, int count, java.text.DateFormat formatter)
Creates a new date tick unit.

Method Summary

java.util.Date	addToDate(java.util.Date base) Calculates a new date by adding this unit to the base date.
java.lang.String	dateToString(java.util.Date date) Formats a date using the tick unit's formatter.
boolean	equals(java.lang.Object obj) Tests this unit for equality with another object.
int	getCalendarField() Returns a field code that can be used with the Calendar class.
int	getCount() Returns the unit count.
int	getUnit() Returns the date unit.
java.lang.String	valueToString(double milliseconds) Formats a value.

Methods inherited from class org.jfree.chart.axis.TickUnit

compareTo, getSize

Methods inherited from class java.lang.Object

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

Field Detail

YEAR

public static final int YEAR

A constant for years.

See Also:

Constant Field Values

MONTH

public static final int MONTH

A constant for months.

See Also:

Constant Field Values

DAY

public static final int DAY

A constant for days.

See Also:

Constant Field Values

HOUR

public static final int HOUR

A constant for hours.

See Also:

Constant Field Values

MINUTE

public static final int MINUTE

A constant for minutes.

See Also:

Constant Field Values

SECOND

public static final int SECOND

A constant for seconds.

See Also:

Constant Field Values

MILLISECOND

public static final int MILLISECOND

A constant for milliseconds.

See Also:

Constant Field Values

Constructor Detail

DateTickUnit

public DateTickUnit(int unit,
                    int count)

Creates a new date tick unit. The dates will be formatted using a SHORT format for the default locale.

Parameters:

unit - the unit.

count - the unit count.

DateTickUnit

public DateTickUnit(int unit,
                    int count,
                    java.text.DateFormat formatter)

Creates a new date tick unit.

You can specify the units using one of the constants YEAR, MONTH, DAY, HOUR, MINUTE, SECOND or MILLISECOND. In addition, you can specify a unit count, and a date format.

Parameters:

unit - the unit.

count - the unit count.

formatter - the date formatter.

Method Detail

getUnit

public int getUnit()

Returns the date unit. This will be one of the constants YEAR, MONTH, DAY, HOUR, MINUTE, SECOND or MILLISECOND, defined by this class. Note that these constants do NOT correspond to those defined in Java's Calendar class.

Returns:

the date unit.

getCount

public int getCount()

Returns the unit count.

Returns:

the unit count.

valueToString

public java.lang.String valueToString(double milliseconds)

Formats a value.

Overrides:

valueToString in class TickUnit

Parameters:

milliseconds - date in milliseconds since 01-01-1970.

Returns:

the formatted date.

dateToString

public java.lang.String dateToString(java.util.Date date)

Formats a date using the tick unit's formatter.

Parameters:

date - the date.

Returns:

the formatted date.

addToDate

public java.util.Date addToDate(java.util.Date base)

Calculates a new date by adding this unit to the base date.

Parameters:

base - the base date.

Returns:

a new date one unit after the base date.

getCalendarField

public int getCalendarField()

Returns a field code that can be used with the Calendar class.

Returns:

the field code.

equals

public boolean equals(java.lang.Object obj)

Tests this unit for equality with another object.

Overrides:

equals in class TickUnit

Parameters:

obj - the object.

Returns:

true or false.