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
|
/*
* 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;
import hdf.hdf5lib.exceptions.HDF5JavaException;
/**
* An interface that provides methods for reading enumeration values from HDF5 files.
* <p>
* Obtain an object implementing this interface by calling {@link IHDF5Reader#enumeration()}.
*
* @author Bernd Rinn
*/
public interface IHDF5EnumReader extends IHDF5EnumTypeRetriever
{
// /////////////////////
// Attributes
// /////////////////////
/**
* Reads an <code>enum</code> attribute named <var>attributeName</var> from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param attributeName The name of the attribute to read.
* @return The attribute value read from the data set as a String.
* @throws HDF5JavaException If the attribute is not an enum type.
*/
public String getAttrAsString(final String objectPath, final String attributeName)
throws HDF5JavaException;
/**
* Reads an <code>enum</code> attribute named <var>attributeName</var> from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param attributeName The name of the attribute to read.
* @return The attribute value read from the data set.
* @throws HDF5JavaException If the attribute is not an enum type.
*/
public HDF5EnumerationValue getAttr(final String objectPath, final String attributeName)
throws HDF5JavaException;
/**
* Reads an <code>enum</code> attribute named <var>attributeName</var> from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param attributeName The name of the attribute to read.
* @param enumClass the {@link Enum} class to represent the values of.
* @return The attribute value read from the data set.
* @throws HDF5JavaException If the attribute is not an enum type.
*/
public <T extends Enum<T>> T getAttr(final String objectPath,
final String attributeName, Class<T> enumClass) throws HDF5JavaException;
/**
* Reads an <code>enum</code> array (of rank 1) attribute named <var>attributeName</var> from
* the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param attributeName The name of the attribute to read.
* @return The attribute values as read from the data set.
* @throws HDF5JavaException If the attribute is not an enum type.
*/
public HDF5EnumerationValueArray getArrayAttr(final String objectPath,
final String attributeName) throws HDF5JavaException;
/**
* Reads an <code>enum</code> array (of rank 1) attribute named <var>attributeName</var> from
* the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param attributeName The name of the attribute to read.
* @return The attribute values as read from the data set.
* @throws HDF5JavaException If the attribute is not an enum type.
*/
public HDF5EnumerationValueMDArray getMDArrayAttr(final String objectPath,
final String attributeName) throws HDF5JavaException;
// /////////////////////
// Data Sets
// /////////////////////
/**
* Reads an <code>Enum</code> value from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @return The data read from the data set as a String.
* @throws HDF5JavaException If the <var>objectPath</var> is not an enum type.
*/
public String readAsString(final String objectPath) throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValue read(final String objectPath) throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumClass the {@link Enum} class to represent the values of.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var> or if
* <var>enumClass</var> is incompatible with the HDF5 enumeration type of
* <var>objectPath</var>.
*/
public <T extends Enum<T>> T read(final String objectPath, Class<T> enumClass)
throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value from the data set <var>objectPath</var>.
* <p>
* This method is faster than {@link #read(String)} if the {@link HDF5EnumerationType} is
* already available.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enum type in the HDF5 file.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValue read(final String objectPath, final HDF5EnumerationType enumType)
throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enumeration type of this array.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValueArray readArray(final String objectPath,
final HDF5EnumerationType enumType) throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value array from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValueArray readArray(final String objectPath)
throws HDF5JavaException;
/**
* Reads an <code>Enum</code> value array block from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The block size (this will be the return value of the
* {@link HDF5EnumerationValueArray#getLength()} returned if the data set is long
* enough).
* @param blockNumber The number of the block to read (starting with 0, offset: multiply with
* <var>blockSize</var>).
* @return The data read from the data set. The length will be min(size - blockSize*blockNumber,
* blockSize).
*/
public HDF5EnumerationValueArray readArrayBlock(final String objectPath,
final int blockSize, final long blockNumber);
/**
* Reads an <code>Enum</code> value array block from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enumeration type of this array.
* @param blockSize The block size (this will be the return value of the
* {@link HDF5EnumerationValueArray#getLength()} returned if the data set is long
* enough).
* @param blockNumber The number of the block to read (starting with 0, offset: multiply with
* <var>blockSize</var>).
* @return The data read from the data set. The length will be min(size - blockSize*blockNumber,
* blockSize).
*/
public HDF5EnumerationValueArray readArrayBlock(final String objectPath,
final HDF5EnumerationType enumType, final int blockSize, final long blockNumber);
/**
* Reads an <code>Enum</code> value array block from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The block size (this will be the return value of the
* {@link HDF5EnumerationValueArray#getLength()} returned if the data set is long
* enough).
* @param offset The offset of the block in the data set to start reading from (starting with
* 0).
* @return The data read from the data set. The length will be min(size - blockSize*blockNumber,
* blockSize).
*/
public HDF5EnumerationValueArray readArrayBlockWithOffset(final String objectPath,
final int blockSize, final long offset);
/**
* Reads an <code>Enum</code> value array block from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enumeration type of this array.
* @param blockSize The block size (this will be the return value of the
* {@link HDF5EnumerationValueArray#getLength()} returned if the data set is long
* enough).
* @param offset The offset of the block in the data set to start reading from (starting with
* 0).
* @return The data read from the data set. The length will be min(size - blockSize*blockNumber,
* blockSize).
*/
public HDF5EnumerationValueArray readArrayBlockWithOffset(final String objectPath,
final HDF5EnumerationType enumType, final int blockSize, final long offset);
/**
* Reads an <code>Enum</code> array (of rank N) from the data set <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValueMDArray readMDArray(final String objectPath)
throws HDF5JavaException;
/**
* Reads an <code>Enum</code> array (of rank N) from the data set <var>objectPath</var>.
* <p>
* This method is faster than {@link #read(String)} if the {@link HDF5EnumerationType} is
* already available.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enum type in the HDF5 file.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not of <var>enumType</var>.
*/
public HDF5EnumerationValueMDArray readMDArray(final String objectPath,
final HDF5EnumerationType enumType) throws HDF5JavaException;
/**
* Reads a block from a <code>Enum</code> array block (of rank N) from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param type The type definition of this enumeration type.
* @param blockDimensions The extent of the block to write along each axis.
* @param blockNumber The number of the block to write along each axis.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not an enum data set.
*/
public HDF5EnumerationValueMDArray readMDArrayBlock(final String objectPath,
final HDF5EnumerationType type, final int[] blockDimensions, final long[] blockNumber)
throws HDF5JavaException;
/**
* Reads a block from a <code>Enum</code> array block (of rank N) from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The extent of the block to write along each axis.
* @param blockNumber The number of the block to write along each axis.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not an enum data set.
*/
public HDF5EnumerationValueMDArray readMDArrayBlock(final String objectPath,
final int[] blockDimensions, final long[] blockNumber) throws HDF5JavaException;
/**
* Reads a block from a <code>Enum</code> array block (of rank N) from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param type The type definition of this <code>Enum</code> type.
* @param blockDimensions The extent of the block to write along each axis.
* @param offset The offset of the block to write in the data set along each axis.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not an enum data set.
*/
public HDF5EnumerationValueMDArray readMDArrayBlockWithOffset(final String objectPath,
final HDF5EnumerationType type, final int[] blockDimensions, final long[] offset)
throws HDF5JavaException;
/**
* Reads a block from a <code>Enum</code> array block (of rank N) from the data set
* <var>objectPath</var>.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The extent of the block to write along each axis.
* @param offset The offset of the block to write in the data set along each axis.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not an enum data set.
*/
public HDF5EnumerationValueMDArray readMDArrayBlockWithOffset(final String objectPath,
final int[] blockDimensions, final long[] offset) throws HDF5JavaException;
/**
* Provides all natural blocks of this one-dimensional data set to iterate over.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @see HDF5DataBlock
* @throws HDF5JavaException If the data set is not of rank 1.
*/
public Iterable<HDF5DataBlock<HDF5EnumerationValueArray>> getArrayBlocks(
final String objectPath) throws HDF5JavaException;
/**
* Provides all natural blocks of this one-dimensional data set to iterate over.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param enumType The enumeration type of this array.
* @see HDF5DataBlock
* @throws HDF5JavaException If the data set is not of rank 1.
*/
public Iterable<HDF5DataBlock<HDF5EnumerationValueArray>> getArrayBlocks(
final String objectPath, final HDF5EnumerationType enumType) throws HDF5JavaException;
/**
* Provides all natural blocks of this multi-dimensional data set to iterate over.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param type The type definition of this enum type.
* @see HDF5MDDataBlock
* @throws HDF5JavaException If the data set is not an enum data set.
*/
public Iterable<HDF5MDEnumBlock> getMDArrayBlocks(final String objectPath,
final HDF5EnumerationType type) throws HDF5JavaException;
/**
* Provides all natural blocks of this multi-dimensional data set to iterate over.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @see HDF5MDDataBlock
* @throws HDF5JavaException If the data set is not an enum data set.
*/
public Iterable<HDF5MDEnumBlock> getMDArrayBlocks(final String objectPath)
throws HDF5JavaException;
}
|
