public class ChunkedTimeInterval extends GenericService
/path/to/TimeInterval.properties $class=atg.service.util.ChunkedTimeInterval # When class is used as a nucleus component, should use request scope only $scope=request # Create a window of three hours intervalCount=3 intervalUnitName=hoursThen link client component's properties to this componet's startTime/endTime or startDate/endDate properties. Created 2010-01-22
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
static int |
FIRST_YEAR |
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ChunkedTimeInterval()
Default constructor which will base start and end date/time
values from current time
|
ChunkedTimeInterval(java.util.Date pBaseDate)
Constructor with which the base date used to calculate start and
end date/time values is specified.
|
Modifier and Type | Method and Description |
---|---|
protected void |
calculate()
Calculate, or recalculate, the start and end date/time values.
|
java.util.Date |
getBaseDate()
Return the Date value used to calculate the time window.
|
java.util.Date |
getEndDate()
Return the calculated end time of the time interval based on the
specified (or default) baseDate.
|
long |
getEndTime()
Return the calculated end of the time interval in milliseconds.
|
java.lang.String |
getEndTimeAsString()
Return the calculated end time of the time interval in
milliseconds, as a String.
|
long |
getEndTimeSeconds()
Return the calculated start time of the time interval in seconds.
|
java.lang.String |
getEndTimeSecondsAsString()
Return the calculated end time of the time interval in seconds as
a String.
|
int |
getIntervalCount()
The number of 'intervalUnitName' time units for the chunk.
|
java.lang.String |
getIntervalUnitName()
The time interval unit name.
|
long |
getMillisecondsUntil(java.util.Date pDate)
Return the number of milliseconds until the specified date.
|
long |
getMillisecondsUntilEnd()
Return the number of milliseconds until the end date.
|
java.util.Date |
getStartDate()
Return the calculated start date of the time interval based on
the specified (or default) baseDate.
|
long |
getStartTime()
Return the calculated start of the time interval in milliseconds.
|
java.lang.String |
getStartTimeAsString()
Return the calculated start time of the time interval in
milliseconds, as a String.
|
long |
getStartTimeSeconds()
Return the calculated start time of the time interval in seconds.
|
java.lang.String |
getStartTimeSecondsAsString()
Return the calculated start date of the time interval in seconds,
based on the specified (or default) baseDate, as a String.
|
protected boolean |
isCalculationNecessary(java.util.Date pDate)
Return true if the end date has not yet been calculated or if it
has and that date has passed.
|
void |
setBaseDate(java.util.Date pDate)
Set the Date value used to calculate the time window.
|
void |
setIntervalCount(int pIntervalCount)
The number of 'intervalUnitName' time units for the chunk.
|
void |
setIntervalUnitName(java.lang.String pUnitName)
The time interval unit name.
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final int FIRST_YEAR
public static java.lang.String CLASS_VERSION
public ChunkedTimeInterval()
public ChunkedTimeInterval(java.util.Date pBaseDate)
pBaseDate
- The base date or nullpublic void setIntervalUnitName(java.lang.String pUnitName)
pUnitName
- the name of the time intervalpublic java.lang.String getIntervalUnitName()
public void setIntervalCount(int pIntervalCount)
pIntervalCount
- a positive integerpublic int getIntervalCount()
public java.util.Date getStartDate()
public long getStartTime()
public java.lang.String getStartTimeAsString()
public long getStartTimeSeconds()
public java.lang.String getStartTimeSecondsAsString()
public java.util.Date getEndDate()
public long getEndTime()
public java.lang.String getEndTimeAsString()
public long getEndTimeSeconds()
public java.lang.String getEndTimeSecondsAsString()
public long getMillisecondsUntilEnd()
public long getMillisecondsUntil(java.util.Date pDate)
pDate
- a non-null date value.public java.util.Date getBaseDate()
setBaseDate(java.util.Date)
public void setBaseDate(java.util.Date pDate)
pDate
- the base time used for time window calculationgetBaseDate()
protected boolean isCalculationNecessary(java.util.Date pDate)
protected void calculate()