com.prosyst.mprm.script.svhistory

Class HistoryConfiguration

java.lang.Object

com.prosyst.mprm.script.svhistory.HistoryConfiguration

All Implemented Interfaces:

java.io.Serializable

public class HistoryConfiguration
extends java.lang.Object
implements java.io.Serializable

The history configuration. Provides information for the configuration including max stored entries, period length and frequency period.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
long	DAY Constant for a day in milliseconds
long	HOUR Constant for a hour in milliseconds
long	MINUTE Constant for a minute in milliseconds
long	MONTH Constant for a month (30 days) in milliseconds
long	SECOND Constant for a second in milliseconds

Constructor Summary

Constructors

Constructor and Description
HistoryConfiguration() Constructs a history configuration.

Method Summary

Modifier and Type	Method and Description
long	getFrequencyPeriod() Get the frequency period.
int	getMaxEntries() Get the max entries configuration
long[]	getPeriod() Get the period for which values are to be retrieved.
long	getPeriodLength() Get the configured period length for which entries are to be kept in DB.
void	setFrequencyPeriod(long frequencyPeriod) Set the frequency period
void	setMaxEntries(int number) Set the max entries configuration
void	setPeriod(long startTime, long endTime) Set the period for which values are to be retrieved.
void	setPeriodLength(long periodLength) Set the configured period length for which entries are to be kept in DB.

Methods inherited from class java.lang.Object

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

Field Detail

SECOND

public long SECOND

Constant for a second in milliseconds

MINUTE

public long MINUTE

Constant for a minute in milliseconds

HOUR

public long HOUR

Constant for a hour in milliseconds

DAY

public long DAY

Constant for a day in milliseconds

MONTH

public long MONTH

Constant for a month (30 days) in milliseconds

Constructor Detail

HistoryConfiguration

public HistoryConfiguration()

Constructs a history configuration.

Method Detail

getMaxEntries

public int getMaxEntries()

Get the max entries configuration

Returns:

the max entries to be stored in DB

setMaxEntries

public void setMaxEntries(int number)

Set the max entries configuration

Parameters:

number - the new max entries value

getPeriod

public long[] getPeriod()

Get the period for which values are to be retrieved. Used only for retrieving history values.

Returns:

the desired period

setPeriod

public void setPeriod(long startTime,
                      long endTime)

Set the period for which values are to be retrieved. Used only for retrieving history values.

Parameters:

startTime - the period start

endTime - the period end

getPeriodLength

public long getPeriodLength()

Get the configured period length for which entries are to be kept in DB. Used only for recording history values.

Returns:

the configured period length

setPeriodLength

public void setPeriodLength(long periodLength)

Set the configured period length for which entries are to be kept in DB. Used only for recording history values.

Parameters:

periodLength - the new period length

getFrequencyPeriod

public long getFrequencyPeriod()

Get the frequency period. It configures how often values are to be stored in DB. This means if more event values are received for the frequency period, only one of them will be stored, and if no event value is received - the last received event value is stored.

Returns:

the frequency period

setFrequencyPeriod

public void setFrequencyPeriod(long frequencyPeriod)

Set the frequency period

Parameters:

frequencyPeriod - the new frequency period