com.aquenos.cassandra.pvarchiver.server.database

Class ChannelMetaDataDAO.ChannelInformation

java.lang.Object

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

Enclosing interface:

ChannelMetaDataDAO

public static final class ChannelMetaDataDAO.ChannelInformation
extends Object

Value object representing the general meta-data for a channel. The meta-data includes the control-system type, the decimation levels defined for the channel, and the ID of the server responsible for the channel.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ChannelInformation(UUID channelDataId, String channelName, String controlSystemType, Set<Integer> decimationLevels, UUID serverId) Creates a channel information 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.
Set<Integer>	getDecimationLevels() Returns the set of decimation levels defined for this channel.
UUID	getServerId() Returns the ID of the server that is responsible for this channel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelInformation

public ChannelInformation(UUID channelDataId,
                          String channelName,
                          String controlSystemType,
                          Set<Integer> decimationLevels,
                          UUID serverId)

Creates a channel information 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.

decimationLevels - set of decimation levels defined for this channel. Typically, a channel at least has raw data (decimation level zero) associated with it. A decimation level is identified by the number of seconds between two samples. All decimation levels except the zero decimation level, which stores raw data, have fixed periods between samples.

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

Throws:

IllegalArgumentException - if the channelName is the empty string and if the decimationLevels set is empty.

NullPointerException - if the channelDataId, the channelName, the controlSystemType, or the decimationLevels are null and if the decimationLevels set contains null elements.

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.

getDecimationLevels

public Set<Integer> getDecimationLevels()

Returns the set of decimation levels defined for this channel. Typically, a channel at least has raw data (decimation level zero) associated with it. A decimation level is identified by the number of seconds between two samples. All decimation levels except the zero decimation level, which stores raw data, have fixed periods between samples.

Returns:

set of decimation levels defined for the 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