org.jfree.chart.axis

Class DateTickUnit

java.lang.Object

org.jfree.chart.axis.TickUnit

org.jfree.chart.axis.DateTickUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class DateTickUnit
extends TickUnit
implements java.io.Serializable

A tick unit for use by subclasses of DateAxis. Instances of this class are immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	count The unit count.
static int	DAY Deprecated. As of version 1.0.13, use DateTickUnitType instead.
private java.text.DateFormat	formatter The date formatter.
static int	HOUR Deprecated. As of version 1.0.13, use DateTickUnitType instead.
static int	MILLISECOND Deprecated. As of version 1.0.13, use DateTickUnitType instead.
static int	MINUTE Deprecated. As of version 1.0.13, use DateTickUnitType instead.
static int	MONTH Deprecated. As of version 1.0.13, use DateTickUnitType instead.
private int	rollCount The roll count.
private int	rollUnit Deprecated. As of version 1.0.13, use the rollUnitType field.
private DateTickUnitType	rollUnitType The roll unit type.
static int	SECOND Deprecated. As of version 1.0.13, use DateTickUnitType instead.
private static long	serialVersionUID For serialization.
private int	unit Deprecated. As of version 1.0.13, use the unitType field.
private DateTickUnitType	unitType The units.
static int	YEAR Deprecated. As of version 1.0.13, use DateTickUnitType instead.

Constructor Summary

Constructors

Constructor and Description
DateTickUnit(DateTickUnitType unitType, int multiple) Creates a new date tick unit.
DateTickUnit(DateTickUnitType unitType, int multiple, java.text.DateFormat formatter) Creates a new date tick unit.
DateTickUnit(DateTickUnitType unitType, int multiple, DateTickUnitType rollUnitType, int rollMultiple, java.text.DateFormat formatter) Creates a new unit.
DateTickUnit(int unit, int count) Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int).
DateTickUnit(int unit, int count, java.text.DateFormat formatter) Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int, DateFormat).
DateTickUnit(int unit, int count, int rollUnit, int rollCount, java.text.DateFormat formatter) Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int, DateTickUnitType, int, DateFormat).

Method Summary

Modifier and Type	Method and Description
java.util.Date	addToDate(java.util.Date base) Deprecated. As of JFreeChart 1.0.10, this method is deprecated - you should use addToDate(Date, TimeZone) instead.
java.util.Date	addToDate(java.util.Date base, java.util.TimeZone zone) 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() Deprecated. As of version 1.0.13, use getMultiple().
private static long	getMillisecondCount(DateTickUnitType unit, int count) Returns the (approximate) number of milliseconds for the given unit and unit count.
int	getMultiple() Returns the unit multiple.
int	getRollCount() Deprecated. As of version 1.0.13, use the getRollMultiple()
int	getRollMultiple() Returns the roll unit multiple.
int	getRollUnit() Deprecated. As of version 1.0.13, use getRollUnitType().
DateTickUnitType	getRollUnitType() Returns the roll unit type.
int	getUnit() Deprecated. As of 1.0.13, use the getUnitType() method.
DateTickUnitType	getUnitType() Returns the unit type.
int	hashCode() Returns a hash code for this object.
private static DateTickUnitType	intToUnitType(int unit) A utility method that is used internally to convert the old unit constants into the corresponding enumerated value.
private static java.text.DateFormat	notNull(java.text.DateFormat formatter) A utility method to put a default in place if a null formatter is supplied.
java.util.Date	rollDate(java.util.Date base) Rolls the date forward by the amount specified by the roll unit and count.
java.util.Date	rollDate(java.util.Date base, java.util.TimeZone zone) Rolls the date forward by the amount specified by the roll unit and count.
java.lang.String	toString() Returns a string representation of this instance, primarily used for debugging purposes.
private static int	unitTypeToInt(DateTickUnitType unitType) Converts a unit type to the corresponding deprecated integer constant.
java.lang.String	valueToString(double milliseconds) Formats a value.

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

compareTo, getMinorTickCount, getSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

Constant Field Values

unitType

private DateTickUnitType unitType

The units.

Since:

1.0.13

count

private int count

The unit count.

rollUnitType

private DateTickUnitType rollUnitType

The roll unit type.

Since:

1.0.13

rollCount

private int rollCount

The roll count.

formatter

private java.text.DateFormat formatter

The date formatter.

YEAR

public static final int YEAR

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for years.

See Also:

Constant Field Values

MONTH

public static final int MONTH

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for months.

See Also:

Constant Field Values

DAY

public static final int DAY

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for days.

See Also:

Constant Field Values

HOUR

public static final int HOUR

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for hours.

See Also:

Constant Field Values

MINUTE

public static final int MINUTE

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for minutes.

See Also:

Constant Field Values

SECOND

public static final int SECOND

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for seconds.

See Also:

Constant Field Values

MILLISECOND

public static final int MILLISECOND

Deprecated. As of version 1.0.13, use DateTickUnitType instead.

A constant for milliseconds.

See Also:

Constant Field Values

unit

private int unit

Deprecated. As of version 1.0.13, use the unitType field.

The unit.

rollUnit

private int rollUnit

Deprecated. As of version 1.0.13, use the rollUnitType field.

The roll unit.

Constructor Detail

DateTickUnit

public DateTickUnit(DateTickUnitType unitType,
                    int multiple)

