Package com.storedobject.core

Class AbstractPeriod<T extends Date>

java.lang.Object

com.storedobject.common.Range<T>

com.storedobject.core.AbstractPeriod<T>

Type Parameters:

T - The type of the date, extending Date.

Direct Known Subclasses:

DatePeriod, TimePeriod, TimestampPeriod

public abstract class AbstractPeriod<T extends Date>
extends Range<T>

AbstractPeriod represents a time period defined by a start date (from) and an end date (to). It extends the Range class and provides utility methods for working with time periods. It supports operations such as retrieving formatted date strings, calculating date-based conditions for databases, and checking for overlaps or inclusion within the defined period.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.common.Range

from, to

Constructor Summary

Constructors

Constructor	Description
AbstractPeriod(T from, T to)	Constructs a new AbstractPeriod object with the specified start and end points.

Method Summary

Modifier and Type	Method	Description
Calendar	getCalendarFrom()	Retrieves a Calendar instance representing the starting point of the period.
Calendar	getCalendarTo()	Retrieves a Calendar instance representing the ending point of the period.
String	getDBCondition()	Generates a database condition string representing a range between two date points.
String	getDBCondition(TransactionManager tm)	Generates a database condition string for a date range based on the starting and ending points of the period.
String	getDBTimeCondition()	Generates a database condition string representing the time range between the start of the 'from' date and the end of the 'to' date.
String	getDBTimeCondition(TransactionManager tm)	Generates a database condition string for the time range (start of 'from' to end of 'to') using the specified TransactionManager to convert to GMT.
int	getMonth()	Retrieves the month value of the starting point of the period.
int	getMonthFrom()	Retrieves the month value of the starting point of the period.
int	getMonthTo()	Retrieves the month value of the ending point of the period.
int	getPeriodInDays()	Calculates the duration of the period in days by determining the difference between the start and end points of the period.
int	getPeriodInMonths()	Calculates and retrieves the total duration of the period in months.
int	getYear()	Retrieves the year value of the starting point of the period.
int	getYearFrom()	Retrieves the year value from the starting point of the period.
int	getYearTo()	Retrieves the year value of the ending point of the period.
boolean	inside(long time)	Checks if the given time is within this period.
boolean	inside(Date date)	Checks if the given date is within this period.
boolean	overlaps(AbstractPeriod<?> other)	Checks if this period overlaps with another period.
protected String	toDBString(T date)	Converts the given `date` to a database-compatible string format.
String	toShortString()	Returns a short string representation of the period.
String	toString(String format)	Convert to string in the given "date format".
protected long	value(T date)	Gets the long value representing the date.

Methods inherited from class com.storedobject.common.Range

clone, equals, equals, getFrom, getTo, isValid, same, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractPeriod

public AbstractPeriod(T from,
 T to)

Constructs a new AbstractPeriod object with the specified start and end points.

Parameters:

from - The starting point of the period.

to - The ending point of the period.

Method Details

getCalendarFrom

public Calendar getCalendarFrom()

Retrieves a Calendar instance representing the starting point of the period. The date is extracted using the `getFrom` method and set into a GregorianCalendar object.

Returns:

A Calendar instance initialized to the starting date of the period.

getCalendarTo

public Calendar getCalendarTo()

Retrieves a Calendar instance representing the ending point of the period. The date is extracted using the `getTo` method and set into a GregorianCalendar object.

Returns:

A Calendar instance initialized to the ending date of the period.

value

protected long value(T date)

Gets the long value representing the date.

Overrides:

value in class Range<T extends Date>

Parameters:

date - Date to get the value for.

Returns:

Time in milliseconds.

getPeriodInDays

public int getPeriodInDays()

Calculates the duration of the period in days by determining the difference between the start and end points of the period.

Returns:

The number of days in the current period.

getPeriodInMonths

public int getPeriodInMonths()

Calculates and retrieves the total duration of the period in months. The period is determined based on the start and end points, where the number of months between these points is calculated.

