com.jrefinery.data
Class Day

java.lang.Object
  extended by com.jrefinery.data.TimePeriod
      extended by com.jrefinery.data.Day
All Implemented Interfaces:
MonthConstants, java.lang.Comparable

public class Day
extends TimePeriod

Represents a single day in the range 1-Jan-1900 to 31-Dec-9999.

This class is immutable, which is a requirement for all TimePeriod subclasses.


Field Summary
protected static java.text.DateFormat dateFormatLong
          A date formatter for the default locale.
protected static java.text.DateFormat dateFormatMedium
          A date formatter for the default locale.
protected static java.text.DateFormat dateFormatShort
          A date formatter for the default locale.
protected  SerialDate serialDate
          The day (uses SerialDate for convenience).
protected static java.text.DateFormat standardDateFormat
          A standard date formatter.
 
Fields inherited from class com.jrefinery.data.TimePeriod
DEFAULT_TIME_ZONE, WORKING_CALENDAR
 
Fields inherited from interface com.jrefinery.date.MonthConstants
APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
 
Constructor Summary
Day()
          Constructs a Day, based on the system date/time.
Day(java.util.Date time)
          Constructs a new Day, based on a particular date/time and the default time zone.
Day(java.util.Date time, java.util.TimeZone zone)
          Constructs a Day, based on a particular date/time and time zone.
Day(int day, int month, int year)
          Constructs a new one day time period.
Day(SerialDate serialDate)
          Constructs a new one day time period.
 
Method Summary
 int compareTo(java.lang.Object o1)
          Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after.
 boolean equals(java.lang.Object object)
          Tests the equality of this Day object to an arbitrary object.
 int getDayOfMonth()
          Returns the day of the month.
 long getEnd(java.util.Calendar calendar)
          Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
 int getMonth()
          Returns the month.
 SerialDate getSerialDate()
          Returns the day as a SerialDate.
 long getStart(java.util.Calendar calendar)
          Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).
 int getYear()
          Returns the year.
static void main(java.lang.String[] args)
          Test code - please ignore.
 TimePeriod next()
          Returns the day following this one, or null if some limit has been reached.
static Day parseDay(java.lang.String s)
          Parses the string argument as a day.
 TimePeriod previous()
          Returns the day preceding this one.
 java.lang.String toString()
          Returns a string representing the day.
 
Methods inherited from class com.jrefinery.data.TimePeriod
getEnd, getEnd, getMiddle, getMiddle, getMiddle, getStart, getStart
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

standardDateFormat

protected static final java.text.DateFormat standardDateFormat
A standard date formatter.


dateFormatShort

protected static final java.text.DateFormat dateFormatShort
A date formatter for the default locale.


dateFormatMedium

protected static final java.text.DateFormat dateFormatMedium
A date formatter for the default locale.


dateFormatLong

protected static final java.text.DateFormat dateFormatLong
A date formatter for the default locale.


serialDate

protected SerialDate serialDate
The day (uses SerialDate for convenience).

Constructor Detail

Day

public Day()
Constructs a Day, based on the system date/time.


Day

public Day(int day,
           int month,
           int year)
Constructs a new one day time period.

Parameters:
day - The day-of-the-month.
month - The month (1 to 12).
year - The year (1900 <= year <= 9999).

Day

public Day(SerialDate serialDate)
Constructs a new one day time period.

Parameters:
day - The day.

Day

public Day(java.util.Date time)
Constructs a new Day, based on a particular date/time and the default time zone.

Parameters:
time - The time.

Day

public Day(java.util.Date time,
           java.util.TimeZone zone)
Constructs a Day, based on a particular date/time and time zone.

Parameters:
time - The date/time.
zone - The time zone.
Method Detail

getSerialDate

public SerialDate getSerialDate()
Returns the day as a SerialDate.

Implementation note: the reference that is returned should be an instance of an immutable SerialDate (otherwise the caller could use the reference to alter the state of this Day instance, and Day is supposed to be immutable).

Returns:
The day as a SerialDate.

getYear

public int getYear()
Returns the year.


getMonth

public int getMonth()
Returns the month.


getDayOfMonth

public int getDayOfMonth()
Returns the day of the month.


equals

public boolean equals(java.lang.Object object)
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.

Overrides:
equals in class java.lang.Object
Parameters:
object - The object.
Returns:
A flag indicating whether or not an object is equal to this day.

previous

public TimePeriod previous()
Returns the day preceding this one.

Specified by:
previous in class TimePeriod
Returns:
The day preceding this one.

next

public TimePeriod next()
Returns the day following this one, or null if some limit has been reached.

Specified by:
next in class TimePeriod
Returns:
The next time period.

compareTo

public int compareTo(java.lang.Object o1)
Returns an integer indicating the order of this Day object relative to the specified object: negative == before, zero == same, positive == after.


toString

public java.lang.String toString()
Returns a string representing the day.

Overrides:
toString in class java.lang.Object
Returns:
A string representing the day.

parseDay

public static Day parseDay(java.lang.String s)
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.


getStart

public long getStart(java.util.Calendar calendar)
Returns the first millisecond of the day, evaluated using the supplied calendar (which determines the time zone).

Specified by:
getStart in class TimePeriod
Parameters:
calendar - The calendar.
Returns:
The first millisecond of the time period.

getEnd

public long getEnd(java.util.Calendar calendar)
Returns the last millisecond of the day, evaluated using the supplied calendar (which determines the time zone).

Specified by:
getEnd in class TimePeriod
Parameters:
calendar - The calendar.
Returns:
The last millisecond of the time period.

main

public static void main(java.lang.String[] args)
Test code - please ignore.



Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.