org.fujion.common

Class DateRange

java.lang.Object

org.fujion.common.DateRange

public class DateRange
extends Object

Represents a single date range.

Constructor Summary

Constructors

Constructor and Description
DateRange(Date startDate, Date endDate) Create a date range from individual components, using the default label.
DateRange(DateRange dateRange) Copy constructor.
DateRange(String data) Create a date range item from its string representation.
DateRange(String label, Date startDate, Date endDate) Create a date range from individual components.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object value) Checks for equality based on start and end dates.
Date	getEndDate() Returns the end date.
String	getLabel() Returns the display label.
String	getRawEndDate() Returns the raw end date.
String	getRawStartDate() Returns the raw start date.
Date	getStartDate() Returns the start date.
boolean	inRange(Date refDate) Returns true if the reference date is within this range.
boolean	inRange(Date refDate, boolean inclusiveStart, boolean inclusiveEnd) Returns true if the reference date is within this range.
boolean	inRange(DateRange refRange) Returns true if the reference range is wholly contained within this range.
boolean	inRange(DateRange refRange, boolean inclusiveStart, boolean inclusiveEnd) Returns true if the reference range is wholly contained within this range.
boolean	isDefault() Returns the default flag.
String	toString() Returns the serialized version of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateRange

public DateRange(String data)

Create a date range item from its string representation.

Parameters:

data - Format is label|start date|end date|default Only label is required.

DateRange

public DateRange(String label,
                 Date startDate,
                 Date endDate)

Create a date range from individual components.

Parameters:

label - Displayable text. If null, a default label is created.

startDate - The start date.

endDate - The end date.

DateRange

public DateRange(Date startDate,
                 Date endDate)

Create a date range from individual components, using the default label.

Parameters:

startDate - The start date.

endDate - The end date.

DateRange

public DateRange(DateRange dateRange)

Copy constructor.

Parameters:

dateRange - Date range to copy.

Method Detail

equals

public boolean equals(Object value)

Checks for equality based on start and end dates.

Overrides:

equals in class Object

Returns:

True if start and end dates are identical.

toString

public String toString()

Returns the serialized version of the object.

Overrides:

toString in class Object

Returns:

Serialized object.

getLabel

public String getLabel()

Returns the display label.

Returns:

The display label.

getStartDate

public Date getStartDate()

Returns the start date.

Returns:

The start date.

getEndDate

public Date getEndDate()

Returns the end date.

Returns:

The end date.

getRawStartDate

public String getRawStartDate()

Returns the raw start date.

Returns:

The raw start date.

getRawEndDate

public String getRawEndDate()

Returns the raw end date.

Returns:

The raw end date.

isDefault

public boolean isDefault()

Returns the default flag.

Returns:

The default flag.

inRange

public boolean inRange(Date refDate)

Returns true if the reference date is within this range. The start date is included within the interval, the end date is not.

Parameters:

refDate - A reference date.

Returns:

True if the reference date is within this range.

inRange

public boolean inRange(Date refDate,
                       boolean inclusiveStart,
                       boolean inclusiveEnd)

Returns true if the reference date is within this range.

Parameters:

refDate - A reference date.

inclusiveStart - If true, the start date is included in the range.

inclusiveEnd - If true, the end date is included in the range.

Returns:

True if the reference date is within this range.

inRange

public boolean inRange(DateRange refRange)

Returns true if the reference range is wholly contained within this range. The start date of this range is included within the interval, the end date is not.

Parameters:

refRange - A reference date range.

Returns:

True if the reference date ranged is wholly contained within this range.

inRange

public boolean inRange(DateRange refRange,
                       boolean inclusiveStart,
                       boolean inclusiveEnd)

Returns true if the reference range is wholly contained within this range.

Parameters:

refRange - A reference date range.

inclusiveStart - If true, the start date is included in the range.

inclusiveEnd - If true, the end date is included in the range.

Returns:

True if the reference date ranged is wholly contained within this range.