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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
/*
* 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 ch.systemsx.cisd.base.mdarray.MDArray;
import ch.systemsx.cisd.base.mdarray.MDByteArray;
import ch.systemsx.cisd.base.mdarray.MDIntArray;
import ch.systemsx.cisd.base.mdarray.MDShortArray;
/**
* Interface for creation of enumeration values.
* <p>
* Obtain an object implementing this interface by calling {@link IHDF5Writer#enumeration()}.
*
* @author Bernd Rinn
*/
public interface IHDF5EnumValueCreator
{
/**
* Creates a new enumeration value with enumeration type name <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param value The string representation of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newVal(String typeName, String[] options, String value);
/**
* Creates a new enumeration value with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param value The string representation of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newAnonVal(String[] options, String value);
/**
* Creates a new enumeration value with enumeration type name <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param value The ordinal value of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newVal(String typeName, String[] options, final int value);
/**
* Creates a new enumeration value with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param value The ordinal of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newAnonVal(String[] options, int value);
/**
* Creates a new enumeration value with enumeration type name <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param value The ordinal value of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newVal(String typeName, String[] options, final short value);
/**
* Creates a new enumeration value with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param value The ordinal value of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newAnonVal(String[] options, short value);
/**
* Creates a new enumeration value with enumeration type name <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param value The ordinal value of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newVal(String typeName, String[] options, final byte value);
/**
* Creates a new enumeration value with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param value The ordinal of the created enumeration value.
* @return The created enumeration value.
*/
public HDF5EnumerationValue newAnonVal(String[] options, byte value);
/**
* Creates a new enumeration value with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getAnonymousEnumType(value.class), getClass())</code>.
*
* @param value The value (including the type) of the created enumeration value.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValue newAnonVal(Enum<T> value);
/**
* Creates a new enumeration value with an enumeration type of name
* <code>value.getClass().getSimpleName()</code>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(value.getClass()), value)</code>.
*
* @param value The value (including the type) of the created enumeration value.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValue newVal(Enum<T> value);
/**
* Creates a new enumeration value with an enumeration type of name <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValue(writer.getEnumType(typeName, value.getClass()), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param value The value (including the type) of the created enumeration value.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValue newVal(String typeName, Enum<T> value);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The string representations of the elements of the created enumeration value
* array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newArray(String typeName, String[] options, String[] values);
/**
* Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The string representations of the elements of the created enumeration value
* array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newAnonArray(String[] options, String[] values);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newArray(String typeName, String[] options, int[] values);
/**
* Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newAnonArray(String[] options, int[] values);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newArray(String typeName, String[] options, short[] values);
/**
* Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newAnonArray(String[] options, short[] values);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newArray(String typeName, String[] options, byte[] values);
/**
* Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueArray newAnonArray(String[] options, byte[] values);
/**
* Creates a new enumeration value array (of rank 1) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(value.getClass().getComponentType()), value)</code>.
*
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueArray newAnonArray(Enum<T>[] values);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, value.getClass().getComponentType()), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueArray newArray(String typeName, Enum<T>[] values);
/**
* Creates a new enumeration value array (of rank 1) with an enumeration type of name
* <code>value.class.getSimpleName()</code>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(value.getClass().getComponentType()), value)</code>.
*
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueArray newArray(Enum<T>[] values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The string representations of the elements of the created enumeration value
* array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newMDArray(String typeName, String[] options,
MDArray<String> values);
/**
* Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The string representations of the elements of the created enumeration value
* array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newAnonMDArray(String[] options, MDArray<String> values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newMDArray(String typeName, String[] options,
MDIntArray values);
/**
* Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newAnonMDArray(String[] options, MDIntArray values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newMDArray(String typeName, String[] options,
MDShortArray values);
/**
* Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newAnonMDArray(String[] options, MDShortArray values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newMDArray(String typeName, String[] options,
MDByteArray values);
/**
* Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, options), value)</code>.
*
* @param options The values of the enumeration type.
* @param values The ordinal values of the elements of the created enumeration value array.
* @return The created enumeration value.
*/
public HDF5EnumerationValueMDArray newAnonMDArray(String[] options, MDByteArray values);
/**
* Creates a new enumeration value array (of rank N) with an anonymous enumeration type.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getAnonymousEnumType(value.getAsFlatArray().getClass().getComponentType()), value)</code>.
*
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueMDArray newAnonMDArray(MDArray<Enum<T>> values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <var>typeName</var>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(typeName, value.getAsFlatArray().getClass().getComponentType()), value)</code>.
*
* @param typeName The name of the enumeration type.
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueMDArray newMDArray(String typeName,
MDArray<Enum<T>> values);
/**
* Creates a new enumeration value array (of rank N) with an enumeration type of name
* <code>value.class.getSimpleName()</code>.
* <p>
* Shortcut for
* <code>new HDF5EnumerationValueArray(writer.getEnumType(value.getAsFlatArray().getClass().getComponentType()), value)</code>.
*
* @param values The value array (which has the type) of the created enumeration value array.
* @return The created enumeration value.
*/
public <T extends Enum<T>> HDF5EnumerationValueMDArray newMDArray(MDArray<Enum<T>> values);
}
|
