org.jfree.chart.axis

Class DateTickUnit

public class DateTickUnit extends TickUnit implements Serializable

A tick unit for use by subclasses of DateAxis. Instances of this class are immutable.
Field Summary
static intDAY
A constant for days.
static intHOUR
A constant for hours.
static intMILLISECOND
A constant for milliseconds.
static intMINUTE
A constant for minutes.
static intMONTH
A constant for months.
static intSECOND
A constant for seconds.
static intYEAR
A constant for years.
Constructor Summary
DateTickUnit(int unit, int count)
Creates a new date tick unit.
DateTickUnit(int unit, int count, DateFormat formatter)
Creates a new date tick unit.
DateTickUnit(int unit, int count, int rollUnit, int rollCount, DateFormat formatter)
Creates a new unit.
Method Summary
DateaddToDate(Date base)
Calculates a new date by adding this unit to the base date.
StringdateToString(Date date)
Formats a date using the tick unit's formatter.
booleanequals(Object obj)
Tests this unit for equality with another object.
intgetCalendarField()
Returns a field code that can be used with the Calendar class.
intgetCount()
Returns the unit count.
intgetRollCount()
Returns the roll count.
intgetRollUnit()
Returns the roll unit.
intgetUnit()
Returns the date unit.
inthashCode()
Returns a hash code for this object.
DaterollDate(Date base)
Rolls the date forward by the amount specified by the roll unit and count.
StringtoString()
Returns a string representation of this instance, primarily used for debugging purposes.
StringvalueToString(double milliseconds)
Formats a value.

Field Detail

DAY

public static final int DAY
A constant for days.

HOUR

public static final int HOUR
A constant for hours.

MILLISECOND

public static final int MILLISECOND
A constant for milliseconds.

MINUTE

public static final int MINUTE
A constant for minutes.

MONTH

public static final int MONTH
A constant for months.

SECOND

public static final int SECOND
A constant for seconds.

YEAR

public static final int YEAR
A constant for years.

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

DateTickUnit

public DateTickUnit(int unit, int count, int rollUnit, int rollCount, DateFormat formatter)
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

addToDate

public Date addToDate(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.

dateToString

public String dateToString(Date date)
Formats a date using the tick unit's formatter.

Parameters: date the date.

Returns: The formatted date.

equals

public boolean equals(Object obj)
Tests this unit for equality with another object.

Parameters: obj the object (null permitted).

Returns: true or false.

getCalendarField

public int getCalendarField()
Returns a field code that can be used with the Calendar class.

Returns: The field code.

getCount

public int getCount()
Returns the unit count.

Returns: The unit count.

getRollCount

public int getRollCount()
Returns the roll count.

Returns: The roll count.

getRollUnit

public int getRollUnit()
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.

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.

hashCode

public int hashCode()
Returns a hash code for this object.

Returns: A hash code.

rollDate

public Date rollDate(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.

toString

public String toString()
Returns a string representation of this instance, primarily used for debugging purposes.

Returns: A string representation of this instance.

valueToString

public String valueToString(double milliseconds)
Formats a value.

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

Returns: The formatted date.