TimeWindows

java.lang.Object
- org.qbroker.common.TimeWindows

```
public class TimeWindows
extends java.lang.Object
```
TimeWindows - A set of time slots in which something is expected to occur and a method to check if it has occurred or is late.

A TimeWindows contains a set of time windows in which something is expected to occur at least once, and other rules. Its method, check(), requires two time stamps, the current time of testing and the latest time to be checked. It compares the two time stamps with the preconfigured time windows and the other timing rules. It returns an integer which gives the status of the timing event. If the current time is outside any of the given time windows but within its lifetime, BLACKOUT is returned indicating it is outside any active time windows. If the current time is beyond the lifetime, DISABLED is returned to indicate that all the time windows have been closed. Within any active time windows, it returns NORMAL if nothing is wrong or the timing event occurs. Otherwise it returns a positive integer depending upon what you are interested in.

If the user is expecting something occurred in a recent time range before the test, the threshold should contain only one negative value defining how recent in seconds. If the occurrence takes place as expected, the method, check(), returns OCCURRED. Otherwise, it returns NORMAL indicating nothing happened or BLACKOUT indicating outside of time window.

If the user is concerned about something's lateness regarding to the previous occurrence, he/she has to specify the allowable lateness time spans, or late-thresholds. If the first late-threshold is reached or passed, the method, check(), returns SLATE indicating somewhat late. If the next threshold is reached or passed, it returns ALATE indicating alarmingly late. The next level of lateness is ELATE, indicating extremely late. User can specify multi-level late thresholds. If there is no late, it returns NORMAL.

The TimeWindows is just a set of rules and a check method for something expected to occur sometime somehow. It does not care how to obtain the time stamp of the latest occurrence. It has no action to handle the consequence either. It can be used as a scheduler as long as the time resolution is acceptable. It also behaves in dealing with the DST time line. In order to know what kind of thresholds defined for the TimeWindows, you can check the integer returned by getThresholdLength().

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALATE`
`static int`	`BLACKEXCEPTION`
`static int`	`BLACKOUT`
`int`	`defaultStatus`
`static int`	`DISABLED`
`static int`	`ELATE`
`static int`	`EXCEPTION`
`static int`	`EXPIRED`
`static int[]`	`monthDayMask`
`static int[]`	`monthMask`
`static int`	`NORMAL`
`static int`	`OCCURRED`
`static int`	`SLATE`
`static java.lang.String[]`	`STATUS_TEXT`
`static int[]`	`weekDayMask`

Constructor Summary

Constructors
Constructor and Description

TimeWindows(java.util.Map props)

Constructors
Constructor and Description
`TimeWindows(java.util.Map props)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`check(long currentTime, long sampleTime)`
`long`	`getBaseTime()`
`int[]`	`getCurrentThreshold(long currentTime)` It returns copy of the active threshold in millisec for the given time or null if it is blackout or expired.
`static long[]`	`getDSTInfo(int year)` return tripplet of DST info: dstStart, dstEnd, dstOffset
`static long[]`	`getDSTInfo(int year, java.util.TimeZone zone)` return tripplet of DST info: dstStart, dstEnd, dstOffset
`long`	`getStartTime()`
`long`	`getStopTime()`
`int`	`getThresholdLength()` It returns 0 for no threshold defined, 1 for occurred thresholds or 2 and above for lateness thresholds.
`java.util.Calendar`	`getToday()`
`java.util.Calendar`	`getYesterday()`
`boolean`	`isActive(java.util.Calendar day)`
`void`	`list()`
`static int[]`	`parseInterval(java.lang.String intervalStr)`
`static int[]`	`parseThreshold(java.lang.String thresholdStr)`
`static int`	`parseTimeString(java.lang.String timeStr)`
`void`	`setStartTime(long tm)`
`void`	`setStopTime(long tm)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCEPTION
```
public static final int EXCEPTION
```
See Also:

Constant Field Values

BLACKEXCEPTION
```
public static final int BLACKEXCEPTION
```
See Also:

Constant Field Values

DISABLED
```
public static final int DISABLED
```
See Also:

Constant Field Values

BLACKOUT
```
public static final int BLACKOUT
```
See Also:

Constant Field Values

NORMAL
```
public static final int NORMAL
```
See Also:

Constant Field Values

OCCURRED
```
public static final int OCCURRED
```
See Also:

Constant Field Values

SLATE
```
public static final int SLATE
```
See Also:

Constant Field Values

ALATE
```
public static final int ALATE
```
See Also:

Constant Field Values

ELATE
```
public static final int ELATE
```
See Also:

Constant Field Values

EXPIRED
```
public static final int EXPIRED
```
See Also:

Constant Field Values

STATUS_TEXT

public static final java.lang.String[] STATUS_TEXT

weekDayMask
```
public static final int[] weekDayMask
```

monthDayMask
```
public static final int[] monthDayMask
```

monthMask
```
public static final int[] monthMask
```

defaultStatus
```
public int defaultStatus
```

Constructor Detail

TimeWindows

public TimeWindows(java.util.Map props)

Method Detail

isActive

public boolean isActive(java.util.Calendar day)

getThresholdLength
```
public int getThresholdLength()
```
It returns 0 for no threshold defined, 1 for occurred thresholds or 2 and above for lateness thresholds.

getCurrentThreshold
```
public int[] getCurrentThreshold(long currentTime)
```
It returns copy of the active threshold in millisec for the given time or null if it is blackout or expired.

check

public int check(long currentTime,
                 long sampleTime)

parseTimeString

public static int parseTimeString(java.lang.String timeStr)

parseInterval

public static int[] parseInterval(java.lang.String intervalStr)

parseThreshold

public static int[] parseThreshold(java.lang.String thresholdStr)

getToday
```
public java.util.Calendar getToday()
```

getYesterday

public java.util.Calendar getYesterday()

getBaseTime
```
public long getBaseTime()
```

list
```
public void list()
```

getDSTInfo
```
public static long[] getDSTInfo(int year)
```
return tripplet of DST info: dstStart, dstEnd, dstOffset

getStartTime
```
public long getStartTime()
```

getStopTime
```
public long getStopTime()
```

setStartTime
```
public void setStartTime(long tm)
```

setStopTime
```
public void setStopTime(long tm)
```

getDSTInfo

public static long[] getDSTInfo(int year,
                                java.util.TimeZone zone)

return tripplet of DST info: dstStart, dstEnd, dstOffset

Class TimeWindows

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXCEPTION

BLACKEXCEPTION

DISABLED

BLACKOUT

NORMAL

OCCURRED

SLATE

ALATE

ELATE

EXPIRED

STATUS_TEXT

weekDayMask

monthDayMask

monthMask

defaultStatus

Constructor Detail

TimeWindows

Method Detail

isActive

getThresholdLength

getCurrentThreshold

check

parseTimeString

parseInterval

parseThreshold

getToday

getYesterday

getBaseTime

list

getDSTInfo

getStartTime

getStopTime

setStartTime

setStopTime

getDSTInfo