org.youscope.common.configuration

Class ChannelConfiguration

java.lang.Object

org.youscope.common.configuration.ChannelConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ChannelConfiguration>, Configuration

public final class ChannelConfiguration
extends java.lang.Object
implements Configuration, java.lang.Comparable<ChannelConfiguration>

Configuration of a channel, identified by its channel name and configuration group name.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChannelConfiguration() Constructor.
ChannelConfiguration(ChannelConfiguration configuration) Copy constructor.
ChannelConfiguration(java.lang.String channelGroup, java.lang.String channel) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks the current state of the configuration.
ChannelConfiguration	clone()
int	compareTo(ChannelConfiguration otherChannel)
void	copyConfiguration(ChannelConfiguration configuration) Copies the content of the channel configuration into this configuration.
boolean	equals(java.lang.Object obj)
java.lang.String	getChannel() The channel name.
java.lang.String	getChannelGroup() The channel group name.
java.lang.String	getTypeIdentifier() Returns a unique identifier for this configuration type.
int	hashCode()
void	setChannel(java.lang.String channel) Sets the name of the channel.
void	setChannel(java.lang.String channelGroup, java.lang.String channel) Sets the channel and channel group names.
void	setChannelGroup(java.lang.String channelGroup) Sets the name of the channel group.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelConfiguration

public ChannelConfiguration()

Constructor. The channel and channel group names are initialized to null.

ChannelConfiguration

public ChannelConfiguration(java.lang.String channelGroup,
                            java.lang.String channel)

Constructor.

Parameters:

channelGroup - The channel group name.

channel - The channel name.

ChannelConfiguration

public ChannelConfiguration(ChannelConfiguration configuration)

Copy constructor. If configuration is null, sets channel and channel group to null.

Parameters:

configuration - The configuration to copy.

Method Detail

getTypeIdentifier

public java.lang.String getTypeIdentifier()

Description copied from interface: Configuration

Returns a unique identifier for this configuration type. The identifier is used to determine factories and addons to construct and configure jobs, measurements, etc., given a corresponding configuration. Make sure that the ID returned is unique. The returned identifier should conform to "XXX.YYY", where XXX stands for an identifier of the organizational unit or the person who created the configuration (e.g. ETH, Smith, Cindarella), and YYY stands for an identifier of the specific kind of configuration (e.g. AutofocusJob, PlatePosition, MicroplateMeasurement). Optionally, additional hierarchy levels can be defined by additional separators ., e.g. "YouScope.AutofocusJob.Version1.1" The identifier should not contain spaces, non-ASCII characters, or colons (except for hierarchy level separation). Identifiers should start with a capital character, i.e. A-Z. Make sure to not use the same identifier for different configurations, since this might result in unexpected behavior or errors. Make

Specified by:

getTypeIdentifier in interface Configuration

Returns:

Unique identifier of the configuration type.

getChannel

public java.lang.String getChannel()

The channel name.

Returns:

Channel name.

getChannelGroup

public java.lang.String getChannelGroup()

The channel group name.

Returns:

Channel group name.

setChannel

public void setChannel(java.lang.String channel)

Sets the name of the channel. Should be always called together with setChannelGroup().

Parameters:

channel - Name of channel.

copyConfiguration

public void copyConfiguration(ChannelConfiguration configuration)

Copies the content of the channel configuration into this configuration. If configuration is null, sets the channel and channel group to null.

Parameters:

configuration - The channel configuration to copy.

setChannel

public void setChannel(java.lang.String channelGroup,
                       java.lang.String channel)

Sets the channel and channel group names.

Parameters:

channelGroup - Name of channel group.

channel - Name of channel.

setChannelGroup

public void setChannelGroup(java.lang.String channelGroup)

Sets the name of the channel group. Should always be called with setChannel().

Parameters:

channelGroup - Channel group name.

clone

public ChannelConfiguration clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ChannelConfiguration otherChannel)

Specified by:

compareTo in interface java.lang.Comparable<ChannelConfiguration>

checkConfiguration

public void checkConfiguration()
                        throws ConfigurationException

Description copied from interface: Configuration

Checks the current state of the configuration. If the configuration state is valid, the method returns normally. If not, a ConfigurationException is thrown describing the error, and what has to be changed in the configuration, by the user, such that it becomes valid. This error can then e.g. be displayed to the user (see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).

Specified by:

checkConfiguration in interface Configuration

Throws:

ConfigurationException