Creates a new date tick unit.

Parameters:

unitType - the unit type (null not permitted).

multiple - the multiple (of the unit type, must be > 0).

Since:

1.0.13

DateTickUnit

public DateTickUnit(DateTickUnitType unitType,
                    int multiple,
                    java.text.DateFormat formatter)

Creates a new date tick unit.

Parameters:

unitType - the unit type (null not permitted).

multiple - the multiple (of the unit type, must be > 0).

formatter - the date formatter (null not permitted).

Since:

1.0.13

DateTickUnit

public DateTickUnit(DateTickUnitType unitType,
                    int multiple,
                    DateTickUnitType rollUnitType,
                    int rollMultiple,
                    java.text.DateFormat formatter)

Creates a new unit.

Parameters:

unitType - the unit.

multiple - the multiple.

rollUnitType - the roll unit.

rollMultiple - the roll multiple.

formatter - the date formatter (null not permitted).

Since:

1.0.13

DateTickUnit

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

Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int, DateFormat).

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 (defaults to DateFormat.SHORT).

DateTickUnit

public DateTickUnit(int unit,
                    int count)

Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int).

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,
                    int rollUnit,
                    int rollCount,
                    java.text.DateFormat formatter)

Deprecated. As of version 1.0.13, use DateTickUnit( DateTickUnitType, int, DateTickUnitType, int, DateFormat).

Creates a new unit.

Parameters:

unit - the unit.

count - the count.

rollUnit - the roll unit.

rollCount - the roll count.

formatter - the date formatter (defaults to DateFormat.SHORT).

Method Detail

getUnitType

public DateTickUnitType getUnitType()

Returns the unit type.

Returns:

The unit type (never null).

Since:

1.0.13

getMultiple

public int getMultiple()

Returns the unit multiple.

Returns:

The unit multiple (always > 0).

getRollUnitType

public DateTickUnitType getRollUnitType()

Returns the roll unit type.

Returns:

The roll unit type (never null).

Since:

1.0.13

getRollMultiple

public int getRollMultiple()

Returns the roll unit multiple.

Returns:

The roll unit multiple.

Since:

1.0.13

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,
                                java.util.TimeZone zone)

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

Parameters:

base - the base date.

zone - the time zone for the date calculation.

Returns:

A new date one unit after the base date.

Since:

1.0.6

rollDate

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

Rolls the date forward by the amount specified by the roll unit and count.

Parameters:

base - the base date.

Returns:

The rolled date.

See Also:

rollDate(Date, TimeZone)

rollDate

public java.util.Date rollDate(java.util.Date base,
                               java.util.TimeZone zone)

Rolls the date forward by the amount specified by the roll unit and count.

Parameters:

base - the base date.

zone - the time zone.

Returns:

The rolled date.

Since:

1.0.6

getCalendarField

public int getCalendarField()

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

Returns:

The field code.

getMillisecondCount

private static long getMillisecondCount(DateTickUnitType unit,
                                        int count)

Returns the (approximate) number of milliseconds for the given unit and unit count.

This value is an approximation some of the time (e.g. months are assumed to have 31 days) but this shouldn't matter.

Parameters:

unit - the unit.

count - the unit count.

Returns:

The number of milliseconds.

Since:

1.0.13

intToUnitType

private static DateTickUnitType intToUnitType(int unit)

A utility method that is used internally to convert the old unit constants into the corresponding enumerated value.

Parameters:

unit - the unit specified using the deprecated integer codes.

Returns:

The unit type.

Since:

1.0.13

unitTypeToInt

private static int unitTypeToInt(DateTickUnitType unitType)

Converts a unit type to the corresponding deprecated integer constant.

Parameters:

unitType - the unit type (null not permitted).

Returns:

The int code.

Since:

1.0.13

notNull

private static java.text.DateFormat notNull(java.text.DateFormat formatter)

A utility method to put a default in place if a null formatter is supplied.

Parameters:

formatter - the formatter (null permitted).

Returns:

The formatter if it is not null, otherwise a default.

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 (null permitted).

Returns:

true or false.

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class TickUnit

Returns:

A hash code.

toString

public java.lang.String toString()

Returns a string representation of this instance, primarily used for debugging purposes.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this instance.

getUnit

public int getUnit()

Deprecated. As of 1.0.13, use the getUnitType() method.

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()

Deprecated. As of version 1.0.13, use getMultiple().

Returns the unit count.

Returns:

The unit count.

getRollUnit

public int getRollUnit()

Deprecated. As of version 1.0.13, use getRollUnitType().

Returns the roll unit. This is the amount by which the tick advances if it is "hidden" when displayed on a segmented date axis. Typically the roll will be smaller than the regular tick unit (for example, a 7 day tick unit might use a 1 day roll).

Returns:

The roll unit.

getRollCount

public int getRollCount()

Deprecated. As of version 1.0.13, use the getRollMultiple()

Returns the roll count.

Returns:

The roll count.

addToDate

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

Deprecated. As of JFreeChart 1.0.10, this method is deprecated - you should use addToDate(Date, TimeZone) instead.

Calculates a new date by adding this unit to the base date, with calculations performed in the default timezone and locale.

Parameters:

base - the base date.

Returns:

A new date one unit after the base date.

See Also:

addToDate(Date, TimeZone)