HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
- - ch.systemsx.cisd.hdf5.HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder

Enclosing class:: HDF5IntStorageFeatures

public static final class HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder
extends ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder

A builder for storage features.

Constructor Summary

Constructors
Constructor and Description

HDF5IntStorageFeatureBuilder()

HDF5IntStorageFeatureBuilder(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures template)

Constructors
Constructor and Description
`HDF5IntStorageFeatureBuilder()`
`HDF5IntStorageFeatureBuilder(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures template)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`	`chunkedStorageLayout()` Set a chunked layout for the dataset.
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`	`compactStorageLayout()` Set a compact layout for the dataset.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`compress()` Compress the dataset with default deflation level.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`compress(boolean compress)` Compresses the dataset with default deflation level, if `compress==true`, do not compress if `compress==false`.
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`	`contiguousStorageLayout()` Set a contiguous layout for the dataset.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`datasetReplacementEnforceKeepExisting()` Set the dataset replacement policy for existing datasets to `HDF5AbstractStorageFeatures.DataSetReplacementPolicy.ENFORCE_KEEP_EXISTING` .
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`datasetReplacementEnforceReplaceWithNew()` Set the dataset replacement policy for existing datasets to `HDF5AbstractStorageFeatures.DataSetReplacementPolicy.ENFORCE_REPLACE_WITH_NEW` .
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`datasetReplacementPolicy(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.DataSetReplacementPolicy datasetReplacementPolicy)` Set the dataset replacement policy for existing datasets.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`datasetReplacementUseWriterDefault()` Set the dataset replacement policy for existing datasets to `HDF5AbstractStorageFeatures.DataSetReplacementPolicy.USE_WRITER_DEFAULT` .
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`	`defaultStorageLayout()` Let a heuristic choose the right layout for the dataset.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`deflateLevel(byte deflateLevel)` Compresses this dataset with the given `deflateLevel`.
`HDF5IntStorageFeatures`	`features()` Returns the storage features corresponding to this builder's values.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`noScaling()` Disables the scaling pre-filter.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`scalingFactor(byte scalingFactor)` Sets the scaling factor for an integer scaling pre-filter.
`ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder`	`shuffleBeforeDeflate()` Sets a shuffling pre-filter for deflation.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`shuffleBeforeDeflate(boolean shuffleBeforeDeflate)` Sets a shuffling pre-filter for deflation if `shuffleBeforeDeflate==true` and disables it if `shuffleBeforeDeflate==false`.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`signed(boolean signed)` Sets that the integer values should be stored as signed integers if `signed==true` and as unsigned integers if `signed==false`.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`storageLayout(HDF5StorageLayout proposedLayout)` Set the layout for the dataset.
`HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder`	`unsigned()` Sets that the integer values should be stored as unsigned integers.

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
noShuffleBeforeDeflate

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

- Constructor Detail
  - HDF5IntStorageFeatureBuilder
```
public HDF5IntStorageFeatureBuilder()
```
  - HDF5IntStorageFeatureBuilder
```
public HDF5IntStorageFeatureBuilder(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures template)
```
- Method Detail
  - signed
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder signed(boolean signed)
```
    Sets that the integer values should be stored as signed integers if signed==true and as unsigned integers if signed==false.
  - unsigned
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder unsigned()
```
    Sets that the integer values should be stored as unsigned integers.
  - compress
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder compress(boolean compress)
```
    Compresses the dataset with default deflation level, if compress==true, do not compress if compress==false.
    
    Overrides:
    
    compress in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - compress
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder compress()
```
    Compress the dataset with default deflation level.
    
    Overrides:
    
    compress in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - deflateLevel
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder deflateLevel(byte deflateLevel)
```
    Compresses this dataset with the given deflateLevel. NO_DEFLATION_LEVEL means: do not compress. A good default value is DEFAULT_DEFLATION_LEVEL, the maximum value supported is MAX_DEFLATION_LEVEL.
    
    Overrides:
    
    deflateLevel in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - scalingFactor
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder scalingFactor(byte scalingFactor)
```
    Sets the scaling factor for an integer scaling pre-filter.
    
    Overrides:
    
    scalingFactor in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - noScaling
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder noScaling()
```
    Disables the scaling pre-filter.
    
    Overrides:
    
    noScaling in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - shuffleBeforeDeflate
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder shuffleBeforeDeflate(boolean shuffleBeforeDeflate)
```
    Sets a shuffling pre-filter for deflation if shuffleBeforeDeflate==true and disables it if shuffleBeforeDeflate==false. Theshuffling pre-filter may improve the compression level but may also increase the compression time.
    Only takes effect if compression is switched on.
    
    Overrides:
    
    shuffleBeforeDeflate in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - shuffleBeforeDeflate
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder shuffleBeforeDeflate()
```
    Sets a shuffling pre-filter for deflation. This may improve the compression level but may also increase the compression time.
    Only takes effect if compression is switched on.
    
    Overrides:
    
    shuffleBeforeDeflate in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
    
    See Also:
    
    compress(), deflateLevel(byte)
  - storageLayout
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder storageLayout(HDF5StorageLayout proposedLayout)
```
    Set the layout for the dataset.
    
    Overrides:
    
    storageLayout in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - compactStorageLayout
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder compactStorageLayout()
```
    Set a compact layout for the dataset.
    
    Overrides:
    
    compactStorageLayout in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - contiguousStorageLayout
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder contiguousStorageLayout()
```
    Set a contiguous layout for the dataset.
    
    Overrides:
    
    contiguousStorageLayout in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - chunkedStorageLayout
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder chunkedStorageLayout()
```
    Set a chunked layout for the dataset.
    
    Overrides:
    
    chunkedStorageLayout in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - defaultStorageLayout
