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
|
/*
* 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;
import ch.systemsx.cisd.base.mdarray.MDArray;
/**
* An interface that provides methods for reading <code>String</code> values from HDF5 files.
* <p>
* Obtain an object implementing this interface by calling {@link IHDF5Reader#string()}.
*
* @author Bernd Rinn
*/
public interface IHDF5StringReader
{
// /////////////////////
// Attributes
// /////////////////////
/**
* Reads a string attribute named <var>attributeName</var> from the object
* <var>objectPath</var>. Considers '\0' as end of string.
*
* @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.
*/
public String getAttr(final String objectPath, final String attributeName);
/**
* Reads a string attribute named <var>attributeName</var> from the object
* <var>objectPath</var>. Does not consider '\0' as end of string but reads the full length of
* the attribute.
*
* @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.
*/
public String getAttrRaw(final String objectPath, final String attributeName);
/**
* Reads a string array attribute named <var>attributeName</var> from the object
* <var>objectPath</var>. Considers '\0' as end of string.
*
* @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.
*/
public String[] getArrayAttr(final String objectPath, final String attributeName);
/**
* Reads a string array attribute named <var>attributeName</var> from the object
* <var>objectPath</var>. Does not consider '\0' as end of string but reads the full length.
*
* @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.
*/
public String[] getArrayAttrRaw(final String objectPath, final String attributeName);
/**
* Reads a multi-dimensional string array attribute named <var>attributeName</var> from the
* object <var>objectPath</var>. Considers '\0' as end of string.
*
* @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.
*/
public MDArray<String> getMDArrayAttr(final String objectPath, final String attributeName);
/**
* Reads a multi-dimensional string array attribute named <var>attributeName</var> from the
* object <var>objectPath</var>. Does not consider '\0' as end of string but reads the full
* length.
*
* @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.
*/
public MDArray<String> getMDArrayAttrRaw(final String objectPath, final String attributeName);
// /////////////////////
// Data Sets
// /////////////////////
/**
* Reads a string from the data set <var>objectPath</var>. Considers '\0' as end of string. This
* needs to be a string type.
*
* @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 a string type.
*/
public String read(final String objectPath) throws HDF5JavaException;
/**
* Reads a <code>String</code> from the data set <var>objectPath</var>. Does not consider '\0'
* as end of string but reads the full length of the string. This needs to be a string type.
*
* @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 a string type.
*/
public String readRaw(final String objectPath) throws HDF5JavaException;
/**
* Reads a string array (of rank 1) from the data set <var>objectPath</var>. The elements of
* this data set need to be a string type. Considers '\0' as end of string.
*
* @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 a string type.
*/
public String[] readArray(final String objectPath) throws HDF5JavaException;
/**
* Reads a string array (of rank 1) from the data set <var>objectPath</var>. The elements of
* this data set need to be a string type. Does not consider '\0' as end of string but reads the
* full length.
*
* @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 a string type.
*/
public String[] readArrayRaw(final String objectPath) throws HDF5JavaException;
/**
* Reads a block of a string array (of rank 1) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Considers '\0' as end of string.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The size of the block to read from the data set.
* @param blockNumber The number of the block to read from the data set (the offset is
* <code>blockSize * blockNumber</code>).
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public String[] readArrayBlock(final String objectPath, final int blockSize,
final long blockNumber);
/**
* Reads a block of a string array (of rank 1) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Does not consider '\0' as end of string
* but reads the full length.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The size of the block to read from the data set.
* @param blockNumber The number of the block to read from the data set (the offset is
* <code>blockSize * blockNumber</code>).
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public String[] readArrayBlockRaw(final String objectPath, final int blockSize,
final long blockNumber);
/**
* Reads a block of a string array (of rank 1) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Considers '\0' as end of string.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The size of the block to read from the data set.
* @param offset The offset of the block in the data set.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public String[] readArrayBlockWithOffset(final String objectPath, final int blockSize,
final long offset);
/**
* Reads a block of a string array (of rank 1) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Does not consider '\0' as end of string
* but reads the full length.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockSize The size of the block to read from the data set.
* @param offset The offset of the block in the data set.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public String[] readArrayBlockWithOffsetRaw(final String objectPath, final int blockSize,
final long offset);
/**
* Reads a string array (of rank N) from the data set <var>objectPath</var>. The elements of
* this data set need to be a string type. Considers '\0' as end of string.
*
* @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 a string type.
*/
public MDArray<String> readMDArray(final String objectPath);
/**
* Reads a string array (of rank N) from the data set <var>objectPath</var>. The elements of
* this data set need to be a string type. Does not considers '\0' as end of string but reads
* the full length.
*
* @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 a string type.
*/
public MDArray<String> readMDArrayRaw(final String objectPath);
/**
* Reads a block of a string array (of rank N) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Considers '\0' as end of string.
* Considers '\0' as end of string.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The dimensions (along each axis) of the block to read from the data
* set.
* @param blockNumber The number of the block to read from the data set (the offset in each
* dimension i is <code>blockSize[i] * blockNumber[i]</code>).
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public MDArray<String> readMDArrayBlock(final String objectPath, final int[] blockDimensions,
final long[] blockNumber);
/**
* Reads a block of a string array (of rank N) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Does not consider '\0' as end of string
* but reads the full length.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The dimensions (along each axis) of the block to read from the data
* set.
* @param blockNumber The number of the block to read from the data set (the offset in each
* dimension i is <code>blockSize[i] * blockNumber[i]</code>).
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public MDArray<String> readMDArrayBlockRaw(final String objectPath,
final int[] blockDimensions, final long[] blockNumber);
/**
* Reads a block of a string array (of rank N) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Considers '\0' as end of string.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The dimensions (along each axis) of the block to read from the data
* set.
* @param offset The offset of the block in the data set.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public MDArray<String> readMDArrayBlockWithOffset(final String objectPath,
final int[] blockDimensions, final long[] offset);
/**
* Reads a block of a string array (of rank N) from the data set <var>objectPath</var>. The
* elements of this data set need to be a string type. Does not consider '\0' as end of string
* but reads the full length.
*
* @param objectPath The name (including path information) of the data set object in the file.
* @param blockDimensions The dimensions (along each axis) of the block to read from the data
* set.
* @param offset The offset of the block in the data set.
* @return The data read from the data set.
* @throws HDF5JavaException If the <var>objectPath</var> is not a string type.
*/
public MDArray<String> readMDArrayBlockWithOffsetRaw(final String objectPath,
final int[] blockDimensions, final long[] offset);
/**
* Provides all natural blocks of this one-dimensional string data set to iterate over.
* Considers '\0' as end of string.
*
* @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<String[]>> getArrayNaturalBlocks(final String objectPath)
throws HDF5JavaException;
/**
* Provides all natural blocks of this one-dimensional string data set to iterate over. Does not
* consider '\0' as end of string but reads the full length.
*
* @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<String[]>> getArrayNaturalBlocksRaw(final String objectPath)
throws HDF5JavaException;
/**
* Provides all natural blocks of this multi-dimensional string data set to iterate over.
* Considers '\0' as end of string.
*
* @see HDF5MDDataBlock
*/
public Iterable<HDF5MDDataBlock<MDArray<String>>> getMDArrayNaturalBlocks(
final String objectPath);
/**
* Provides all natural blocks of this multi-dimensional string data set to iterate over. Does
* not consider '\0' as end of string but reads the full length.
*
* @see HDF5MDDataBlock
*/
public Iterable<HDF5MDDataBlock<MDArray<String>>> getMDArrayNaturalBlocksRaw(
final String objectPath);
}
|
