1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
|
/*
* Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.systemsx.cisd.hdf5;
/**
* A builder class for {@link HDF5ArrayBlockParams}.
*/
public class HDF5ArrayBlockParamsBuilder
{
private HDF5ArrayBlockParamsBuilder()
{
// Cannot be instantiated.
}
/**
* Creates a parameter that reads the complete array.
*/
public static HDF5ArrayBlockParams array()
{
return new HDF5ArrayBlockParams();
}
/**
* Creates a parameter that reads an array block.
*
* @param dimensions The block dimensions.
*/
public static HDF5ArrayBlockParams block(int... dimensions)
{
final HDF5ArrayBlockParams params = new HDF5ArrayBlockParams();
params.blockDimensions = dimensions;
return params;
}
/**
* Creates a parameter that reads an array slice. The slice is defined by "bound indices", each of
* which is fixed to a given value. The data block read or written only contains the free
* (i.e. non-fixed) indices.
*
* @param boundIndices The array containing the values of the bound indices at the respective
* index positions, and -1 at the free index positions. For example an array of
* <code>new long[] { -1, -1, 5, -1, 7, -1 }</code> has 2 and 4 as bound indices and
* binds them to the values 5 and 7, respectively.
*/
public static HDF5ArrayBlockParams slice(long... boundIndices)
{
final HDF5ArrayBlockParams params = new HDF5ArrayBlockParams();
params.boundIndexArray = boundIndices;
return params;
}
/**
* Creates a parameter that reads or writes an array slice. The slice is defined by "bound indices",
* each of which is fixed to a given value. The data block read or written only contains the free
* (i.e. non-fixed) indices.
*
* @param boundIndices The mapping of indices to index values which should be bound. For example
* a map of <code>new IndexMap().mapTo(2, 5).mapTo(4, 7)</code> has 2 and 4 as bound
* indices and binds them to the values 5 and 7, respectively.
*/
public static HDF5ArrayBlockParams slice(IndexMap boundIndices)
{
final HDF5ArrayBlockParams params = new HDF5ArrayBlockParams();
params.boundIndexMap = boundIndices;
return params;
}
/**
* Creates a parameter that writes a block with given <var>blockIndex</var>.
*
* @param blockIndex The block index in each dimension (offset: multiply with the
* <var>blockDimensions</var> in the according dimension).
*/
public static HDF5ArrayBlockParams blockIndex(long... blockIndex)
{
final HDF5ArrayBlockParams params = new HDF5ArrayBlockParams();
params.blockIndex = blockIndex;
return params;
}
/**
* Creates a parameter that writes a block with given <var>blockOffset</var>.
*
* @param blockIndex The block index in each dimension (offset: multiply with the
* <var>blockDimensions</var> in the according dimension).
*/
public static HDF5ArrayBlockParams blockOffset(long... blockOffset)
{
final HDF5ArrayBlockParams params = new HDF5ArrayBlockParams();
params.blockOffset = blockOffset;
return params;
}
}
|