com.aquenos.cassandra.pvarchiver.controlsystem

Class AbstractSampleDecimator<SampleType extends Sample>

java.lang.Object

com.aquenos.cassandra.pvarchiver.controlsystem.AbstractSampleDecimator<SampleType>

Type Parameters:

SampleType - type that is implemented by all samples that are passed to this sample decimator and that is also implemented by the sample generated by this sample decimator. Typically, this is the sample type used by the control-system support that provides the concrete implementation that inherits from this base class.

All Implemented Interfaces:

SampleDecimator<SampleType>

Direct Known Subclasses:

AbstractStatefulSampleDecimator

public abstract class AbstractSampleDecimator<SampleType extends Sample>
extends Object
implements SampleDecimator<SampleType>

Abstract base class for sample decimator implementations. This base class takes care of storing the channel name and the interval start time and length. When creating an implementation of the SampleDecimator interface, the AbstractStatefulSampleDecimator should be considered as a base class instead of using this class directly. However, this class can be used when the behavior exhibited by the AbstractStatefulSampleDecimator is not desired.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
AbstractSampleDecimator(String channelName, long intervalStartTime, long intervalLength) Creates the sample decimator and initializes the channel name and the interval start-time and length with the specified values.

Method Summary

Modifier and Type	Method and Description
String	getChannelName() Returns the name of the channel for which this sample decimator decimates samples.
long	getIntervalLength() Returns the length of the period for which this sample decimator generates a decimated sample.
long	getIntervalStartTime() Returns the start time of the period for which this sample decimator generated a decimated sample.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquenos.cassandra.pvarchiver.controlsystem.SampleDecimator

buildDecimatedSample, getDecimatedSample, getDecimatedSampleEstimatedSize, processSample

Constructor Detail

AbstractSampleDecimator

public AbstractSampleDecimator(String channelName,
                               long intervalStartTime,
                               long intervalLength)

Creates the sample decimator and initializes the channel name and the interval start-time and length with the specified values.

Parameters:

channelName - name identifying the channel covered by this sample decimator.

intervalStartTime - start time of the interval covered by this sample decimator. The time is specified as the number of nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC).

intervalLength - length of the interval covered by this sample decimator. The length is specified in nanoseconds.

Method Detail

getChannelName

public String getChannelName()

Description copied from interface: SampleDecimator

Returns the name of the channel for which this sample decimator decimates samples. The returned channel name is the name that was specified when this sample decimator was created.

Specified by:

getChannelName in interface SampleDecimator<SampleType extends Sample>

Returns:

name identifying the channel covered by this sample decimator.

getIntervalLength

public long getIntervalLength()

Description copied from interface: SampleDecimator

Returns the length of the period for which this sample decimator generates a decimated sample. The length is specified in nanoseconds. The returned length is the length that was specified when this sample decimator was created.

The period covered by this sample decimator is specified by the interval [start time, start + length).

Specified by:

getIntervalLength in interface SampleDecimator<SampleType extends Sample>

Returns:

length of the period covered by this sample decimator (in nanosconds).

getIntervalStartTime

public long getIntervalStartTime()

Description copied from interface: SampleDecimator

Returns the start time of the period for which this sample decimator generated a decimated sample. The start time is specified as the number of nanoseconds since epoch (January 1st, 1970, 00:00:00 UTC). The returned start time is the time that was specified when this sample decimator was created.

The period covered by this sample decimator is specified by the interval [start time, start + length).

Specified by:

getIntervalStartTime in interface SampleDecimator<SampleType extends Sample>

Returns:

start time of the period covered by this sample decimator.