com.yahoo.bard.webservice.data.volatility

Class TimeOffsetVolatileIntervalsFunction

java.lang.Object

com.yahoo.bard.webservice.data.volatility.TimeOffsetVolatileIntervalsFunction

All Implemented Interfaces:

VolatileIntervalsFunction

public class TimeOffsetVolatileIntervalsFunction
extends Object
implements VolatileIntervalsFunction

Describe intervals as volatile from some fixed offset in the past to one in the future.

Field Summary

Fields

Modifier and Type	Field and Description
static long	FAR_FUTURE Arbitrary future date for unbounded volatility.

Constructor Summary

Constructors

Constructor and Description
TimeOffsetVolatileIntervalsFunction(long past) Build a time offset volatile intervals function which marks all intervals from past to the value of FAR_FUTURE as volatile.
TimeOffsetVolatileIntervalsFunction(long past, long future) Constructor.

Method Summary

Modifier and Type	Method and Description
SimplifiedIntervalList	getVolatileIntervals() Retrieve a list of which intervals are volatile.

Methods inherited from class java.lang.Object

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

Field Detail

FAR_FUTURE

public static final long FAR_FUTURE

Arbitrary future date for unbounded volatility. About a century.

See Also:

Constant Field Values

Constructor Detail

TimeOffsetVolatileIntervalsFunction

public TimeOffsetVolatileIntervalsFunction(long past)

Build a time offset volatile intervals function which marks all intervals from past to the value of FAR_FUTURE as volatile.

Parameters:

past - The default milliseconds before System.currentTimeMillis considered to be volatile

TimeOffsetVolatileIntervalsFunction

public TimeOffsetVolatileIntervalsFunction(long past,
                                           long future)

Constructor.

Parameters:

past - The milliseconds before System.currentTimeMillis considered to be volatile in the past

future - The milliseconds after System.currentTimeMillis considered to be volatile in the future

Method Detail

getVolatileIntervals

public SimplifiedIntervalList getVolatileIntervals()

Description copied from interface: VolatileIntervalsFunction

Retrieve a list of which intervals are volatile. Volatile intervals should not be cached (in the same way that partial intervals are not cached) but are returned to the user (which partial intervals are typically not). Volatile intervals will typically abut or overlap incomplete data because they are on the forward edge of ingestion.

Specified by:

getVolatileIntervals in interface VolatileIntervalsFunction

Returns:

A simplified interval list of volatile intervals