com.isti.trinetwatch.params

Interface ParamHistory

All Known Implementing Classes:

ParamHistoryTable

public interface ParamHistory

Interface ParamHistory defines the history for station parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVE_NAME_PREFIX Archive name prefix.
static java.lang.String	ARCHIVE_NAME_SUFFIX Archive name suffix.
static java.lang.String	KEY_VALUE_SEPARATOR Key value separator.

Method Summary

Modifier and Type	Method and Description
void	add(DynamicParamHolder paramHolder, java.lang.Object data, long timeLastReceived) Adds the item to the history.
void	closeHistory(DynamicParamHolder paramHolder) Closes this history, releasing resources allocated for it.
java.util.Vector	getHistoryVector(DynamicParamHolder paramHolder, long startTime, long endTime) Returns a new Vector containing 'ValueTimeBlock' objects with timestamps in the specified range.
ValueTimeBlock	getNewestHistoryItem(DynamicParamHolder paramHolder) Returns the newest item in the history.
ValueTimeBlock	getNewestHistoryItem(DynamicParamHolder paramHolder, long startTime, long endTime) Returns the newest item in the history with a timestamp in the specified range.
boolean	isHistoryEnabled(DynamicParamHolder paramHolder) Determines if the history is enabled.
void	setupArchiveManager(DynamicParamHolder paramHolder, long timeLastReceived) Sets up the archive manager for this history.

Field Detail

KEY_VALUE_SEPARATOR

static final java.lang.String KEY_VALUE_SEPARATOR

Key value separator.

See Also:

Constant Field Values

ARCHIVE_NAME_PREFIX

static final java.lang.String ARCHIVE_NAME_PREFIX

Archive name prefix.

See Also:

Constant Field Values

ARCHIVE_NAME_SUFFIX

static final java.lang.String ARCHIVE_NAME_SUFFIX

Archive name suffix.

See Also:

Constant Field Values

Method Detail

add

void add(DynamicParamHolder paramHolder,
         java.lang.Object data,
         long timeLastReceived)

Adds the item to the history.

Parameters:

paramHolder - the parameter holder.

data - the data.

timeLastReceived - the time last received (seconds since 1/1/1970).

setupArchiveManager

void setupArchiveManager(DynamicParamHolder paramHolder,
                         long timeLastReceived)

Sets up the archive manager for this history.

Parameters:

paramHolder - the parameter holder.

timeLastReceived - the time last received (seconds since 1/1/1970).

getHistoryVector

java.util.Vector getHistoryVector(DynamicParamHolder paramHolder,
                                  long startTime,
                                  long endTime)

Returns a new Vector containing 'ValueTimeBlock' objects with timestamps in the specified range. The start and end time parameter values are in seconds since 1/1/1970, and are "inclusive".

Parameters:

paramHolder - the parameter holder.

startTime - the start time for the range, or 0 for the beginning of the history.

endTime - the end time for the range, or 0 for the end of the history.

Returns:

A Vector of 'ValueTimeBlock' objects with timestamps in the specified range, an empty Vector if no matching objects were found, or null if no history objects are available.

getNewestHistoryItem

ValueTimeBlock getNewestHistoryItem(DynamicParamHolder paramHolder)

Returns the newest item in the history.

Parameters:

paramHolder - the parameter holder.

Returns:

A 'ValueTimeBlock' object representing the newest item in the history, or null if no history objects are available.

getNewestHistoryItem

ValueTimeBlock getNewestHistoryItem(DynamicParamHolder paramHolder,
                                    long startTime,
                                    long endTime)

Returns the newest item in the history with a timestamp in the specified range.

Parameters:

paramHolder - the parameter holder.

startTime - the start time for the range, or 0 for the beginning of the history.

endTime - the end time for the range, or 0 for the end of the history.

Returns:

A 'ValueTimeBlock' object representing the newest item in the history with a timestamp in the specified range, or null if no history objects are available.

isHistoryEnabled

boolean isHistoryEnabled(DynamicParamHolder paramHolder)

Determines if the history is enabled.

Parameters:

paramHolder - the parameter holder.

Returns:

true if enabled, false otherwise.

closeHistory

void closeHistory(DynamicParamHolder paramHolder)

Closes this history, releasing resources allocated for it.

Parameters:

paramHolder - the parameter holder.