Package com.storedobject.core

Class DatePeriod

java.lang.Object

com.storedobject.common.Range<Date>

com.storedobject.core.AbstractPeriod<Date>

com.storedobject.core.DatePeriod

public class DatePeriod
extends AbstractPeriod<Date>

Representation of a period of time when the start and end points are Dates.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.common.Range

from, to

Constructor Summary

Constructors

Constructor	Description
DatePeriod(Date from, Date to)	Create from Date objects.
DatePeriod(Calendar from, Calendar to)	Create from Calendar objects.
DatePeriod(Date from, Date to)	Create from Date objects.

Method Summary

Modifier and Type	Method	Description
protected Date	clone(Date date)	Clones the given date.
static DatePeriod	create()	Create a period for today (from and to will be today).
static DatePeriod	create(Date date)	Create a period for a single date (from and to will be the same).
static DatePeriod	create(Date dateFrom, Date dateTo)	Create a period from two dates.
TimePeriod	getTimePeriod()	Get a TimePeriod for this date period.
static DatePeriod	monthTillToday()	Create a period from the start of the current month till today.
static DatePeriod	monthTillYesterday()	Create a period from the start of the current month till yesterday.
protected boolean	same(Date one, Date two)	Checks if two dates are the same.
static DatePeriod	thisMonth()	Create a period for the current month.
static DatePeriod	thisYear()	Create a period for the current year.
static DatePeriod	tillToday(int fromDays)	Create a period ending today and starting a specific number of days ago.
static DatePeriod	tillYesterday(int fromDays)	Create a period ending yesterday and starting a specific number of days ago.
protected String	toString(Date date)	Converts the date to a string.
static DatePeriod	yearTillToday()	Create a period from the start of the current year till today.
static DatePeriod	yearTillYesterday()	Create a period from the start of the current year till yesterday.

Methods inherited from class com.storedobject.core.AbstractPeriod

getCalendarFrom, getCalendarTo, getDBCondition, getDBCondition, getDBTimeCondition, getDBTimeCondition, getMonth, getMonthFrom, getMonthTo, getPeriodInDays, getPeriodInMonths, getYear, getYearFrom, getYearTo, inside, inside, overlaps, toDBString, toShortString, toString, value

Methods inherited from class com.storedobject.common.Range

equals, equals, getFrom, getTo, isValid, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DatePeriod

public DatePeriod(Calendar from,
 Calendar to)

Create from Calendar objects.

Parameters:

from - The starting point of the period.

to - The ending point of the period.

DatePeriod

public DatePeriod(Date from,
 Date to)

Create from Date objects.

Parameters:

from - The starting point of the period.

to - The ending point of the period.

DatePeriod

public DatePeriod(Date from,
 Date to)

Create from Date objects.

Parameters:

from - The starting point of the period.

to - The ending point of the period.

Method Details

create

public static DatePeriod create(Date dateFrom,
 Date dateTo)

Create a period from two dates. The dates will be swapped if from date is after the to date.

Parameters:

dateFrom - The starting point of the period.

dateTo - The ending point of the period.

Returns:

The date period created.

create

public static DatePeriod create(Date date)

Create a period for a single date (from and to will be the same).

Parameters:

date - The date.

Returns:

The date period created.

create

public static DatePeriod create()

Create a period for today (from and to will be today).

Returns:

The date period created.

clone

protected Date clone(Date date)

Clones the given date.

Overrides:

clone in class Range<Date>

Parameters:

date - The date to be cloned. If null, today's date is used.

Returns:

The cloned date.

same

protected boolean same(Date one,
 Date two)

Checks if two dates are the same.

Overrides:

same in class Range<Date>

Parameters:

one - The first date.

two - The second date.

Returns:

True if they are the same.

toString

protected String toString(Date date)

Converts the date to a string.

Overrides:

toString in class Range<Date>

Parameters:

date - The date to be converted.

Returns:

The formatted string.

getTimePeriod

public TimePeriod getTimePeriod()

Get a TimePeriod for this date period.

Returns:

The time period.

thisMonth

public static DatePeriod thisMonth()

Create a period for the current month.

Returns:

The date period for the current month.

monthTillToday

public static DatePeriod monthTillToday()

Create a period from the start of the current month till today.

Returns:

The date period.

monthTillYesterday

public static DatePeriod monthTillYesterday()

Create a period from the start of the current month till yesterday.

Returns:

The date period.

thisYear

public static DatePeriod thisYear()

Create a period for the current year.

Returns:

The date period for the current year.

yearTillToday

public static DatePeriod yearTillToday()

Create a period from the start of the current year till today.

Returns:

The date period.

yearTillYesterday

public static DatePeriod yearTillYesterday()

Create a period from the start of the current year till yesterday.

Returns:

The date period.

tillToday

public static DatePeriod tillToday(int fromDays)

Create a period ending today and starting a specific number of days ago.

Parameters:

fromDays - Number of days ago to start.

Returns:

The date period.

tillYesterday

public static DatePeriod tillYesterday(int fromDays)

Create a period ending yesterday and starting a specific number of days ago.

Parameters:

fromDays - Number of days ago to start.

Returns:

The date period.