HDF5IntStorageFeatures (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.HDF5IntStorageFeatures

```
public final class HDF5IntStorageFeatures
extends java.lang.Object
```
An object representing the storage features that are to be used for an integer data set.
The ..._KEEP variants denote that the specified storage features should only be applied if a new data set has to be created. If the data set already exists, it will be kept with whatever storage features it has. Note that this may lead to an exception if the existing data set is non-extendable and the dimensions of the new data set differ from the dimensions of the existing data set.
The ..._DELETE variants denote that the specified storage features should always be applied. If the data set already exists, it will be deleted before the new data set is written. This is the default behavior. However, if the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting is given, the ..._DELETE variant can be used to override this setting on a case-by-case basis.
The available storage layouts are HDF5StorageLayout.COMPACT, HDF5StorageLayout.CONTIGUOUS or HDF5StorageLayout.CHUNKED can be chosen. Only HDF5StorageLayout.CHUNKED is extendable and can be compressed.
Two types of compressions are supported: deflation (the method used by gzip) and scaling, which can be used if the accuracy of the values are smaller than what the atomic data type can store. Note that scaling can be a lossy compression while deflation is always lossless. Scaling compression is only available with HDF5 1.8 and newer. Trying to use scaling in strict HDF5 1.6 compatibility mode will throw an IllegalStateException.
For deflation the deflation level can be chosen to get the right balance between speed of compression and compression ratio. Often the DEFAULT_DEFLATION_LEVEL will be the right choice.
For scaling, the scaling factor can be chosen that determines the accuracy of the values saved. For float values, the scaling factor determines the number of significant digits of the numbers. The algorithm used for scale compression is:
1. Calculate the minimum value of all values
2. Subtract the minimum value from all values
3. Store the number of bits specified as scalingFactor
Note that this compression is lossless if scalineFactor >= ceil(log2(max(values) - min(values) + 1). This in made sure when using INT_AUTO_SCALING, thus INT_AUTO_SCALING is always losless.
Contrary to float scaling compression, a lossy integer scaling compression is usually an error as the most significant bits are chopped of! The option to specify the scaling factor is meant to give you a way to use that you know the span of the values max(values) - min(values) rather than asking the library to waste time on computing it for you.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.DataSetReplacementPolicy` The policy on how to deal with write access to existing datasets.
`static class`	`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`
`static class`	`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder` A builder for storage features.

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`DEFAULT_DEFLATION_LEVEL` A constant that specifies the default deflation level (gzip compression).
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING` Represents automatic scaling for integer values.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE` Represents automatic scaling for integer values combined with deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE_DELETE` Represents automatic scaling for integer values combined with deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE_KEEP` Represents automatic scaling for integer values combined with deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE_UNSIGNED` Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE_UNSIGNED_DELETE` Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DEFLATE_UNSIGNED_KEEP` Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_DELETE` Represents automatic scaling for integer values.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_KEEP` Represents automatic scaling for integer values.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_UNSIGNED` Represents automatic scaling for integer values with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_UNSIGNED_DELETE` Represents automatic scaling for integer values with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_AUTO_SCALING_UNSIGNED_KEEP` Represents automatic scaling for integer values with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CHUNKED` Represents a chunked (extendable) storage layout.
`static HDF5IntStorageFeatures`	`INT_CHUNKED_DELETE` Represents a chunked (extendable) storage layout.
`static HDF5IntStorageFeatures`	`INT_CHUNKED_KEEP` Represents a chunked (extendable) storage layout.
`static HDF5IntStorageFeatures`	`INT_CHUNKED_UNSIGNED` Represents a chunked (extendable) storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CHUNKED_UNSIGNED_DELETE` Represents a chunked (extendable) storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CHUNKED_UNSIGNED_KEEP` Represents a chunked (extendable) storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_COMPACT` Represents a compact storage layout.
`static HDF5IntStorageFeatures`	`INT_COMPACT_DELETE` Represents a compact storage layout.
`static HDF5IntStorageFeatures`	`INT_COMPACT_KEEP` Represents a compact storage layout.
`static HDF5IntStorageFeatures`	`INT_COMPACT_UNSIGNED` Represents a compact storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_COMPACT_UNSIGNED_DELETE` Represents a compact storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_COMPACT_UNSIGNED_KEEP` Represents a compact storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS` Represents a contiguous storage layout.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS_DELETE` Represents a contiguous storage layout.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS_KEEP` Represents a contiguous storage layout.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS_UNSIGNED` Represents a contiguous storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS_UNSIGNED_DELETE` Represents a contiguous storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_CONTIGUOUS_UNSIGNED_KEEP` Represents a contiguous storage layout with unsigned integers.
`static HDF5IntStorageFeatures`	`INT_DEFLATE` Represents 'standard compression', that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_DELETE` Represents 'standard compression', that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_KEEP` Represents 'standard compression', that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX` Represents 'maximal compression', that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX_DELETE` Represents 'maximal compression', that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX_KEEP` Represents 'maximal compression', that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX_UNSIGNED` Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX_UNSIGNED_DELETE` Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_MAX_UNSIGNED_KEEP` Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_UNSIGNED` Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_UNSIGNED_DELETE` Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_DEFLATE_UNSIGNED_KEEP` Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION` Represents 'no compression', signed integers, use default storage layout.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION_DELETE` Represents 'no compression', use default storage layout.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION_KEEP` Represents 'no compression', use default storage layout.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION_UNSIGNED` Represents 'no compression', unsigned integers, use default storage layout.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION_UNSIGNED_DELETE` Represents 'no compression', unsigned integers, use default storage layout.
`static HDF5IntStorageFeatures`	`INT_NO_COMPRESSION_UNSIGNED_KEEP` Represents 'no compression', unsigned integers, use default storage layout.
`static HDF5IntStorageFeatures`	`INT_SHUFFLE_DEFLATE` Represents 'standard compression' with a pre-filter shuffle, that is deflation with the default deflation level.
`static byte`	`MAX_DEFLATION_LEVEL` A constant that specifies the maximal deflation level (gzip compression).
`static byte`	`NO_DEFLATION_LEVEL` A constant that specifies that no deflation should be used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`build()` Returns a new storage feature builder.
`static HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`build(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures template)` Returns a new storage feature builder, initializing from `template`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScaling(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the default deflation level and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScaling(int deflateLevel, byte scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflateLevel` and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScaling(int deflateLevel, byte scalingFactor, boolean keepDataSetIfExists)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflateLevel` and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScalingKeep(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the default deflation level and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScalingKeep(int deflateLevel, byte scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflateLevel` and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScalingUnsigned(int deflateLevel, byte scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflateLevel` and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflateAndIntegerScalingUnsigned(int deflateLevel, byte scalingFactor, boolean keepDataSetIfExists)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflateLevel` and integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createDeflation(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel`.
`static HDF5IntStorageFeatures`	`createDeflationDelete(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel`.
`static HDF5IntStorageFeatures`	`createDeflationKeep(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel`.
`static HDF5IntStorageFeatures`	`createDeflationUnsigned(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel`.
`static HDF5IntStorageFeatures`	`createDeflationUnsignedDelete(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel` for unsigned integers.
`static HDF5IntStorageFeatures`	`createDeflationUnsignedKeep(int deflationLevel)` Creates a `HDF5IntStorageFeatures` object that represents deflation with the given `deflationLevel` for unsigned integers.
`static HDF5IntStorageFeatures`	`createFromGeneric(HDF5GenericStorageFeatures storageFeatures)` Create a corresponding `HDF5IntStorageFeatures` for the given `HDF5GenericStorageFeatures`.
`static HDF5IntStorageFeatures`	`createIntegerScaling(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createIntegerScalingKeep(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createIntegerScalingUnsigned(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createIntegerScalingUnsignedKeep(int scalingFactor)` Creates a `HDF5IntStorageFeatures` object that represents integer scaling with the given `scalingFactor`.
`static HDF5IntStorageFeatures`	`createUnsignedFromGeneric(HDF5GenericStorageFeatures storageFeatures)` Create a corresponding `HDF5IntStorageFeatures` for the given `HDF5GenericStorageFeatures`.
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.DataSetReplacementPolicy`	`getDatasetReplacementPolicy()` Returns the policy of this storage feature object regarding replacing or keeping already existing datasets.
`byte`	`getDeflateLevel()` Returns the deflate level of this storage feature object.
`byte`	`getScalingFactor()` Returns the scaling factor of this storage feature object.
`boolean`	`isDeflating()` Returns `true`, if this storage feature object deflates data.
`boolean`	`isScaling()` Returns `true`, if this storage feature object scales data.
`boolean`	`isShuffleBeforeDeflate()` Returns `true`, if this storage feature object performs shuffling before deflating the data.
`boolean`	`isSigned()` Returns `true` if signed integers should be stored, `false` otherwise.
`HDF5StorageLayout`	`tryGetProposedLayout()` Returns the proposed storage layout, or `null`, if no particular storage layout should be proposed.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INT_NO_COMPRESSION
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION
```
    Represents 'no compression', signed integers, use default storage layout.
  - INT_NO_COMPRESSION_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION_UNSIGNED
```
    Represents 'no compression', unsigned integers, use default storage layout.
  - INT_NO_COMPRESSION_KEEP
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION_KEEP
```
    Represents 'no compression', use default storage layout.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_NO_COMPRESSION_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION_UNSIGNED_KEEP
```
    Represents 'no compression', unsigned integers, use default storage layout.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_NO_COMPRESSION_DELETE
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION_DELETE
```
    Represents 'no compression', use default storage layout.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_NO_COMPRESSION_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_NO_COMPRESSION_UNSIGNED_DELETE
```
    Represents 'no compression', unsigned integers, use default storage layout.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_COMPACT
```
public static final HDF5IntStorageFeatures INT_COMPACT
```
    Represents a compact storage layout.
  - INT_COMPACT_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_COMPACT_UNSIGNED
```
    Represents a compact storage layout with unsigned integers.
  - INT_COMPACT_KEEP
```
public static final HDF5IntStorageFeatures INT_COMPACT_KEEP
```
    Represents a compact storage layout.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_COMPACT_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_COMPACT_UNSIGNED_KEEP
```
    Represents a compact storage layout with unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_COMPACT_DELETE
```
public static final HDF5IntStorageFeatures INT_COMPACT_DELETE
```
    Represents a compact storage layout.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_COMPACT_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_COMPACT_UNSIGNED_DELETE
```
    Represents a compact storage layout with unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_CONTIGUOUS
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS
```
    Represents a contiguous storage layout.
  - INT_CONTIGUOUS_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS_UNSIGNED
```
    Represents a contiguous storage layout with unsigned integers.
  - INT_CONTIGUOUS_KEEP
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS_KEEP
```
    Represents a contiguous storage layout.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_CONTIGUOUS_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS_UNSIGNED_KEEP
```
    Represents a contiguous storage layout with unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_CONTIGUOUS_DELETE
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS_DELETE
```
    Represents a contiguous storage layout.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_CONTIGUOUS_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_CONTIGUOUS_UNSIGNED_DELETE
```
    Represents a contiguous storage layout with unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_CHUNKED
```
public static final HDF5IntStorageFeatures INT_CHUNKED
```
    Represents a chunked (extendable) storage layout.
  - INT_CHUNKED_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_CHUNKED_UNSIGNED
```
    Represents a chunked (extendable) storage layout with unsigned integers.
  - INT_CHUNKED_KEEP
```
public static final HDF5IntStorageFeatures INT_CHUNKED_KEEP
```
    Represents a chunked (extendable) storage layout.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_CHUNKED_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_CHUNKED_UNSIGNED_KEEP
```
    Represents a chunked (extendable) storage layout with unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_CHUNKED_DELETE
```
public static final HDF5IntStorageFeatures INT_CHUNKED_DELETE
```
    Represents a chunked (extendable) storage layout.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_CHUNKED_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_CHUNKED_UNSIGNED_DELETE
```
    Represents a chunked (extendable) storage layout with unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_DEFLATE
```
public static final HDF5IntStorageFeatures INT_DEFLATE
```
    Represents 'standard compression', that is deflation with the default deflation level.
  - INT_SHUFFLE_DEFLATE
```
public static final HDF5IntStorageFeatures INT_SHUFFLE_DEFLATE
```
    Represents 'standard compression' with a pre-filter shuffle, that is deflation with the default deflation level.
  - INT_DEFLATE_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_DEFLATE_UNSIGNED
```
    Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
  - INT_DEFLATE_KEEP
```
public static final HDF5IntStorageFeatures INT_DEFLATE_KEEP
```
    Represents 'standard compression', that is deflation with the default deflation level.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_DEFLATE_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_DEFLATE_UNSIGNED_KEEP
```
    Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_DEFLATE_DELETE
```
public static final HDF5IntStorageFeatures INT_DEFLATE_DELETE
```
    Represents 'standard compression', that is deflation with the default deflation level.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_DEFLATE_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_DEFLATE_UNSIGNED_DELETE
```
    Represents 'standard compression' with unsigned integers, that is deflation with the default deflation level.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_DEFLATE_MAX
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX
```
    Represents 'maximal compression', that is deflation with the maximal deflation level.
  - INT_DEFLATE_MAX_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX_UNSIGNED
```
    Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
  - INT_DEFLATE_MAX_KEEP
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX_KEEP
```
    Represents 'maximal compression', that is deflation with the maximal deflation level.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_DEFLATE_MAX_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX_UNSIGNED_KEEP
```
    Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_DEFLATE_MAX_DELETE
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX_DELETE
```
    Represents 'maximal compression', that is deflation with the maximal deflation level.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_DEFLATE_MAX_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_DEFLATE_MAX_UNSIGNED_DELETE
```
    Represents 'maximal compression' with unsigned integers, that is deflation with the maximal deflation level.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_AUTO_SCALING
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING
```
    Represents automatic scaling for integer values.
  - INT_AUTO_SCALING_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_UNSIGNED
```
    Represents automatic scaling for integer values with unsigned integers.
  - INT_AUTO_SCALING_KEEP
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_KEEP
```
    Represents automatic scaling for integer values.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_AUTO_SCALING_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_UNSIGNED_KEEP
```
    Represents automatic scaling for integer values with unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_AUTO_SCALING_DELETE
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DELETE
```
    Represents automatic scaling for integer values.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_AUTO_SCALING_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_UNSIGNED_DELETE
```
    Represents automatic scaling for integer values with unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_AUTO_SCALING_DEFLATE
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level.
  - INT_AUTO_SCALING_DEFLATE_UNSIGNED
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE_UNSIGNED
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
  - INT_AUTO_SCALING_DEFLATE_KEEP
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE_KEEP
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_AUTO_SCALING_DEFLATE_UNSIGNED_KEEP
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE_UNSIGNED_KEEP
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - INT_AUTO_SCALING_DEFLATE_DELETE
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE_DELETE
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - INT_AUTO_SCALING_DEFLATE_UNSIGNED_DELETE
```
public static final HDF5IntStorageFeatures INT_AUTO_SCALING_DEFLATE_UNSIGNED_DELETE
```
    Represents automatic scaling for integer values combined with deflation with the default deflation level, using unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - NO_DEFLATION_LEVEL
```
public static final byte NO_DEFLATION_LEVEL
```
    A constant that specifies that no deflation should be used.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DEFLATION_LEVEL
```
public static final byte DEFAULT_DEFLATION_LEVEL
```
    A constant that specifies the default deflation level (gzip compression).
    
    See Also:
    
    Constant Field Values
  - MAX_DEFLATION_LEVEL
```
public static final byte MAX_DEFLATION_LEVEL
```
    A constant that specifies the maximal deflation level (gzip compression).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - build
```
public static HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder build()
```
    Returns a new storage feature builder.
  - build
```
public static HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder build(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures template)
```
    Returns a new storage feature builder, initializing from template.
  - createFromGeneric
```
public static HDF5IntStorageFeatures createFromGeneric(HDF5GenericStorageFeatures storageFeatures)
```
    Create a corresponding HDF5IntStorageFeatures for the given HDF5GenericStorageFeatures.
  - createUnsignedFromGeneric
```
public static HDF5IntStorageFeatures createUnsignedFromGeneric(HDF5GenericStorageFeatures storageFeatures)
```
    Create a corresponding HDF5IntStorageFeatures for the given HDF5GenericStorageFeatures.
  - createDeflation
```
public static HDF5IntStorageFeatures createDeflation(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel.
  - createDeflationKeep
```
public static HDF5IntStorageFeatures createDeflationKeep(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel.
    Keep existing data set and apply only if a new data set has to be created.
  - createDeflationDelete
```
public static HDF5IntStorageFeatures createDeflationDelete(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - createDeflationUnsigned
```
public static HDF5IntStorageFeatures createDeflationUnsigned(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel.
  - createDeflationUnsignedKeep
```
public static HDF5IntStorageFeatures createDeflationUnsignedKeep(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel for unsigned integers.
    Keep existing data set and apply only if a new data set has to be created.
  - createDeflationUnsignedDelete
```
public static HDF5IntStorageFeatures createDeflationUnsignedDelete(int deflationLevel)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflationLevel for unsigned integers.
    Delete an existing data set before writing the new one. Always apply the chosen settings. This allows to overwrite the IHDF5WriterConfigurator.keepDataSetsIfTheyExist() setting.
  - createIntegerScaling
```
public static HDF5IntStorageFeatures createIntegerScaling(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents integer scaling with the given scalingFactor.
  - createIntegerScalingKeep
```
public static HDF5IntStorageFeatures createIntegerScalingKeep(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents integer scaling with the given scalingFactor.
    Keep existing data set and apply only if a new data set has to be created.
  - createIntegerScalingUnsigned
```
public static HDF5IntStorageFeatures createIntegerScalingUnsigned(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents integer scaling with the given scalingFactor.
  - createIntegerScalingUnsignedKeep
```
public static HDF5IntStorageFeatures createIntegerScalingUnsignedKeep(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents integer scaling with the given scalingFactor.
    Keep existing data set and apply only if a new data set has to be created.
  - createDeflateAndIntegerScaling
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScaling(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the default deflation level and integer scaling with the given scalingFactor.
  - createDeflateAndIntegerScalingKeep
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScalingKeep(int scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the default deflation level and integer scaling with the given scalingFactor.
    Keep existing data set and apply only if a new data set has to be created.
  - createDeflateAndIntegerScaling
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScaling(int deflateLevel,
                                                                    byte scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflateLevel and integer scaling with the given scalingFactor.
  - createDeflateAndIntegerScalingUnsigned
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScalingUnsigned(int deflateLevel,
                                                                            byte scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflateLevel and integer scaling with the given scalingFactor.
  - createDeflateAndIntegerScaling
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScaling(int deflateLevel,
                                                                    byte scalingFactor,
                                                                    boolean keepDataSetIfExists)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflateLevel and integer scaling with the given scalingFactor.
  - createDeflateAndIntegerScalingUnsigned
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScalingUnsigned(int deflateLevel,
                                                                            byte scalingFactor,
                                                                            boolean keepDataSetIfExists)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflateLevel and integer scaling with the given scalingFactor.
  - createDeflateAndIntegerScalingKeep
```
public static HDF5IntStorageFeatures createDeflateAndIntegerScalingKeep(int deflateLevel,
                                                                        byte scalingFactor)
```
    Creates a HDF5IntStorageFeatures object that represents deflation with the given deflateLevel and integer scaling with the given scalingFactor.
    Keep existing data set and apply only if a new data set has to be created.
  - isSigned
```
public boolean isSigned()
```
    Returns true if signed integers should be stored, false otherwise.
  - tryGetProposedLayout
```
public HDF5StorageLayout tryGetProposedLayout()
```
    Returns the proposed storage layout, or null, if no particular storage layout should be proposed.
  - getDatasetReplacementPolicy
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.DataSetReplacementPolicy getDatasetReplacementPolicy()
```
    Returns the policy of this storage feature object regarding replacing or keeping already existing datasets.
  - isDeflating
```
public boolean isDeflating()
```
    Returns true, if this storage feature object deflates data.
  - isScaling
```
public boolean isScaling()
```
    Returns true, if this storage feature object scales data.
  - isShuffleBeforeDeflate
```
public boolean isShuffleBeforeDeflate()
```
    Returns true, if this storage feature object performs shuffling before deflating the data.
  - getDeflateLevel
```
public byte getDeflateLevel()
```
    Returns the deflate level of this storage feature object. 0 means no deflate.
  - getScalingFactor
```
public byte getScalingFactor()
```
    Returns the scaling factor of this storage feature object. -1 means no scaling, 0 means auto-scaling.

Class HDF5IntStorageFeatures

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INT_NO_COMPRESSION

INT_NO_COMPRESSION_UNSIGNED

INT_NO_COMPRESSION_KEEP

INT_NO_COMPRESSION_UNSIGNED_KEEP

INT_NO_COMPRESSION_DELETE

INT_NO_COMPRESSION_UNSIGNED_DELETE

INT_COMPACT

INT_COMPACT_UNSIGNED

INT_COMPACT_KEEP

INT_COMPACT_UNSIGNED_KEEP

INT_COMPACT_DELETE

INT_COMPACT_UNSIGNED_DELETE

INT_CONTIGUOUS

INT_CONTIGUOUS_UNSIGNED

INT_CONTIGUOUS_KEEP

INT_CONTIGUOUS_UNSIGNED_KEEP

INT_CONTIGUOUS_DELETE

INT_CONTIGUOUS_UNSIGNED_DELETE

INT_CHUNKED

INT_CHUNKED_UNSIGNED

INT_CHUNKED_KEEP

INT_CHUNKED_UNSIGNED_KEEP

INT_CHUNKED_DELETE

INT_CHUNKED_UNSIGNED_DELETE

INT_DEFLATE

INT_SHUFFLE_DEFLATE

INT_DEFLATE_UNSIGNED

INT_DEFLATE_KEEP

INT_DEFLATE_UNSIGNED_KEEP

INT_DEFLATE_DELETE

INT_DEFLATE_UNSIGNED_DELETE

INT_DEFLATE_MAX

INT_DEFLATE_MAX_UNSIGNED

INT_DEFLATE_MAX_KEEP

INT_DEFLATE_MAX_UNSIGNED_KEEP

INT_DEFLATE_MAX_DELETE

INT_DEFLATE_MAX_UNSIGNED_DELETE

INT_AUTO_SCALING

INT_AUTO_SCALING_UNSIGNED

INT_AUTO_SCALING_KEEP

INT_AUTO_SCALING_UNSIGNED_KEEP

INT_AUTO_SCALING_DELETE

INT_AUTO_SCALING_UNSIGNED_DELETE

INT_AUTO_SCALING_DEFLATE

INT_AUTO_SCALING_DEFLATE_UNSIGNED

INT_AUTO_SCALING_DEFLATE_KEEP

INT_AUTO_SCALING_DEFLATE_UNSIGNED_KEEP

INT_AUTO_SCALING_DEFLATE_DELETE

INT_AUTO_SCALING_DEFLATE_UNSIGNED_DELETE

NO_DEFLATION_LEVEL

DEFAULT_DEFLATION_LEVEL

MAX_DEFLATION_LEVEL

Method Detail

build

build

createFromGeneric

createUnsignedFromGeneric

createDeflation

createDeflationKeep

createDeflationDelete

createDeflationUnsigned

createDeflationUnsignedKeep

createDeflationUnsignedDelete

createIntegerScaling

createIntegerScalingKeep

createIntegerScalingUnsigned

createIntegerScalingUnsignedKeep

createDeflateAndIntegerScaling

createDeflateAndIntegerScalingKeep

createDeflateAndIntegerScaling

createDeflateAndIntegerScalingUnsigned

createDeflateAndIntegerScaling

createDeflateAndIntegerScalingUnsigned

createDeflateAndIntegerScalingKeep