Files
hdf5/HDF5Examples/JAVA/H5D/H5Ex_D_Compact.java
Allen Byrne b754dcb8f2 Move Java wrappers to FFM using jextract and java 25 (#5957)
FFM build requires Java 25, Jextract 25.
Generates FFM bindings during configure.
JNI is default when the requirements are not met or can be forced.
Presets added for maven and FFM - JNI is default selection.
Enhanced Maven options will work with either JNI or FFM
New Workflows for testing and maven uploads.
Extensive documentation changes for java.
2025-11-04 14:03:06 -06:00

319 lines
10 KiB
Java

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the LICENSE file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/************************************************************
This example shows how to read and write data to a compact
dataset. The program first writes integers to a compact
dataset with dataspace dimensions of DIM_XxDIM_Y, then
closes the file. Next, it reopens the file, reads back
the data, and outputs it to the screen.
************************************************************/
import static org.hdfgroup.javahdf5.hdf5_h.*;
import java.lang.foreign.Arena;
import java.lang.foreign.MemorySegment;
import java.lang.foreign.ValueLayout;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
public class H5Ex_D_Compact {
private static String FILENAME = "H5Ex_D_Compact.h5";
private static String DATASETNAME = "DS1";
private static final int DIM_X = 4;
private static final int DIM_Y = 7;
private static final int RANK = 2;
// Values for the status of space allocation
enum H5D_layout {
H5D_LAYOUT_ERROR(-1),
H5D_COMPACT(0),
H5D_CONTIGUOUS(1),
H5D_CHUNKED(2),
H5D_VIRTUAL(3),
H5D_NLAYOUTS(4);
private static final Map<Integer, H5D_layout> lookup = new HashMap<Integer, H5D_layout>();
static
{
for (H5D_layout s : EnumSet.allOf(H5D_layout.class))
lookup.put(s.getCode(), s);
}
private int code;
H5D_layout(int layout_type) { this.code = layout_type; }
public int getCode() { return this.code; }
public static H5D_layout get(int code) { return lookup.get(code); }
}
private static void writeCompact(Arena arena)
{
long file_id = H5I_INVALID_HID();
long filespace_id = H5I_INVALID_HID();
long dataset_id = H5I_INVALID_HID();
long dcpl_id = H5I_INVALID_HID();
long[] dims = {DIM_X, DIM_Y};
int[][] dset_data = new int[DIM_X][DIM_Y];
// Initialize data.
for (int indx = 0; indx < DIM_X; indx++)
for (int jndx = 0; jndx < DIM_Y; jndx++)
dset_data[indx][jndx] = indx * jndx - jndx;
// Create a new file using default properties.
try {
MemorySegment filename = arena.allocateFrom(FILENAME);
file_id = H5Fcreate(filename, H5F_ACC_TRUNC(), H5P_DEFAULT(), H5P_DEFAULT());
}
catch (Exception e) {
e.printStackTrace();
}
// Create dataspace. Setting maximum size to NULL sets the maximum
// size to be the current size.
try {
MemorySegment dimsSeg = arena.allocateFrom(ValueLayout.JAVA_LONG, dims);
filespace_id = H5Screate_simple(RANK, dimsSeg, MemorySegment.NULL);
}
catch (Exception e) {
e.printStackTrace();
}
// Create the dataset creation property list.
try {
dcpl_id = H5Pcreate(H5P_CLS_DATASET_CREATE_ID_g());
}
catch (Exception e) {
e.printStackTrace();
}
// Set the layout to compact.
try {
if (dcpl_id >= 0)
H5Pset_layout(dcpl_id, H5D_layout.H5D_COMPACT.getCode());
}
catch (Exception e) {
e.printStackTrace();
}
// Create the dataset. We will use all default properties for this example.
try {
if ((file_id >= 0) && (filespace_id >= 0) && (dcpl_id >= 0)) {
MemorySegment datasetname = arena.allocateFrom(DATASETNAME);
dataset_id = H5Dcreate2(file_id, datasetname, H5T_STD_I32LE_g(), filespace_id, H5P_DEFAULT(),
dcpl_id, H5P_DEFAULT());
}
}
catch (Exception e) {
e.printStackTrace();
}
// Write the data to the dataset.
try {
if (dataset_id >= 0) {
// Flatten 2D array for FFM
int[] flatData = new int[DIM_X * DIM_Y];
for (int i = 0; i < DIM_X; i++) {
for (int j = 0; j < DIM_Y; j++) {
flatData[i * DIM_Y + j] = dset_data[i][j];
}
}
MemorySegment dataSeg = arena.allocate(ValueLayout.JAVA_INT, flatData.length);
for (int i = 0; i < flatData.length; i++) {
dataSeg.setAtIndex(ValueLayout.JAVA_INT, i, flatData[i]);
}
H5Dwrite(dataset_id, H5T_NATIVE_INT_g(), H5S_ALL(), H5S_ALL(), H5P_DEFAULT(), dataSeg);
}
}
catch (Exception e) {
e.printStackTrace();
}
// End access to the dataset and release resources used by it.
try {
if (dcpl_id >= 0)
H5Pclose(dcpl_id);
}
catch (Exception e) {
e.printStackTrace();
}
try {
if (dataset_id >= 0)
H5Dclose(dataset_id);
}
catch (Exception e) {
e.printStackTrace();
}
try {
if (filespace_id >= 0)
H5Sclose(filespace_id);
}
catch (Exception e) {
e.printStackTrace();
}
// Close the file.
try {
if (file_id >= 0)
H5Fclose(file_id);
}
catch (Exception e) {
e.printStackTrace();
}
}
private static void readCompact(Arena arena)
{
long file_id = H5I_INVALID_HID();
long filespace_id = H5I_INVALID_HID();
long dataset_id = H5I_INVALID_HID();
long dcpl_id = H5I_INVALID_HID();
int[][] dset_data = new int[DIM_X][DIM_Y];
// Open file and dataset using the default properties.
try {
MemorySegment filename = arena.allocateFrom(FILENAME);
file_id = H5Fopen(filename, H5F_ACC_RDONLY(), H5P_DEFAULT());
}
catch (Exception e) {
e.printStackTrace();
}
// Open an existing dataset.
try {
if (file_id >= 0) {
MemorySegment datasetname = arena.allocateFrom(DATASETNAME);
dataset_id = H5Dopen2(file_id, datasetname, H5P_DEFAULT());
}
}
catch (Exception e) {
e.printStackTrace();
}
// Retrieve the dataset creation property list.
try {
if (dataset_id >= 0)
dcpl_id = H5Dget_create_plist(dataset_id);
}
catch (Exception e) {
e.printStackTrace();
}
// Print the storage layout.
try {
if (dcpl_id >= 0) {
int layout_type = H5Pget_layout(dcpl_id);
System.out.print("Storage layout for " + DATASETNAME + " is: ");
switch (H5D_layout.get(layout_type)) {
case H5D_COMPACT:
System.out.println("H5D_COMPACT");
break;
case H5D_CONTIGUOUS:
System.out.println("H5D_CONTIGUOUS");
break;
case H5D_CHUNKED:
System.out.println("H5D_CHUNKED");
break;
case H5D_VIRTUAL:
System.out.println("H5D_VIRTUAL");
break;
case H5D_LAYOUT_ERROR:
break;
case H5D_NLAYOUTS:
break;
default:
break;
}
System.out.println();
}
}
catch (Exception e) {
e.printStackTrace();
}
// Read the data using the default properties.
try {
if (dataset_id >= 0) {
MemorySegment dataSeg = arena.allocate(ValueLayout.JAVA_INT, DIM_X * DIM_Y);
H5Dread(dataset_id, H5T_NATIVE_INT_g(), H5S_ALL(), H5S_ALL(), H5P_DEFAULT(), dataSeg);
// Unflatten to 2D array
for (int i = 0; i < DIM_X; i++) {
for (int j = 0; j < DIM_Y; j++) {
dset_data[i][j] = dataSeg.getAtIndex(ValueLayout.JAVA_INT, i * DIM_Y + j);
}
}
}
}
catch (Exception e) {
e.printStackTrace();
}
// Output the data to the screen.
System.out.println("Data for " + DATASETNAME + " is: ");
for (int indx = 0; indx < DIM_X; indx++) {
System.out.print(" [ ");
for (int jndx = 0; jndx < DIM_Y; jndx++)
System.out.print(dset_data[indx][jndx] + " ");
System.out.println("]");
}
System.out.println();
// End access to the dataset and release resources used by it.
try {
if (dcpl_id >= 0)
H5Pclose(dcpl_id);
}
catch (Exception e) {
e.printStackTrace();
}
try {
if (dataset_id >= 0)
H5Dclose(dataset_id);
}
catch (Exception e) {
e.printStackTrace();
}
try {
if (filespace_id >= 0)
H5Sclose(filespace_id);
}
catch (Exception e) {
e.printStackTrace();
}
// Close the file.
try {
if (file_id >= 0)
H5Fclose(file_id);
}
catch (Exception e) {
e.printStackTrace();
}
}
public static void main(String[] args)
{
try (Arena arena = Arena.ofConfined()) {
H5Ex_D_Compact.writeCompact(arena);
H5Ex_D_Compact.readCompact(arena);
}
}
}