com.isti.trinetwatch.params

Class ParamHistoryTable

java.lang.Object

com.isti.trinetwatch.params.ParamHistoryTable

All Implemented Interfaces:

ParamHistory

public class ParamHistoryTable
extends java.lang.Object
implements ParamHistory

Class ParamHistoryTable defines the history table for station parameters.

Field Summary

Fields inherited from interface com.isti.trinetwatch.params.ParamHistory

ARCHIVE_NAME_PREFIX, ARCHIVE_NAME_SUFFIX, KEY_VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ParamHistoryTable(DynamicParamHolder paramHolder) Constructs a history table.

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.
protected java.lang.String	getFileName(java.lang.String key) Gets the file name for the specified key.
protected static java.io.File	getFileObjForStation(ParamValues paramValuesObj, Station stationObj) Returns a 'File' object set to the given station's directory location in the history archive.
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.
static java.util.List	getParamsListForStation(ParamValues paramValuesObj, Station stationObj, GroupTable agentsTable) Returns a list of dynamic parameters found in the given station's history archive.
protected java.lang.String	getRootDirName(java.lang.String key) Gets the root directory name for the specified key.
boolean	isHistoryEnabled(DynamicParamHolder paramHolder) Determines if the history is enabled.
static boolean	isStationHistoryAvail(ParamValues paramValuesObj, Station stationObj) Determines if history for the given station is available (based on whether or not a directory exists in the given station's location in the history archive).
void	setupArchiveManager(DynamicParamHolder paramHolder, long timeLastReceived) Sets up the archive manager for this history.
static void	terminateArchiveWorkerThreads() Terminates the archive-worker threads for all parameter-history tables.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamHistoryTable

public ParamHistoryTable(DynamicParamHolder paramHolder)

Constructs a history table.

Parameters:

paramHolder - the parameter values.

Method Detail

getRootDirName

protected java.lang.String getRootDirName(java.lang.String key)

Gets the root directory name for the specified key.

Parameters:

key - the key.

Returns:

the root directory name for the specified key.

getFileName

protected java.lang.String getFileName(java.lang.String key)

Gets the file name for the specified key.

Parameters:

key - the key.

Returns:

the file name for the specified key.

add

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

Description copied from interface: ParamHistory

Adds the item to the history.

Specified by:

add in interface ParamHistory

Parameters:

paramHolder - the parameter holder.

data - the data.

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

setupArchiveManager

public void setupArchiveManager(DynamicParamHolder paramHolder,
                                long timeLastReceived)

Description copied from interface: ParamHistory

Sets up the archive manager for this history.

Specified by:

setupArchiveManager in interface ParamHistory

Parameters:

paramHolder - the parameter holder.

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

getHistoryVector

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

Description copied from interface: ParamHistory

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".

Specified by:

getHistoryVector in interface ParamHistory

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

public ValueTimeBlock getNewestHistoryItem(DynamicParamHolder paramHolder)

Description copied from interface: ParamHistory

Returns the newest item in the history.

Specified by:

getNewestHistoryItem in interface ParamHistory

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

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

Description copied from interface: ParamHistory

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

Specified by:

getNewestHistoryItem in interface ParamHistory

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

public boolean isHistoryEnabled(DynamicParamHolder paramHolder)

Description copied from interface: ParamHistory

Determines if the history is enabled.

Specified by:

isHistoryEnabled in interface ParamHistory

Parameters:

paramHolder - the parameter holder.

Returns:

true if enabled, false otherwise.

closeHistory

public void closeHistory(DynamicParamHolder paramHolder)

Description copied from interface: ParamHistory

Closes this history, releasing resources allocated for it.

Specified by:

closeHistory in interface ParamHistory

Parameters:

paramHolder - the parameter holder.

terminateArchiveWorkerThreads

public static void terminateArchiveWorkerThreads()

Terminates the archive-worker threads for all parameter-history tables.

getFileObjForStation

protected static java.io.File getFileObjForStation(ParamValues paramValuesObj,
                                                   Station stationObj)

Returns a 'File' object set to the given station's directory location in the history archive.

Parameters:

paramValuesObj - object that implements the parameter-values interface.

stationObj - station object for target station.

Returns:

A new 'File' object set to the given station's directory location in the history archive.

getParamsListForStation

public static java.util.List getParamsListForStation(ParamValues paramValuesObj,
                                                     Station stationObj,
                                                     GroupTable agentsTable)

Returns a list of dynamic parameters found in the given station's history archive. The station's status ("Performance") and usage-level parameters are not included. The given agents-table object will be used to fetch/append the agent objects specified in the parameter entries.

Parameters:

paramValuesObj - object that implements the parameter-values interface.

stationObj - station object for target station.

agentsTable - table of agent objects to use.

Returns:

A list of 'DynamicParamHolder' objects, one for each dynamic parameter found in the station's history archive.

isStationHistoryAvail

public static boolean isStationHistoryAvail(ParamValues paramValuesObj,
                                            Station stationObj)

Determines if history for the given station is available (based on whether or not a directory exists in the given station's location in the history archive).

Parameters:

paramValuesObj - object that implements the parameter-values interface.

stationObj - station object for target station.

Returns:

true if history for the given station is available; false if not.