com.eventgnosis.filters
Class TimeInterval

java.lang.Object
  com.eventgnosis.filters.TimeInterval

All Implemented Interfaces:

EmmlParmBuilder

public class TimeInterval

extends java.lang.Object

implements EmmlParmBuilder

Holds a time span, difference between a start time and a stop time, as a long in milliseconds.
For convenience, can be initialized using a number and one of the following unit strings. second, minute, hour, day, week, month or year

Field Summary

static java.lang.String	DEF_UNITS
static long	DEF_VAL
static java.lang.String	DEF_VAL_STR

Constructor Summary

TimeInterval()

TimeInterval(double value, java.lang.String units, long msecs)

Method Summary

java.lang.String	build(Log log, com.eventgnosis.config.ConfigurationManager configMgr, org.w3c.dom.Element elem) After object is instantiated this method is called to parse the EMML DOM element, setting its internal state to the parsed values.
static TimeInterval	build(Log log, java.lang.String strExpire) Alternate constructor currently used by EmmlVariables expiration time.
java.lang.String	getConfigXml()
static TimeInterval	getDefault() Returns default TimeInterval (99 years), used if the TimeInterval is not correctly specified, missing or invalid.
long	getMsecs()
static long	getMsecs(double val, java.lang.String units) Returns TimeInterval in raw milliseconds.
java.lang.String	getUnits()
double	getValue()
java.lang.String	toBriefString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEF_UNITS

public static final java.lang.String DEF_UNITS

See Also:

Constant Field Values

DEF_VAL

public static final long DEF_VAL

See Also:

Constant Field Values

DEF_VAL_STR

public static final java.lang.String DEF_VAL_STR

See Also:

Constant Field Values

Constructor Detail

TimeInterval

public TimeInterval()

TimeInterval

public TimeInterval(double value,
                    java.lang.String units,
                    long msecs)

Method Detail

build

public java.lang.String build(Log log,
                              com.eventgnosis.config.ConfigurationManager configMgr,
                              org.w3c.dom.Element elem)

Description copied from interface: EmmlParmBuilder

After object is instantiated this method is called to parse the EMML DOM element, setting its internal state to the parsed values.

Specified by:

build in interface EmmlParmBuilder

Parameters:

log - logger instance for tracking error, warning and info messages.

configMgr - holds configuration data structure used to properly configure runtime setup based on input ECA(s).

elem - emml(dom) node to be parsed

Returns:

precise error statement if there are any errors; null is returned if there are no errors and object is build sucessfully.

build

public static TimeInterval build(Log log,
                                 java.lang.String strExpire)

Alternate constructor currently used by EmmlVariables expiration time.

Parameters:

log -

strExpire -

Returns:

TimeInterval

getConfigXml

public java.lang.String getConfigXml()

getDefault

public static TimeInterval getDefault()

Returns default TimeInterval (99 years), used if the TimeInterval is not correctly specified, missing or invalid.

Returns:

TimeInterval

getMsecs

public long getMsecs()

getMsecs

public static long getMsecs(double val,
                            java.lang.String units)

Returns TimeInterval in raw milliseconds.

Parameters:

val -

units -

Returns:

long

getUnits

public java.lang.String getUnits()

getValue

public double getValue()

toBriefString

public java.lang.String toBriefString()

Returns:

TimeInterval as a String in "value units" format

toString

public java.lang.String toString()