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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
/*
* 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;
/**
* An interface that provides methods for writing time duration values from HDF5 files.
* <p>
* Obtain an object implementing this interface by calling {@link IHDF5Writer#duration()}.
*
* @author Bernd Rinn
*/
public interface IHDF5TimeDurationWriter extends IHDF5TimeDurationReader
{
// /////////////////////
// Attributes
// /////////////////////
/**
* Set a time duration value as attribute on the referenced object.
* <p>
* The referenced object must exist, that is it need to have been written before by one of the
* <code>write()</code> methods.
*
* @param objectPath The name of the object to add the attribute to.
* @param attributeName The name of the attribute.
* @param timeDuration The value of the attribute.
* @param timeUnit The unit of the attribute.
*/
public void setAttr(String objectPath, String attributeName,
long timeDuration, HDF5TimeUnit timeUnit);
/**
* Set a time duration value as attribute on the referenced object.
* <p>
* The referenced object must exist, that is it need to have been written before by one of the
* <code>write()</code> methods.
*
* @param objectPath The name of the object to add the attribute to.
* @param attributeName The name of the attribute.
* @param timeDuration The value of the attribute.
*/
public void setAttr(String objectPath, String attributeName,
HDF5TimeDuration timeDuration);
/**
* Set a time duration array value as attribute on the referenced object. The smallest time unit
* in <var>timeDurations</var> will be used as the time unit of the array.
* <p>
* The referenced object must exist, that is it need to have been written before by one of the
* <code>write()</code> methods.
* <p>
* <em>Note: Time durations are stored as a <code>long[]</code> array.</em>
*
* @param objectPath The name of the object to add the attribute to.
* @param attributeName The name of the attribute.
* @param timeDurations The value of the attribute.
*/
public void setArrayAttr(String objectPath, String attributeName,
HDF5TimeDurationArray timeDurations);
/**
* Set a multi-dimensional time duration array value as attribute on the referenced object. The
* smallest time unit in <var>timeDurations</var> will be used as the time unit of the array.
* <p>
* The referenced object must exist, that is it need to have been written before by one of the
* <code>write()</code> methods.
* <p>
* <em>Note: Time durations are stored as a <code>long[]</code> array.</em>
*
* @param objectPath The name of the object to add the attribute to.
* @param attributeName The name of the attribute.
* @param timeDurations The value of the attribute.
*/
public void setMDArrayAttr(String objectPath, String attributeName,
HDF5TimeDurationMDArray timeDurations);
// /////////////////////
// Data Sets
// /////////////////////
/**
* Writes out a time duration value.
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param timeDuration The duration of time to write in the given <var>timeUnit</var>.
* @param timeUnit The unit of the time duration.
*/
public void write(String objectPath, long timeDuration, HDF5TimeUnit timeUnit);
/**
* Writes out a time duration value.
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param timeDuration The duration of time to write.
*/
public void write(String objectPath, HDF5TimeDuration timeDuration);
/**
* Creates a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long</code> values.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param size The size of the byte array to create. This will be the total size for
* non-extendable data sets and the size of one chunk for extendable (chunked) data
* sets. For extendable data sets the initial size of the array will be 0, see
* {@link ch.systemsx.cisd.hdf5.IHDF5WriterConfigurator#dontUseExtendableDataTypes}.
* @param timeUnit The unit of the time duration.
*/
public void createArray(String objectPath, int size, HDF5TimeUnit timeUnit);
/**
* Creates a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param size The size of the data set to create.
* @param blockSize The size of one block (for block-wise IO). Ignored if no extendable data
* sets are used (see {@link IHDF5WriterConfigurator#dontUseExtendableDataTypes()})
* and <code>deflate == false</code>.
* @param timeUnit The unit of the time duration.
*/
public void createArray(String objectPath, long size, int blockSize,
HDF5TimeUnit timeUnit);
/**
* Creates a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param size The size of the data set to create.
* @param blockSize The size of one block (for block-wise IO). Ignored if no extendable data
* sets are used (see {@link IHDF5WriterConfigurator#dontUseExtendableDataTypes()})
* and <code>deflate == false</code>.
* @param timeUnit The unit of the time duration.
* @param features The storage features of the data set.
*/
public void createArray(String objectPath, long size, int blockSize,
HDF5TimeUnit timeUnit, HDF5GenericStorageFeatures features);
/**
* Creates a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param size The size of the array to create. This will be the total size for non-extendable
* data sets and the size of one chunk for extendable (chunked) data sets. For
* extendable data sets the initial size of the array will be 0, see
* {@link HDF5GenericStorageFeatures}.
* @param timeUnit The unit of the time duration.
* @param features The storage features of the data set.
*/
public void createArray(String objectPath, int size, HDF5TimeUnit timeUnit,
HDF5GenericStorageFeatures features);
/**
* Writes out a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param timeDurations The time durations to write.
*/
public void writeArray(String objectPath, HDF5TimeDurationArray timeDurations);
/**
* Writes out a time duration array (of rank 1).
* <p>
* <em>Note: Time durations are stored as <code>long[]</code> arrays and tagged as the according
* type variant.</em>
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param timeDurations The time durations to write.
* @param features The storage features used to store the array.
*/
public void writeArray(String objectPath, HDF5TimeDurationArray timeDurations,
HDF5IntStorageFeatures features);
/**
* Writes out a block of a time duration array. The data set needs to have been created by
* {@link #createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures)} beforehand.
* <p>
* <i>Note:</i> For best performance, the block size in this method should be chosen to be equal
* to the <var>blockSize</var> argument of the
* {@link #createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures)} call that
* was used to create the data set.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. The length defines the block size. Must not be
* <code>null</code> or of length 0.
* @param blockNumber The number of the block to write.
*/
public void writeArrayBlock(String objectPath, HDF5TimeDurationArray data,
long blockNumber);
/**
* Writes out a block of a time duration array. The data set needs to have been created by
* {@link #createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures)} beforehand.
* <p>
* Use this method instead of {@link #writeArrayBlock(String, HDF5TimeDurationArray, long)} if
* the total size of the data set is not a multiple of the block size.
* <p>
* <i>Note:</i> For best performance, the typical <var>dataSize</var> in this method should be
* chosen to be equal to the <var>blockSize</var> argument of the
* {@link #createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures)} call that
* was used to create the data set.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. The length defines the block size. Must not be
* <code>null</code> or of length 0.
* @param dataSize The (real) size of <code>data</code> (needs to be <code><= data.length</code>
* )
* @param offset The offset in the data set to start writing to.
*/
public void writeArrayBlockWithOffset(String objectPath,
HDF5TimeDurationArray data, int dataSize, long offset);
/**
* Writes out a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. Must not be <code>null</code>. All columns need to have the
* same length.
* @param features The storage features of the data set.
*/
public void writeMDArray(String objectPath, HDF5TimeDurationMDArray data,
HDF5IntStorageFeatures features);
/**
* Writes out a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. Must not be <code>null</code>. All columns need to have the
* same length.
*/
public void writeMDArray(String objectPath, HDF5TimeDurationMDArray data);
/**
* Creates a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param dimensions When the writer is configured to use extendable data types (see
* {@link IHDF5WriterConfigurator#dontUseExtendableDataTypes()}), the initial
* dimensions and the dimensions of a chunk of the array will be
* <var>dimensions</var>. When the writer is configured to <i>enforce</i> a
* on-extendable data set, the initial dimensions equal the dimensions and will be
* <var>dimensions</var>.
*/
public void createMDArray(String objectPath, int[] dimensions,
HDF5TimeUnit timeUnit);
/**
* Creates a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param dimensions The dimensions of the array.
* @param blockDimensions The dimensions of one block (chunk) of the array.
*/
public void createMDArray(String objectPath, long[] dimensions,
int[] blockDimensions, HDF5TimeUnit timeUnit);
/**
* Creates a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param dimensions The dimensions of the <code>long</code> array to create. When <i>requesting</i>
* a chunked data set (e.g. {@link HDF5IntStorageFeatures#INT_CHUNKED}),
* the initial size of the array will be 0 and the chunk size will be <var>dimensions</var>.
* When <i>allowing</i> a chunked data set (e.g.
* {@link HDF5IntStorageFeatures#INT_NO_COMPRESSION} when the writer is
* not configured to avoid extendable data types, see
* {@link IHDF5WriterConfigurator#dontUseExtendableDataTypes()}), the initial size
* and the chunk size of the array will be <var>dimensions</var>. When <i>enforcing</i> a
* on-extendable data set (e.g.
* {@link HDF5IntStorageFeatures#INT_CONTIGUOUS}), the initial size equals
* the total size and will be <var>dimensions</var>.
* @param features The storage features of the data set.
*/
public void createMDArray(String objectPath, int[] dimensions,
HDF5TimeUnit timeUnit, HDF5IntStorageFeatures features);
/**
* Creates a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param dimensions The dimensions of the array.
* @param blockDimensions The dimensions of one block (chunk) of the array.
* @param features The storage features of the data set.
*/
public void createMDArray(String objectPath, long[] dimensions,
int[] blockDimensions, HDF5TimeUnit timeUnit,
HDF5IntStorageFeatures features);
/**
* Writes out a block of a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. Must not be <code>null</code>. All columns need to have the
* same length.
* @param blockNumber The block number in each dimension (offset: multiply with the extend in
* the according dimension).
*/
public void writeMDArrayBlock(String objectPath, HDF5TimeDurationMDArray data,
long[] blockNumber);
/**
* Writes out a block of a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. Must not be <code>null</code>. All columns need to have the
* same length.
* @param offset The offset in the data set to start writing to in each dimension.
*/
public void writeMDArrayBlockWithOffset(String objectPath,
HDF5TimeDurationMDArray data, long[] offset);
/**
* Writes out a block of a multi-dimensional array of time durations.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param data The data to write. Must not be <code>null</code>.
* @param blockDimensions The dimensions of the block to write to the data set.
* @param offset The offset of the block in the data set to start writing to in each dimension.
* @param memoryOffset The offset of the block in the <var>data</var> array.
*/
public void writeMDArrayBlockWithOffset(String objectPath,
HDF5TimeDurationMDArray data, int[] blockDimensions, long[] offset,
int[] memoryOffset);
}
|