```
public ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder defaultStorageLayout()
```
    Let a heuristic choose the right layout for the dataset.
    
    Overrides:
    
    defaultStorageLayout in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - datasetReplacementPolicy
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder datasetReplacementPolicy(ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.DataSetReplacementPolicy datasetReplacementPolicy)
```
    Set the dataset replacement policy for existing datasets.
    
    Overrides:
    
    datasetReplacementPolicy in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - datasetReplacementUseWriterDefault
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder datasetReplacementUseWriterDefault()
```
    Set the dataset replacement policy for existing datasets to HDF5AbstractStorageFeatures.DataSetReplacementPolicy.USE_WRITER_DEFAULT .
    
    Overrides:
    
    datasetReplacementUseWriterDefault in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - datasetReplacementEnforceKeepExisting
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder datasetReplacementEnforceKeepExisting()
```
    Set the dataset replacement policy for existing datasets to HDF5AbstractStorageFeatures.DataSetReplacementPolicy.ENFORCE_KEEP_EXISTING .
    
    Overrides:
    
    datasetReplacementEnforceKeepExisting in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - datasetReplacementEnforceReplaceWithNew
```
public HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder datasetReplacementEnforceReplaceWithNew()
```
    Set the dataset replacement policy for existing datasets to HDF5AbstractStorageFeatures.DataSetReplacementPolicy.ENFORCE_REPLACE_WITH_NEW .
    
    Overrides:
    
    datasetReplacementEnforceReplaceWithNew in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder
    
    Returns:
    
    This builder.
  - features
```
public HDF5IntStorageFeatures features()
```
    Returns the storage features corresponding to this builder's values.
    
    Specified by:
    
    features in class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder

Class HDF5IntStorageFeatures.HDF5IntStorageFeatureBuilder

Constructor Summary

Method Summary

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5AbstractStorageFeatures.HDF5AbstractStorageFeatureBuilder

Methods inherited from class java.lang.Object

Constructor Detail

HDF5IntStorageFeatureBuilder

HDF5IntStorageFeatureBuilder

Method Detail

signed

unsigned

compress

compress

deflateLevel

scalingFactor

noScaling

shuffleBeforeDeflate

shuffleBeforeDeflate

storageLayout

compactStorageLayout

contiguousStorageLayout

chunkedStorageLayout

defaultStorageLayout

datasetReplacementPolicy

datasetReplacementUseWriterDefault

datasetReplacementEnforceKeepExisting

datasetReplacementEnforceReplaceWithNew

features