org.shredzone.cilla.service.search

Class DateRange

java.lang.Object

org.shredzone.cilla.service.search.DateRange

All Implemented Interfaces:

Serializable

public class DateRange
extends Object
implements Serializable

A date range spans either an entire year, an entire month or a day.

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateRange() Creates an empty date range.
DateRange(DateRange range) Clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares two date ranges.
Calendar	getCalendar() Gets a Calendar representation of the date range.
int	getDay() Day to be shown, or 0 if not limited by day.
Calendar	getFromDate() Gets the starting date of this date range.
int	getMonth() Month to be shown, or 0 if not limited by month.
Calendar	getThruDate() Gets the ending date of this date range (inclusive).
int	getYear() Year to be shown, or 0 if not limited by year.
int	hashCode()
boolean	isEmpty() Checks if the Date Range is unset.
static DateRange	parse(String string) Creates a DateRange by parsing a string.
void	setDate(Date date) Sets the day, month and year according to the given Date.
void	setDay(int day)
void	setMonth(int month)
void	setYear(int year)
String	toString() Returns a string representation of this DateRange.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateRange

public DateRange()

Creates an empty date range.

DateRange

public DateRange(DateRange range)

Clone constructor.

Parameters:

range - DateRange to be cloned

Method Detail

parse

public static DateRange parse(String string)

Creates a DateRange by parsing a string. Valid strings are e.g.:

• 2012-02-01: a day (February 1st, 2012)
• 2012-02: a month (February 2012)
• 2012: a year (2012)
• Empty string or null: empty date range

Parameters:

string - String to be parsed, may be null

Returns:

DateRange containing the date

Throws:

IllegalArgumentException - if the date is not valid

getYear

public int getYear()

Year to be shown, or 0 if not limited by year.

setYear

public void setYear(int year)

getMonth

public int getMonth()

Month to be shown, or 0 if not limited by month. Months are counted starting from 1. If no year is given, month will be ignored.

setMonth

public void setMonth(int month)

getDay

public int getDay()

Day to be shown, or 0 if not limited by day. If no year or no month is given, day will be ignored.

setDay

public void setDay(int day)

isEmpty

public boolean isEmpty()

Checks if the Date Range is unset.

setDate

public void setDate(Date date)

Sets the day, month and year according to the given Date.

Parameters:

date - Date to set the calendar settings for

getCalendar

public Calendar getCalendar()

Gets a Calendar representation of the date range.

Returns:

new Calendar instance

getFromDate

public Calendar getFromDate()

Gets the starting date of this date range. If the date range is empty, Epoch (Januar 1st, 1970) is returned.

Returns:

new Calendar instance with the starting date

getThruDate

public Calendar getThruDate()

Gets the ending date of this date range (inclusive). If the date range is empty, December 31st of the current year is returned.

Returns:

new Calendar instance with the ending date (inclusive)

equals

public boolean equals(Object obj)

Compares two date ranges. They are equal if they are set to the very same time span.

Overrides:

equals in class Object

Parameters:

obj - Object to compare

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of this DateRange. The returned string can be parsed with parse(String).

Overrides:

toString in class Object

Returns:

String representation, or an empty string if this date range is unset