Package org.dashbuilder.dataset.date

Class TimeInstant

java.lang.Object

org.dashbuilder.dataset.date.TimeInstant

public class TimeInstant
extends Object

This class is used to represent a given time instant relative to the current time.

Some examples of time instants are:

• now
• now -10second or just -10second
• begin[minute] => begin of current minute. It turns back the clock to first second.
• begin[year March] => begin of current year (year starting on March)
• end[year March] +1year => end of next year (year starting on March)
• begin[year March] -7day => last year's last week start

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeInstant.TimeMode

Field Summary

Fields

Modifier and Type	Field	Description
static Date	START_TIME

Constructor Summary

Constructors

Constructor	Description
TimeInstant()
TimeInstant(TimeInstant.TimeMode timeMode, DateIntervalType intervalType, Month firstMonthOfYear, TimeAmount timeAmount)

Method Summary

Modifier and Type	Method	Description
protected Date	calculateStartTime()
TimeInstant	cloneInstance()
Month	getFirstMonthOfYear()
DateIntervalType	getIntervalType()
Date	getStartTime()
TimeAmount	getTimeAmount()
Date	getTimeInstant()
TimeInstant.TimeMode	getTimeMode()
static TimeInstant	now()	Return a time instant representing the current time.
static TimeInstant	parse(String timeInstantExpr)	Parses a time instant expression.
void	setFirstMonthOfYear(Month firstMonthOfYear)
void	setIntervalType(DateIntervalType intervalType)
void	setStartTime(Date now)
void	setTimeAmount(TimeAmount timeAmount)
void	setTimeMode(TimeInstant.TimeMode timeMode)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

START_TIME

public static Date START_TIME

Constructor Detail

TimeInstant

public TimeInstant()

TimeInstant

public TimeInstant(TimeInstant.TimeMode timeMode,
                   DateIntervalType intervalType,
                   Month firstMonthOfYear,
                   TimeAmount timeAmount)

Method Detail

getTimeMode

public TimeInstant.TimeMode getTimeMode()

setTimeMode

public void setTimeMode(TimeInstant.TimeMode timeMode)

getIntervalType

public DateIntervalType getIntervalType()

setIntervalType

public void setIntervalType(DateIntervalType intervalType)

getFirstMonthOfYear

public Month getFirstMonthOfYear()

setFirstMonthOfYear

public void setFirstMonthOfYear(Month firstMonthOfYear)

getTimeAmount

public TimeAmount getTimeAmount()

setTimeAmount

public void setTimeAmount(TimeAmount timeAmount)

toString

public String toString()

Overrides:

toString in class Object

cloneInstance

public TimeInstant cloneInstance()

getTimeInstant

public Date getTimeInstant()

setStartTime

public void setStartTime(Date now)

getStartTime

public Date getStartTime()

calculateStartTime

protected Date calculateStartTime()

now

public static TimeInstant now()

Return a time instant representing the current time.

parse

public static TimeInstant parse(String timeInstantExpr)

Parses a time instant expression.

Parameters:

timeInstantExpr - A valid time instant expression (see TimeInstant class javadoc)

Returns:

A TimeInstant instance

Throws:

IllegalArgumentException - If the expression is not valid