Package ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto

Class ImageChannel

java.lang.Object

ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.ImageChannel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ImageChannel>

@JsonObject("ImageChannel")
public class ImageChannel
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ImageChannel>

A class that represents an image channel.

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImageChannel(java.lang.String code, java.lang.String label)
ImageChannel(java.lang.String code, java.lang.String label, java.lang.String description, java.lang.Integer wavelength, java.util.List<ImageTransformationInfo> transformations)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ImageChannel imageChannel)
boolean	equals(java.lang.Object obj)
java.lang.String	getCode()	Returns the channel code.
java.lang.String	getLabel()	Returns the channel label.
java.util.List<ImageTransformationInfo>	getTransformations()	Returns the transformations defined for this channel.
int	hashCode()
java.lang.String	toString()
java.lang.String	tryGetDescription()	Returns the channel' description or null, if this channel has no description.
java.lang.Integer	tryGetWavelength()	Returns the channel's wavelength or null, if the wavelength is not known.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageChannel

public ImageChannel(java.lang.String code,
                    java.lang.String label)

ImageChannel

public ImageChannel(java.lang.String code,
                    java.lang.String label,
                    java.lang.String description,
                    java.lang.Integer wavelength,
                    java.util.List<ImageTransformationInfo> transformations)

Method Detail

getCode

public java.lang.String getCode()

Returns the channel code.

getLabel

public java.lang.String getLabel()

Returns the channel label.

tryGetDescription

public java.lang.String tryGetDescription()

Returns the channel' description or null, if this channel has no description.

tryGetWavelength

public java.lang.Integer tryGetWavelength()

Returns the channel's wavelength or null, if the wavelength is not known.

getTransformations

public java.util.List<ImageTransformationInfo> getTransformations()

Returns the transformations defined for this channel. May be empty, if there are no transformations defined.

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(ImageChannel imageChannel)

Specified by:

compareTo in interface java.lang.Comparable<ImageChannel>