Package ch.systemsx.cisd.openbis.dss.etl.dto.api

Class ImageStorageConfiguraton

java.lang.Object

ch.systemsx.cisd.common.reflection.AbstractHashable

ch.systemsx.cisd.openbis.dss.etl.dto.api.ImageStorageConfiguraton

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ImageStorageConfiguraton

public class ImageStorageConfiguraton
extends ch.systemsx.cisd.common.reflection.AbstractHashable
implements java.io.Serializable

Configuration of how images should be stored. By default:

• no thumbnails are generated
• original data are stored as they come (without additional compression).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImageStorageConfiguraton()

Method Summary

Modifier and Type	Method	Description
void	addThumbnailsStorageFormat(ThumbnailsStorageFormat thumbnailsStorageFormatOrNull)	Adds new thumbnails setting to the list
protected static void	appendNameAndObject(java.lang.StringBuilder buffer, java.lang.String name, java.lang.Object object)
static ImageStorageConfiguraton	createDefault()	Returns the default configuration.
IImageTransformerFactory	getImageTransformerFactory()
OriginalDataStorageFormat	getOriginalDataStorageFormat()
java.lang.Boolean	getStoreChannelsOnExperimentLevel()
java.util.List<ThumbnailsStorageFormat>	getThumbnailsStorageFormat()
void	setImageLibrary(ch.systemsx.cisd.openbis.dss.etl.dto.ImageLibraryInfo imageLibrary)	Sets the library which should be used to read the images.
void	setImageTransformerFactory(IImageTransformerFactory transformerFactory)	Allows for applying an image transformation on the fly when an image is fetched.
void	setOriginalDataStorageFormat(OriginalDataStorageFormat originalDataStorageFormat)
void	setOriginalDataStorageFormat(OriginalDataStorageFormat originalDataStorageFormat)
void	setStoreChannelsOnExperimentLevel(boolean storeChannelsOnExperimentLevel)	Signalizes that the channels should be saved on experiment level rather than dataset level.
void	setThumbnailsStorageFormat(ThumbnailsStorageFormat thumbnailsStorageFormatOrNull)	Set to null if no thumbnails should be generated.
void	switchOnThumbnailsGeneration()	Convenience method to switch on thumbnails generation with default settings.
java.lang.String	toString()
ch.systemsx.cisd.openbis.dss.etl.dto.ImageLibraryInfo	tryGetImageLibrary()

Methods inherited from class ch.systemsx.cisd.common.reflection.AbstractHashable

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageStorageConfiguraton

public ImageStorageConfiguraton()

Method Detail

createDefault

public static ImageStorageConfiguraton createDefault()

Returns the default configuration.

getThumbnailsStorageFormat

public java.util.List<ThumbnailsStorageFormat> getThumbnailsStorageFormat()

Returns:

null if no thumbnails should be generated

setThumbnailsStorageFormat

public void setThumbnailsStorageFormat(ThumbnailsStorageFormat thumbnailsStorageFormatOrNull)

Set to null if no thumbnails should be generated. Overrides previous thumbnails settings.

addThumbnailsStorageFormat

public void addThumbnailsStorageFormat(ThumbnailsStorageFormat thumbnailsStorageFormatOrNull)

Adds new thumbnails setting to the list

switchOnThumbnailsGeneration

public void switchOnThumbnailsGeneration()

Convenience method to switch on thumbnails generation with default settings. Overrides the results of setThumbnailsStorageFormat(ThumbnailsStorageFormat)!.

getOriginalDataStorageFormat

public OriginalDataStorageFormat getOriginalDataStorageFormat()

setOriginalDataStorageFormat

public void setOriginalDataStorageFormat(OriginalDataStorageFormat originalDataStorageFormat)

setOriginalDataStorageFormat

public void setOriginalDataStorageFormat(OriginalDataStorageFormat originalDataStorageFormat)

setStoreChannelsOnExperimentLevel

public void setStoreChannelsOnExperimentLevel(boolean storeChannelsOnExperimentLevel)

Signalizes that the channels should be saved on experiment level rather than dataset level. Will be ignored in case of microscopy where all channels are always saved at dataset level.

getStoreChannelsOnExperimentLevel

public java.lang.Boolean getStoreChannelsOnExperimentLevel()

getImageTransformerFactory

public IImageTransformerFactory getImageTransformerFactory()

setImageTransformerFactory

public void setImageTransformerFactory(IImageTransformerFactory transformerFactory)

Allows for applying an image transformation on the fly when an image is fetched.

setImageLibrary

public void setImageLibrary(ch.systemsx.cisd.openbis.dss.etl.dto.ImageLibraryInfo imageLibrary)

Sets the library which should be used to read the images.

tryGetImageLibrary

public ch.systemsx.cisd.openbis.dss.etl.dto.ImageLibraryInfo tryGetImageLibrary()

Returns:

library which should be used to read the images or null if the library is not specified.

toString

public java.lang.String toString()

Overrides:

toString in class ch.systemsx.cisd.common.reflection.AbstractHashable

appendNameAndObject

protected static final void appendNameAndObject(java.lang.StringBuilder buffer,
                                                java.lang.String name,
                                                java.lang.Object object)