ch.systemsx.cisd.hdf5

Interface IHDF5ObjectReadWriteInfoProviderHandler

All Superinterfaces:

IHDF5ObjectReadOnlyInfoProviderHandler

public interface IHDF5ObjectReadWriteInfoProviderHandler
extends IHDF5ObjectReadOnlyInfoProviderHandler

An interface for getting information on and handling HDF5 objects like links, groups, data sets and data types.

Obtain an object implementing this interface by calling IHDF5Writer.object().

Method Summary

Modifier and Type	Method and Description
void	createExternalLink(java.lang.String targetFileName, java.lang.String targetPath, java.lang.String linkPath) Creates an external link, that is a link to a data set in another HDF5 file, the target .
void	createGroup(java.lang.String groupPath) Creates a group with path objectPath in the HDF5 file.
void	createGroup(java.lang.String groupPath, int sizeHint) Creates a group with path objectPath in the HDF5 file, giving the library a hint about the size (sizeHint).
void	createGroup(java.lang.String groupPath, int maxCompact, int minDense) Creates a group with path objectPath in the HDF5 file, giving the library hints about when to switch between compact and dense.
void	createHardLink(java.lang.String currentPath, java.lang.String newPath) Creates a hard link.
void	createOrUpdateExternalLink(java.lang.String targetFileName, java.lang.String targetPath, java.lang.String linkPath) Creates or updates an external link, that is a link to a data set in another HDF5 file, the target .
void	createOrUpdateSoftLink(java.lang.String targetPath, java.lang.String linkPath) Creates or updates a soft link.
void	createSoftLink(java.lang.String targetPath, java.lang.String linkPath) Creates a soft link.
void	delete(java.lang.String objectPath) Removes an object from the file.
void	deleteAttribute(java.lang.String objectPath, java.lang.String name) Deletes an attribute.
void	deleteTypeVariant(java.lang.String objectPath) Deletes the typeVariant from objectPath.
void	deleteTypeVariant(java.lang.String objectPath, java.lang.String attributeName) Deletes the typeVariant from attributeName of objectPath.
void	move(java.lang.String oldLinkPath, java.lang.String newLinkPath) Moves or renames a link in the file atomically.
void	setDataSetDimensions(java.lang.String objectPath, long[] newDimensions) Sets the data set size of a multi-dimensional data set to newDimensions.
void	setDataSetSize(java.lang.String objectPath, long newSize) Sets the data set size of a one-dimensional data set to newSize.
void	setTypeVariant(java.lang.String objectPath, HDF5DataTypeVariant typeVariant) Sets a typeVariant of object objectPath.
void	setTypeVariant(java.lang.String objectPath, java.lang.String attributeName, HDF5DataTypeVariant typeVariant) Sets a typeVariant of attribute attributeName of object objectPath.

Methods inherited from interface ch.systemsx.cisd.hdf5.IHDF5ObjectReadOnlyInfoProviderHandler

copy, copy, copyAll, exists, exists, getAllAttributeNames, getAllGroupMemberInformation, getAllGroupMembers, getArrayDimensions, getArrayRank, getAttributeInformation, getAttributeInformation, getAttributeNames, getDataSetInformation, getDataSetInformation, getDimensions, getElementSize, getGroupMemberInformation, getGroupMemberPaths, getGroupMembers, getLinkInformation, getNumberOfElements, getObjectInformation, getObjectType, getObjectType, getRank, getSize, getSpaceDimensions, getSpaceRank, hasAttribute, isDataSet, isDataSet, isDataType, isDataType, isExternalLink, isGroup, isGroup, isHouseKeepingObject, isSoftLink, isSymbolicLink, openDataSet, toHouseKeepingPath, tryGetDataTypePath, tryGetDataTypePath, tryGetExternalLinkFilename, tryGetExternalLinkTarget, tryGetSymbolicLinkTarget, tryGetTypeVariant, tryGetTypeVariant

Method Detail

createHardLink

void createHardLink(java.lang.String currentPath,
                    java.lang.String newPath)

Creates a hard link.

Parameters:

currentPath - The name of the data set (including path information) to create a link to.

newPath - The name (including path information) of the link to create.

createSoftLink

void createSoftLink(java.lang.String targetPath,
                    java.lang.String linkPath)

Creates a soft link.

Parameters:

targetPath - The name of the data set (including path information) to create a link to.

linkPath - The name (including path information) of the link to create.

createOrUpdateSoftLink

void createOrUpdateSoftLink(java.lang.String targetPath,
                            java.lang.String linkPath)

Creates or updates a soft link.

Note: This method will never overwrite a data set, but only a symbolic link.

Parameters:

targetPath - The name of the data set (including path information) to create a link to.

linkPath - The name (including path information) of the link to create.

createExternalLink

void createExternalLink(java.lang.String targetFileName,
                        java.lang.String targetPath,
                        java.lang.String linkPath)
                 throws java.lang.IllegalStateException