Returns:

The number of months within the period.

toDBString

protected String toDBString(T date)

Converts the given `date` to a database-compatible string format.

Parameters:

date - The date to be converted.

Returns:

A string representation of the date formatted according to database requirements.

getMonth

public int getMonth()

Retrieves the month value of the starting point of the period.

Returns:

The integer representation of the month (1-based, where January is 1 and December is 12) corresponding to the starting point of the period.

getYear

public int getYear()

Retrieves the year value of the starting point of the period.

Returns:

The integer representation of the year corresponding to the starting point of the period.

getMonthFrom

public int getMonthFrom()

Retrieves the month value of the starting point of the period. The month is extracted from the starting date using the getFrom method.

Returns:

The integer representation of the month (1-based, where January is 1 and December is 12) corresponding to the starting point of the period.

getYearFrom

public int getYearFrom()

Retrieves the year value from the starting point of the period. The year is extracted using the `getFrom` method and processed through the `DateUtility.getYear` method.

Returns:

The integer representation of the year corresponding to the starting point of the period.

getMonthTo

public int getMonthTo()

Retrieves the month value of the ending point of the period. The month is derived from the date returned by the getTo method using the DateUtility.getMonth utility.

Returns:

The integer representation of the month (1-based, where January is 1 and December is 12) corresponding to the ending point of the period.

getYearTo

public int getYearTo()

Retrieves the year value of the ending point of the period. The year is derived using the getTo method and processed through the DateUtility.getYear utility.

Returns:

The integer representation of the year corresponding to the ending point of the period.

getDBCondition

public String getDBCondition()

Generates a database condition string representing a range between two date points.

Returns:

A string representing the database condition for the period. If the start or end points are null, the method returns null. If the start and end points are equal, the result is an equality condition. Otherwise, the result is a range condition in the format "BETWEEN 'start' AND 'end'".

getDBCondition

public String getDBCondition(TransactionManager tm)

Generates a database condition string for a date range based on the starting and ending points of the period. The dates are converted to a database-compatible string format using the `TransactionManager` and utility methods.

Parameters:

tm - The TransactionManager instance used for retrieving and formatting the date in GMT.

Returns:

A string representing the database condition for the period. The result is based on the formatted start and end dates. If the start or end points are null, the method returns null. If the start and end points are equal, the result is an equality condition. Otherwise, the result represents a range condition in the format "BETWEEN 'start' AND 'end'".

getDBTimeCondition

public String getDBTimeCondition()

Generates a database condition string representing the time range between the start of the 'from' date and the end of the 'to' date.

Returns:

A string representing the database condition for the time period.

getDBTimeCondition

public String getDBTimeCondition(TransactionManager tm)

Generates a database condition string for the time range (start of 'from' to end of 'to') using the specified TransactionManager to convert to GMT.

Parameters:

tm - The TransactionManager instance to use for GMT conversion.

Returns:

A string representing the database condition for the time period in GMT.

toString

public String toString(String format)

Convert to string in the given "date format". The "date format" passed must be a valid format for creating a formatted date/date-time with SimpleDateFormat. For example, by passing "MMM dd, yyyy" will result in a formatted output like "Jan 23, 1998 - Mar 6, 1999".

Parameters:

format - Date format.

Returns:

Formatted output.

inside

public boolean inside(long time)

Checks if the given time is within this period.

Parameters:

time - Time in milliseconds to check.

Returns:

True if the time is within the period (inclusive of 'from', exclusive of 'to').

inside

public boolean inside(Date date)

Checks if the given date is within this period.

Parameters:

date - Date to check.

Returns:

True if the date is within the period.

toShortString

public String toShortString()

Returns a short string representation of the period. If start and end dates are the same, only one date is returned.

Returns:

Short string representation.

overlaps

public boolean overlaps(AbstractPeriod<?> other)

Checks if this period overlaps with another period.

Parameters:

other - The other period to check against.

Returns:

True if the periods overlap.