Package org.jfree.chart.axis

Class DateTickUnit

java.lang.Object
org.jfree.chart.axis.TickUnit
org.jfree.chart.axis.DateTickUnit
All Implemented Interfaces:
Serializable, Comparable
public class DateTickUnit
extends TickUnit
implements 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 Description
    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

    Constructors
    Constructor Description
    DateTickUnit​(int unit, int count)
    Creates a new date tick unit.
    DateTickUnit​(int unit, int count, int rollUnit, int rollCount, DateFormat formatter)
    Creates a new unit.
    DateTickUnit​(int unit, int count, DateFormat formatter)
    Creates a new date tick unit.

  • Method Summary

    Modifier and Type Method Description
    Date addToDate​(Date base)
    Calculates a new date by adding this unit to the base date.
    String dateToString​(Date date)
    Formats a date using the tick unit's formatter.
    boolean equals​(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 getRollCount()
    Returns the roll count.
    int getRollUnit()
    Returns the roll unit.
    int getUnit()
    Returns the date unit.
    Date rollDate​(Date base)
    Rolls the date forward by the amount specified by the roll unit and count.
    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

    getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • 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 Details

    • 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.

    • 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.

    • getRollCount

      public int getRollCount()
      Returns the roll count.
      Returns:
      the roll count.

    • valueToString

      public 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 String dateToString​(Date date)
      Formats a date using the tick unit's formatter.
      Parameters:
      date - the date.
      Returns:
      the formatted date.

    • 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.

    • 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.

    • getCalendarField

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

    • equals

      public boolean equals​(Object obj)
      Tests this unit for equality with another object.
      Overrides:
      equals in class TickUnit
      Parameters:
      obj - the object.
      Returns:
      true or false.