com.prosyst.mprm.admin.svhistory.config

Interface HistoryConfiguration

public interface HistoryConfiguration

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

Author:

Jordan Temelkov, j.temelkov@prosyst.com

Field Summary

Fields

Modifier and Type	Field and Description
static long	DAY Constant for a day in milliseconds
static long	DEFAULT_FREQUENCY_PERIOD Constant for default frequency period (an hour)
static int	DEFAULT_MAX_NUMBER_OF_RESULTS Constant for default max number of results (500)
static long	DEFAULT_PERIOD_LENGTH Constant for default period length (a day)
static long	HOUR Constant for a hour in milliseconds
static int	MAX_MAX_NUMBER_OF_RESULTS Constant for maximum max number of results (1000000)
static long	MAX_PERIOD_LENGTH Constant for maximum period length (a month)
static long	MIN_FREQUENCY_PERIOD Constant for minimum frequency period (a second)
static int	MIN_MAX_NUMBER_OF_RESULTS Constant for minimum max number of results (1)
static long	MIN_PERIOD_LENGTH Constant for minimum period length (a minute)
static long	MINUTE Constant for a minute in milliseconds
static long	MONTH Constant for a month (30 days) in milliseconds
static long	SECOND Constant for a second in milliseconds

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.

Field Detail

SECOND

static final long SECOND

Constant for a second in milliseconds

See Also:

Constant Field Values

MINUTE

static final long MINUTE

Constant for a minute in milliseconds

See Also:

Constant Field Values

HOUR

static final long HOUR

Constant for a hour in milliseconds

See Also:

Constant Field Values

DAY

static final long DAY

Constant for a day in milliseconds

See Also:

Constant Field Values

MONTH

static final long MONTH

Constant for a month (30 days) in milliseconds

See Also:

Constant Field Values

DEFAULT_MAX_NUMBER_OF_RESULTS

static final int DEFAULT_MAX_NUMBER_OF_RESULTS

Constant for default max number of results (500)

See Also:

Constant Field Values

MIN_MAX_NUMBER_OF_RESULTS

static final int MIN_MAX_NUMBER_OF_RESULTS

Constant for minimum max number of results (1)

See Also:

Constant Field Values

MAX_MAX_NUMBER_OF_RESULTS

static final int MAX_MAX_NUMBER_OF_RESULTS

Constant for maximum max number of results (1000000)

See Also:

Constant Field Values

DEFAULT_PERIOD_LENGTH

static final long DEFAULT_PERIOD_LENGTH

Constant for default period length (a day)

See Also:

Constant Field Values

MIN_PERIOD_LENGTH

static final long MIN_PERIOD_LENGTH

Constant for minimum period length (a minute)

See Also:

Constant Field Values

MAX_PERIOD_LENGTH

static final long MAX_PERIOD_LENGTH

Constant for maximum period length (a month)

See Also:

Constant Field Values

DEFAULT_FREQUENCY_PERIOD

static final long DEFAULT_FREQUENCY_PERIOD

Constant for default frequency period (an hour)

See Also:

Constant Field Values

MIN_FREQUENCY_PERIOD

static final long MIN_FREQUENCY_PERIOD

Constant for minimum frequency period (a second)

See Also:

Constant Field Values

Method Detail

getMaxEntries

int getMaxEntries()

Get the max entries configuration

Returns:

the max entries to be stored in DB

setMaxEntries

void setMaxEntries(int number)

Set the max entries configuration

Parameters:

number - the new max entries value

getPeriod

long[] getPeriod()

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

Returns:

the desired period

setPeriod

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

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

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

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

void setFrequencyPeriod(long frequencyPeriod)

Set the frequency period

Parameters:

frequencyPeriod - the new frequency period