com.isti.trinetwatch.params

Class ParamHistoryFactoryDefault

java.lang.Object

com.isti.trinetwatch.params.ParamHistoryFactoryDefault

All Implemented Interfaces:

ParamHistoryFactory

public class ParamHistoryFactoryDefault
extends java.lang.Object
implements ParamHistoryFactory

Class ParamHistoryFactoryDefault defines the default factory for history for station parameters.

Constructor Summary

Constructors

Constructor and Description
ParamHistoryFactoryDefault()

Method Summary

Modifier and Type	Method and Description
ParamHistory	getParamHistory(DynamicParamHolder paramHolder) Get the parameter history.
java.util.List	getParamsListForStation(ParamValues paramValuesObj, Station stationObj, GroupTable agentsTable) Returns a list of dynamic parameters found in the given station's history archive.
java.lang.String	getVersion() Get the version string for the factory.
boolean	isStationHistoryAvail(ParamValues paramValuesObj, Station stationObj) Determines if history for the given station is available.
void	terminate(int maxTerminateDelaySeconds) Terminate the history saving.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamHistoryFactoryDefault

public ParamHistoryFactoryDefault()

Method Detail

getParamHistory

public ParamHistory getParamHistory(DynamicParamHolder paramHolder)

Description copied from interface: ParamHistoryFactory

Get the parameter history.

Specified by:

getParamHistory in interface ParamHistoryFactory

Parameters:

paramHolder - the parameter holder.

Returns:

the parameter history.

getVersion

public java.lang.String getVersion()

Description copied from interface: ParamHistoryFactory

Get the version string for the factory.

Specified by:

getVersion in interface ParamHistoryFactory

Returns:

the version string for the factory.

isStationHistoryAvail

public boolean isStationHistoryAvail(ParamValues paramValuesObj,
                                     Station stationObj)

Description copied from interface: ParamHistoryFactory

Determines if history for the given station is available.

Specified by:

isStationHistoryAvail in interface ParamHistoryFactory

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.

terminate

public void terminate(int maxTerminateDelaySeconds)

Description copied from interface: ParamHistoryFactory

Terminate the history saving.

Specified by:

terminate in interface ParamHistoryFactory

Parameters:

maxTerminateDelaySeconds - the maximum terminate delay in seconds.

getParamsListForStation

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

Description copied from interface: ParamHistoryFactory

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.

Specified by:

getParamsListForStation in interface ParamHistoryFactory

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.