Creates an external link, that is a link to a data set in another HDF5 file, the target .

Note: This method is only allowed when the IHDF5WriterConfigurator was not configured to enforce strict HDF5 1.6 compatibility.

Parameters:

targetFileName - The name of the file where the data set resides that should be linked.

targetPath - The name of the data set (including path information) in the targetFileName to create a link to.

linkPath - The name (including path information) of the link to create.

Throws:

java.lang.IllegalStateException - If the IHDF5WriterConfigurator was configured to enforce strict HDF5 1.6 compatibility.

createOrUpdateExternalLink

void createOrUpdateExternalLink(java.lang.String targetFileName,
                                java.lang.String targetPath,
                                java.lang.String linkPath)
                         throws java.lang.IllegalStateException

Creates or updates an external link, that is a link to a data set in another HDF5 file, the target .

Note: This method will never overwrite a data set, but only a symbolic link.

Note: This method is only allowed when the IHDF5WriterConfigurator was not configured to enforce strict HDF5 1.6 compatibility.

Parameters:

targetFileName - The name of the file where the data set resides that should be linked.

targetPath - The name of the data set (including path information) in the targetFileName to create a link to.

linkPath - The name (including path information) of the link to create.

Throws:

java.lang.IllegalStateException - If the IHDF5WriterConfigurator was configured to enforce strict HDF5 1.6 compatibility.

delete

void delete(java.lang.String objectPath)

Removes an object from the file. If there is more than one link to the object, only the specified link will be removed.

move

void move(java.lang.String oldLinkPath,
          java.lang.String newLinkPath)
   throws HDF5SymbolTableException

Moves or renames a link in the file atomically.

Throws:

HDF5SymbolTableException - If oldLinkPath does not exist or if newLinkPath already exists.

createGroup

void createGroup(java.lang.String groupPath)

Creates a group with path objectPath in the HDF5 file.

All intermediate groups will be created as well, if they do not already exist.

Parameters:

groupPath - The path of the group to create.

createGroup

void createGroup(java.lang.String groupPath,
                 int sizeHint)

Creates a group with path objectPath in the HDF5 file, giving the library a hint about the size (sizeHint). If you have this information in advance, it will be more efficient to tell it the library rather than to let the library figure out itself, but the hint must not be misunderstood as a limit.

All intermediate groups will be created as well, if they do not already exist.

Note: This method creates an "old-style group", that is the type of group of HDF5 1.6 and earlier.

Parameters:

groupPath - The path of the group to create.

sizeHint - The estimated size of all group entries (in bytes).

createGroup

void createGroup(java.lang.String groupPath,
                 int maxCompact,
                 int minDense)

Creates a group with path objectPath in the HDF5 file, giving the library hints about when to switch between compact and dense. Setting appropriate values may improve performance.

All intermediate groups will be created as well, if they do not already exist.

Note: This method creates a "new-style group", that is the type of group of HDF5 1.8 and above. Thus it will fail, if the writer is configured to enforce HDF5 1.6 compatibility.

Parameters:

groupPath - The path of the group to create.

maxCompact - When the group grows to more than this number of entries, the library will convert the group style from compact to dense.

minDense - When the group shrinks below this number of entries, the library will convert the group style from dense to compact.

setDataSetSize

void setDataSetSize(java.lang.String objectPath,
                    long newSize)

Sets the data set size of a one-dimensional data set to newSize. Note that this method can only be applied to extendable data sets.

Throws:

HDF5JavaException - If the data set objectPath is not extendable.

setDataSetDimensions

void setDataSetDimensions(java.lang.String objectPath,
                          long[] newDimensions)

Sets the data set size of a multi-dimensional data set to newDimensions. Note that this method can only be applied to extendable data sets.

Throws:

HDF5JavaException - If the data set objectPath is not extendable.

setTypeVariant

void setTypeVariant(java.lang.String objectPath,
                    HDF5DataTypeVariant typeVariant)

Sets a typeVariant of object objectPath.

Parameters:

objectPath - The name of the object to add the type variant to.

typeVariant - The type variant to add.

setTypeVariant

void setTypeVariant(java.lang.String objectPath,
                    java.lang.String attributeName,
                    HDF5DataTypeVariant typeVariant)

Sets a typeVariant of attribute attributeName of object objectPath.

Parameters:

objectPath - The name of the object.

attributeName - The name of attribute to add the type variant to.

typeVariant - The type variant to add.

deleteTypeVariant

void deleteTypeVariant(java.lang.String objectPath)

Deletes the typeVariant from objectPath.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to delete the type variant from.

deleteTypeVariant

void deleteTypeVariant(java.lang.String objectPath,
                       java.lang.String attributeName)

Deletes the typeVariant from attributeName of objectPath.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object.

attributeName - The name of the attribute to delete the type variant from.

deleteAttribute

void deleteAttribute(java.lang.String objectPath,
                     java.lang.String name)

Deletes an attribute.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to delete the attribute from.

name - The name of the attribute to delete.