com.aquenos.cassandra.pvarchiver.server.database

Class ChannelMetaDataDAO.ChannelConfiguration

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.database.ChannelMetaDataDAO.ChannelConfiguration

Enclosing interface:

ChannelMetaDataDAO

public static final class ChannelMetaDataDAO.ChannelConfiguration
extends Object

Value object representing the configuration of a channel. This is the information that a server needs to start archiving for a channel.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ChannelConfiguration(UUID channelDataId, String channelName, String controlSystemType, Map<Integer,Long> decimationLevelToCurrentBucketStartTime, Map<Integer,Integer> decimationLevelToRetentionPeriod, boolean enabled, Map<String,String> options, UUID serverId) Creates a channel configuration object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
UUID	getChannelDataId() Returns the unique identifier that is associated with the data (samples) for the channel.
String	getChannelName() Returns the name of this channel.
String	getControlSystemType() Returns the control-system type of this channel.
Map<Integer,Long>	getDecimationLevelToCurrentBucketStartTime() Returns a map that contains the decimation levels for the channel as keys and the start time of the corresponding most recent sample buckets as values.
Map<Integer,Integer>	getDecimationLevelToRetentionPeriod() Returns a map that contains the retention periods of the decimation levels for the channel.
Map<String,String>	getOptions() Returns a map storing the configuration options for this channel.
UUID	getServerId() Returns the ID of the server that is responsible for this channel.
int	hashCode()
boolean	isEnabled() Tells whether archiving is enabled for this channel.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelConfiguration

public ChannelConfiguration(UUID channelDataId,
                            String channelName,
                            String controlSystemType,
                            Map<Integer,Long> decimationLevelToCurrentBucketStartTime,
                            Map<Integer,Integer> decimationLevelToRetentionPeriod,
                            boolean enabled,
                            Map<String,String> options,
                            UUID serverId)

Creates a channel configuration object.

Parameters:

channelDataId - unique identifier associated with the data (samples) for each channel. This identifier must be different for each channel. It is used instead of the channel name when storing data, so that the channel can be renamed later without losing data.

channelName - name of this channel. The name is a textual identifier that uniquely identifies the channel within the archive.

controlSystemType - control-system type of this channel. The control-system type defines the control-system that provides new data for the channel.

decimationLevelToCurrentBucketStartTime - map that contains the decimation levels for the channel as keys and the start time of the corresponding most recent sample buckets as values. If a decimation level does not yet have a sample bucket, the respective value is -1.

decimationLevelToRetentionPeriod - map that contains the retention periods of the decimation levels for the channel. The decimation levels are used as keys and the corresponding retention periods (in seconds) are stored as values. A retention period that is zero or negative means that samples for the corresponding decimation level are supposed to be retained forever.

enabled - true if archiving is enabled and the server should archive new samples received for the channel. false if archiving is disabled and the server should not archive new samples for the channel but just use the samples that have been archived previously.

options - map storing the configuration options for this channel. The configuration options are passed on to the control-system specific adapter. The meaning of the options depends on this control-system specific code. The map does not contain null keys or values.

serverId - ID of the server that is responsible for this channel.

Throws:

IllegalArgumentException - if the channelName is the empty string, if the decimationLevelToCurrentBucketStartTime map is empty, and if the decimationLevelToRetentionPeriod map is empty.

NullPointerException - if the channelDataId, the channelName, the controlSystemType, the decimationLevelToCurrentBucketStartTime map, or the decimationLevelToRetentionPeriod map, is null and if the decimationLevelToCurrentBucketStartTime map or the decimationLevelToRetentionPeriod map contains null keys or values.

Method Detail

getChannelDataId

public UUID getChannelDataId()

Returns the unique identifier that is associated with the data (samples) for the channel. While a channel's name might change due to renaming, the data ID will be permanent (until the channel is deleted), so even after renaming a channel, its associated data can still be found.

Returns:

unique identifier associated with the channel's data.

getChannelName

public String getChannelName()

Returns the name of this channel. The name is a textual identifier that uniquely identifies the channel within the archive.

Returns:

channel name.

getControlSystemType

public String getControlSystemType()

Returns the control-system type of this channel. The control-system type defines the control-system that provides new data for the channel.

Returns:

control-system type of the channel.

getDecimationLevelToCurrentBucketStartTime

public Map<Integer,Long> getDecimationLevelToCurrentBucketStartTime()

Returns a map that contains the decimation levels for the channel as keys and the start time of the corresponding most recent sample buckets as values. If a decimation level does not yet have a sample bucket, the respective value is -1.

Returns:

map mapping decimation levels to the start time of their current buckets.

getDecimationLevelToRetentionPeriod

public Map<Integer,Integer> getDecimationLevelToRetentionPeriod()

Returns a map that contains the retention periods of the decimation levels for the channel. The decimation levels are as used keys and the corresponding retention periods (in seconds) are stored as values. A retention period that is zero or negative means that samples for the corresponding decimation level are supposed to be retained forever.

Returns:

map mapping decimation levels to their retention periods.

isEnabled

public boolean isEnabled()

Tells whether archiving is enabled for this channel. If true, archiving is enabled and the server should archive new samples received for the channel. If false, archiving is disabled and the server should not archive new samples for the channel but just use the samples that have been archived previously.

Returns:

true if archiving is enabled for this channel, false otherwise.

getOptions

public Map<String,String> getOptions()

Returns a map storing the configuration options for this channel. The configuration options are passed on to the control-system specific adapter. The meaning of the options depends on this control-system specific code. The map does not contain null keys or values.

Returns:

map storing the configuration options for this channel.

getServerId

public UUID getServerId()

Returns the ID of the server that is responsible for this channel.

Returns:

ID of the server owning this channel.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object