Class NativeHDF5Writer

java.lang.Object

org.episteme.core.io.AbstractResourceWriter<NativeRealDoubleMatrixStorage>

org.episteme.nativ.physics.loaders.hdf5.NativeHDF5Writer

All Implemented Interfaces:

AutoCloseable, ResourceIO<NativeRealDoubleMatrixStorage>, ResourceWriter<NativeRealDoubleMatrixStorage>

public class NativeHDF5Writer
extends AbstractResourceWriter<NativeRealDoubleMatrixStorage>
implements AutoCloseable

High-performance HDF5 writer using Panama.

Constructor Summary

Constructors

Constructor	Description
NativeHDF5Writer()
NativeHDF5Writer(Path path)

Method Summary

Modifier and Type	Method	Description
void	close()
String	getCategory()	Returns the category for grouping.
String	getDescription()	Returns a short description of this resource handler.
String	getLongDescription()	Returns a long description of this resource handler.
String	getName()	Returns the display name of this resource handler.
String	getResourcePath()	Returns the base path where this resource is located.
Class<NativeRealDoubleMatrixStorage>	getResourceType()	Returns the type of resource.
String[]	getSupportedExtensions()	Returns the supported file extensions (e.g., ".h5", ".fits").
String[]	getSupportedVersions()	Returns the supported versions of the format this reader/writer handles.
void	save(NativeRealDoubleMatrixStorage resource, String destinationId)	Saves the resource to a destination.
void	writeMatrix(String datasetName, NativeRealDoubleMatrixStorage matrix)
void	writeMatrix(String datasetName, NativeRealDoubleMatrixStorage matrix, String compression, int level)

Methods inherited from class AbstractResourceWriter

createBufferedStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ResourceIO

getExpectedResourceFiles, isFileBased, isInput

Methods inherited from interface ResourceWriter

isOutput

Constructor Details

NativeHDF5Writer

public NativeHDF5Writer()

NativeHDF5Writer

public NativeHDF5Writer(Path path)

Method Details

getName

public String getName()

Description copied from interface: ResourceIO

Returns the display name of this resource handler. MUST be implemented with I18N support.

Specified by:

getName in interface ResourceIO<NativeRealDoubleMatrixStorage>

Overrides:

getName in class AbstractResourceWriter<NativeRealDoubleMatrixStorage>

Returns:

the display name

getDescription

public String getDescription()

Description copied from interface: ResourceIO

Returns a short description of this resource handler. MUST be implemented with I18N support.

Specified by:

getDescription in interface ResourceIO<NativeRealDoubleMatrixStorage>

Overrides:

getDescription in class AbstractResourceWriter<NativeRealDoubleMatrixStorage>

Returns:

the description

getCategory

public String getCategory()

Description copied from interface: ResourceIO

Returns the category for grouping. MUST be implemented with I18N support.

Specified by:

getCategory in interface ResourceIO<NativeRealDoubleMatrixStorage>

Overrides:

getCategory in class AbstractResourceWriter<NativeRealDoubleMatrixStorage>

Returns:

the category name

getResourceType

public Class<NativeRealDoubleMatrixStorage> getResourceType()

Description copied from interface: ResourceIO

Returns the type of resource.

Specified by:

getResourceType in interface ResourceIO<NativeRealDoubleMatrixStorage>

getResourcePath

public String getResourcePath()

Description copied from interface: ResourceIO

Returns the base path where this resource is located.

Specified by:

getResourcePath in interface ResourceIO<NativeRealDoubleMatrixStorage>

getLongDescription

public String getLongDescription()

Description copied from interface: ResourceIO

Returns a long description of this resource handler. MUST be implemented with I18N support.

Specified by:

getLongDescription in interface ResourceIO<NativeRealDoubleMatrixStorage>

Overrides:

getLongDescription in class AbstractResourceWriter<NativeRealDoubleMatrixStorage>

Returns:

the long description

getSupportedVersions

public String[] getSupportedVersions()

Description copied from interface: ResourceIO

Returns the supported versions of the format this reader/writer handles.

Each implementation MUST override this method to declare which versions of the underlying format are supported. The returned array should contain version strings in the format's standard notation (e.g., "3.0", "2.1", "Level 3 Version 2").

Examples:

• MathML: {"3.0", "2.0"}
• SBML: {"Level 3 Version 2", "Level 3 Version 1", "Level 2 Version 5"}
• PhyloXML: {"1.10", "1.00"}

Specified by:

getSupportedVersions in interface ResourceIO<NativeRealDoubleMatrixStorage>

Returns:

array of supported version strings, never null (empty array if version-agnostic)

getSupportedExtensions

public String[] getSupportedExtensions()

Description copied from interface: ResourceIO

Returns the supported file extensions (e.g., ".h5", ".fits").

Specified by:

getSupportedExtensions in interface ResourceIO<NativeRealDoubleMatrixStorage>

save

public void save(NativeRealDoubleMatrixStorage resource,
 String destinationId)
          throws Exception

Description copied from interface: ResourceWriter

Saves the resource to a destination.

Specified by:

save in interface ResourceWriter<NativeRealDoubleMatrixStorage>

Throws:

Exception

writeMatrix

public void writeMatrix(String datasetName,
 NativeRealDoubleMatrixStorage matrix,
 String compression,
 int level)

writeMatrix

public void writeMatrix(String datasetName,
 NativeRealDoubleMatrixStorage matrix)

close

public void close()

Specified by:

close in interface AutoCloseable