org.jfree.data.time.Day Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D API, it supports a wide range of chart types including
bar charts, pie charts, line charts, XY-plots, time series plots, Sankey charts
and more.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-present, by David Gilbert and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* --------
* Day.java
* --------
* (C) Copyright 2001-present, by David Gilbert.
*
* Original Author: David Gilbert;
* Contributor(s): -;
*
*/
package org.jfree.data.time;
import java.io.Serializable;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.*;
import org.jfree.chart.date.SerialDate;
import org.jfree.chart.util.Args;
/**
* Represents a single day in the range 1-Jan-1900 to 31-Dec-9999. This class
* is immutable, which is a requirement for all {@link RegularTimePeriod}
* subclasses.
*/
public class Day extends RegularTimePeriod implements Serializable {
/** For serialization. */
private static final long serialVersionUID = -7082667380758962755L;
/** A standard date formatter. */
protected static final DateFormat DATE_FORMAT
= new SimpleDateFormat("yyyy-MM-dd");
/** A date formatter for the default locale. */
protected static final DateFormat DATE_FORMAT_SHORT
= DateFormat.getDateInstance(DateFormat.SHORT);
/** A date formatter for the default locale. */
protected static final DateFormat DATE_FORMAT_MEDIUM
= DateFormat.getDateInstance(DateFormat.MEDIUM);
/** A date formatter for the default locale. */
protected static final DateFormat DATE_FORMAT_LONG
= DateFormat.getDateInstance(DateFormat.LONG);
/** The day (uses SerialDate for convenience). */
private SerialDate serialDate;
/** The first millisecond. */
private long firstMillisecond;
/** The last millisecond. */
private long lastMillisecond;
/**
* Creates a new instance, derived from the system date/time.
* The time zone and locale are determined by the calendar
* returned by {@link RegularTimePeriod#getCalendarInstance()}.
*/
public Day() {
this(new Date());
}
/**
* Constructs a new one day time period.
* The time zone and locale are determined by the calendar
* returned by {@link RegularTimePeriod#getCalendarInstance()}.
*
* @param day the day-of-the-month.
* @param month the month (1 to 12).
* @param year the year (1900 <= year <= 9999).
*/
public Day(int day, int month, int year) {
this.serialDate = SerialDate.createInstance(day, month, year);
peg(getCalendarInstance());
}
/**
* Constructs a new one day time period.
* The time zone and locale are determined by the calendar
* returned by {@link RegularTimePeriod#getCalendarInstance()}.
*
* @param serialDate the day ({@code null} not permitted).
*/
public Day(SerialDate serialDate) {
Args.nullNotPermitted(serialDate, "serialDate");
this.serialDate = serialDate;
peg(getCalendarInstance());
}
/**
* Constructs a new instance, based on a particular date/time.
* The time zone and locale are determined by the calendar
* returned by {@link RegularTimePeriod#getCalendarInstance()}.
*
* @param time the time ({@code null} not permitted).
*
* @see #Day(Date, TimeZone, Locale)
*/
public Day(Date time) {
// defer argument checking...
this(time, getCalendarInstance());
}
/**
* Constructs a new instance, based on a particular date/time and time zone.
*
* @param time the date/time ({@code null} not permitted).
* @param zone the time zone ({@code null} not permitted).
* @param locale the locale ({@code null} not permitted).
*/
public Day(Date time, TimeZone zone, Locale locale) {
Args.nullNotPermitted(time, "time");
Args.nullNotPermitted(zone, "zone");
Args.nullNotPermitted(locale, "locale");
Calendar calendar = Calendar.getInstance(zone, locale);
calendar.setTime(time);
initUsing(calendar);
peg(calendar);
}
/**
* Constructs a new instance, based on a particular date/time.
* The time zone and locale are determined by the {@code calendar}
* parameter.
*
* @param time the date/time ({@code null} not permitted).
* @param calendar the calendar to use for calculations ({@code null} not permitted).
*/
public Day(Date time, Calendar calendar) {
Args.nullNotPermitted(time, "time");
Args.nullNotPermitted(calendar, "calendar");
calendar.setTime(time);
initUsing(calendar);
peg(calendar);
}
private void initUsing(Calendar calendar) {
int d = calendar.get(Calendar.DAY_OF_MONTH);
int m = calendar.get(Calendar.MONTH) + 1;
int y = calendar.get(Calendar.YEAR);
this.serialDate = SerialDate.createInstance(d, m, y);
}
/**
* Returns the day as a {@link SerialDate}. Note: the reference that is
* returned should be an instance of an immutable {@link SerialDate}
* (otherwise the caller could use the reference to alter the state of
* this {@code Day} instance, and {@code Day} is supposed
* to be immutable).
*
* @return The day as a {@link SerialDate}.
*/
public SerialDate getSerialDate() {
return this.serialDate;
}
/**
* Returns the year.
*
* @return The year.
*/
public int getYear() {
return this.serialDate.getYYYY();
}
/**
* Returns the month.
*
* @return The month.
*/
public int getMonth() {
return this.serialDate.getMonth();
}
/**
* Returns the day of the month.
*
* @return The day of the month.
*/
public int getDayOfMonth() {
return this.serialDate.getDayOfMonth();
}
/**
* Returns the first millisecond of the day. This will be determined
* relative to the time zone specified in the constructor, or in the
* calendar instance passed in the most recent call to the
* {@link #peg(Calendar)} method.
*
* @return The first millisecond of the day.
*
* @see #getLastMillisecond()
*/
@Override
public long getFirstMillisecond() {
return this.firstMillisecond;
}
/**
* Returns the last millisecond of the day. This will be
* determined relative to the time zone specified in the constructor, or
* in the calendar instance passed in the most recent call to the
* {@link #peg(Calendar)} method.
*
* @return The last millisecond of the day.
*
* @see #getFirstMillisecond()
*/
@Override
public long getLastMillisecond() {
return this.lastMillisecond;
}
/**
* Recalculates the start date/time and end date/time for this time period
* relative to the supplied calendar (which incorporates a time zone).
*
* @param calendar the calendar ({@code null} not permitted).
*/
@Override
public void peg(Calendar calendar) {
this.firstMillisecond = getFirstMillisecond(calendar);
this.lastMillisecond = getLastMillisecond(calendar);
}
/**
* Returns the day preceding this one.
* No matter what time zone and locale this instance was created with,
* the returned instance will use the default calendar for time
* calculations, obtained with {@link RegularTimePeriod#getCalendarInstance()}.
*
* @return The day preceding this one.
*/
@Override
public RegularTimePeriod previous() {
Day result;
int serial = this.serialDate.toSerial();
if (serial > SerialDate.SERIAL_LOWER_BOUND) {
SerialDate yesterday = SerialDate.createInstance(serial - 1);
return new Day(yesterday);
}
else {
result = null;
}
return result;
}
/**
* Returns the day following this one, or {@code null} if some limit
* has been reached.
* No matter what time zone and locale this instance was created with,
* the returned instance will use the default calendar for time
* calculations, obtained with {@link RegularTimePeriod#getCalendarInstance()}.
*
* @return The day following this one, or {@code null} if some limit
* has been reached.
*/
@Override
public RegularTimePeriod next() {
Day result;
int serial = this.serialDate.toSerial();
if (serial < SerialDate.SERIAL_UPPER_BOUND) {
SerialDate tomorrow = SerialDate.createInstance(serial + 1);
return new Day(tomorrow);
}
else {
result = null;
}
return result;
}
/**
* Returns a serial index number for the day.
*
* @return The serial index number.
*/
@Override
public long getSerialIndex() {
return this.serialDate.toSerial();
}
/**
* Returns the first millisecond of the day, evaluated using the supplied
* calendar (which determines the time zone).
*
* @param calendar calendar to use ({@code null} not permitted).
*
* @return The start of the day as milliseconds since 01-01-1970.
*
* @throws NullPointerException if {@code calendar} is
* {@code null}.
*/
@Override
public long getFirstMillisecond(Calendar calendar) {
int year = this.serialDate.getYYYY();
int month = this.serialDate.getMonth();
int day = this.serialDate.getDayOfMonth();
calendar.clear();
calendar.set(year, month - 1, day, 0, 0, 0);
calendar.set(Calendar.MILLISECOND, 0);
return calendar.getTimeInMillis();
}
/**
* Returns the last millisecond of the day, evaluated using the supplied
* calendar (which determines the time zone).
*
* @param calendar calendar to use ({@code null} not permitted).
*
* @return The end of the day as milliseconds since 01-01-1970.
*
* @throws NullPointerException if {@code calendar} is
* {@code null}.
*/
@Override
public long getLastMillisecond(Calendar calendar) {
int year = this.serialDate.getYYYY();
int month = this.serialDate.getMonth();
int day = this.serialDate.getDayOfMonth();
calendar.clear();
calendar.set(year, month - 1, day, 23, 59, 59);
calendar.set(Calendar.MILLISECOND, 999);
return calendar.getTimeInMillis();
}
/**
* Tests the equality of this Day object to an arbitrary object. Returns
* true if the target is a Day instance or a SerialDate instance
* representing the same day as this object. In all other cases,
* returns false.
*
* @param obj the object ({@code null} permitted).
*
* @return A flag indicating whether or not an object is equal to this day.
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof Day)) {
return false;
}
Day that = (Day) obj;
if (!this.serialDate.equals(that.getSerialDate())) {
return false;
}
return true;
}
/**
* Returns a hash code for this object instance. The approach described by
* Joshua Bloch in "Effective Java" has been used here:
*
* {@code http://developer.java.sun.com/developer/Books/effectivejava
* /Chapter3.pdf}
*
* @return A hash code.
*/
@Override
public int hashCode() {
return this.serialDate.hashCode();
}
/**
* Returns an integer indicating the order of this Day object relative to
* the specified object:
*
* negative == before, zero == same, positive == after.
*
* @param o1 the object to compare.
*
* @return negative == before, zero == same, positive == after.
*/
@Override
public int compareTo(Object o1) {
int result;
// CASE 1 : Comparing to another Day object
// ----------------------------------------
if (o1 instanceof Day) {
Day d = (Day) o1;
result = -d.getSerialDate().compare(this.serialDate);
}
// CASE 2 : Comparing to another TimePeriod object
// -----------------------------------------------
else if (o1 instanceof RegularTimePeriod) {
// more difficult case - evaluate later...
result = 0;
}
// CASE 3 : Comparing to a non-TimePeriod object
// ---------------------------------------------
else {
// consider time periods to be ordered after general objects
result = 1;
}
return result;
}
/**
* Returns a string representing the day.
*
* @return A string representing the day.
*/
@Override
public String toString() {
return this.serialDate.toString();
}
/**
* Parses the string argument as a day.
*
* This method is required to recognise YYYY-MM-DD as a valid format.
* Anything else, for now, is a bonus.
*
* @param s the date string to parse.
*
* @return {@code null} if the string does not contain any parseable
* string, the day otherwise.
*/
public static Day parseDay(String s) {
try {
return new Day (Day.DATE_FORMAT.parse(s));
}
catch (ParseException e1) {
try {
return new Day (Day.DATE_FORMAT_SHORT.parse(s));
}
catch (ParseException e2) {
// ignore
}
}
return null;
}
}