ch.systemsx.cisd.hdf5

Interface IHDF5ObjectReadOnlyInfoProviderHandler

All Known Subinterfaces:

IHDF5ObjectReadWriteInfoProviderHandler

public interface IHDF5ObjectReadOnlyInfoProviderHandler

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

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

Method Summary

Modifier and Type	Method and Description
void	copy(java.lang.String sourceObject, IHDF5Writer destinationWriter) Copies the sourceObject to the root group of the HDF5 file represented by the destinationWriter.
void	copy(java.lang.String sourceObject, IHDF5Writer destinationWriter, java.lang.String destinationObject) Copies the sourceObject to the destinationObject of the HDF5 file represented by the destinationWriter.
void	copyAll(IHDF5Writer destinationWriter) Copies all objects of the file represented by this reader to the root group of the HDF5 file represented by the destinationWriter.
boolean	exists(java.lang.String objectPath) Returns true, if objectPath exists and false otherwise.
boolean	exists(java.lang.String objectPath, boolean followLink) Returns true, if objectPath exists and false otherwise.
java.util.List<java.lang.String>	getAllAttributeNames(java.lang.String objectPath) Returns the names of all attributes of the given objectPath.
java.util.List<HDF5LinkInformation>	getAllGroupMemberInformation(java.lang.String groupPath, boolean readLinkTargets) Returns the link information about all members of groupPath.
java.util.List<java.lang.String>	getAllGroupMembers(java.lang.String groupPath) Returns all members of groupPath, including internal groups that may be used by the library to do house-keeping.
int[]	getArrayDimensions(java.lang.String objectPath) Returns the dimensions of objectPath(empty if this isno array type).
int	getArrayRank(java.lang.String objectPath) Returns the rank of the array of objectPath (0 if this is no array type).
HDF5DataTypeInformation	getAttributeInformation(java.lang.String objectPath, java.lang.String attributeName) Returns the information about a data set as a HDF5DataTypeInformation object.
HDF5DataTypeInformation	getAttributeInformation(java.lang.String objectPath, java.lang.String attributeName, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the information about a data set as a HDF5DataTypeInformation object.
java.util.List<java.lang.String>	getAttributeNames(java.lang.String objectPath) Returns the names of the attributes of the given objectPath.
HDF5DataSetInformation	getDataSetInformation(java.lang.String objectPath) Returns the information about a data set as a HDF5DataSetInformation object.
HDF5DataSetInformation	getDataSetInformation(java.lang.String objectPath, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the information about a data set as a HDF5DataSetInformation object.
long[]	getDimensions(java.lang.String objectPath) Returns the dimensions of objectPath.
int	getElementSize(java.lang.String objectPath) Returns the size of one element of objectPath.
java.util.List<HDF5LinkInformation>	getGroupMemberInformation(java.lang.String groupPath, boolean readLinkTargets) Returns the link information about the members of groupPath.
java.util.List<java.lang.String>	getGroupMemberPaths(java.lang.String groupPath) Returns the paths of the members of groupPath (including the parent).
java.util.List<java.lang.String>	getGroupMembers(java.lang.String groupPath) Returns the members of groupPath.
HDF5LinkInformation	getLinkInformation(java.lang.String objectPath) Returns the link information for the given objectPath.
long	getNumberOfElements(java.lang.String objectPath) Returns the total number of elements of objectPath.
HDF5ObjectInformation	getObjectInformation(java.lang.String objectPath) Returns the object information for the given objectPath.
HDF5ObjectType	getObjectType(java.lang.String objectPath) Returns the type of the given objectPath.
HDF5ObjectType	getObjectType(java.lang.String objectPath, boolean followLink) Returns the type of the given objectPath.
int	getRank(java.lang.String objectPath) Returns the rank of this data set of objectPath.
long	getSize(java.lang.String objectPath) Returns the total size (in bytes) of objectPath.
long[]	getSpaceDimensions(java.lang.String objectPath) Returns the dimensions of the space of objectPath (empty if this is a scalar space).
int	getSpaceRank(java.lang.String objectPath) Returns the rank of the space of objectPath (0 if this is a scalar space).
boolean	hasAttribute(java.lang.String objectPath, java.lang.String attributeName) Returns true, if the objectPath has an attribute with name attributeName.
boolean	isDataSet(java.lang.String objectPath) Returns true if the objectPath exists and represents a data set and false otherwise.
boolean	isDataSet(java.lang.String objectPath, boolean followLink) Returns true if the objectPath exists and represents a data set and false otherwise.
boolean	isDataType(java.lang.String objectPath) Returns true if the objectPath exists and represents a data type and false otherwise.
boolean	isDataType(java.lang.String objectPath, boolean followLink) Returns true if the objectPath exists and represents a data type and false otherwise.
boolean	isExternalLink(java.lang.String objectPath) Returns true if the objectPath exists and represents an external link and false otherwise.
boolean	isGroup(java.lang.String objectPath) Returns true if the objectPath exists and represents a group and false otherwise.
boolean	isGroup(java.lang.String objectPath, boolean followLink) Returns true if the objectPath exists and represents a group and false otherwise.
boolean	isHouseKeepingObject(java.lang.String objectPath) Returns true if objectPath denotes an internal (house-keeping) object.
boolean	isSoftLink(java.lang.String objectPath) Returns true if the objectPath exists and represents a soft link and false otherwise.
boolean	isSymbolicLink(java.lang.String objectPath) Returns true if the objectPath exists and represents either a soft link or an external link and false otherwise.
HDF5DataSet	openDataSet(java.lang.String objectPath) Opens a data set for reading (reader and writer) or writing (writer).
java.lang.String	toHouseKeepingPath(java.lang.String objectPath) Creates and returns an internal (house-keeping) version of objectPath.
java.lang.String	tryGetDataTypePath(HDF5DataType type) Returns the path of the data type, or null, if type is not a named data type.
java.lang.String	tryGetDataTypePath(java.lang.String objectPath) Returns the path of the data type of the data set objectPath, or null , if this data set is not of a named data type.
java.lang.String	tryGetExternalLinkFilename(java.lang.String objectPath) Returns the filename of an external link, or null, if this link does not exist or is not an external link.
java.lang.String	tryGetExternalLinkTarget(java.lang.String objectPath) Returns the external link target of this link, or null, if this link does not exist or is not an external link.
java.lang.String	tryGetSymbolicLinkTarget(java.lang.String objectPath) Returns the target of the symbolic link that objectPath points to, or null, if objectPath is not a symbolic link.
HDF5DataTypeVariant	tryGetTypeVariant(java.lang.String objectPath) Returns the data type variant of objectPath, or null, if no type variant is defined for this objectPath.
HDF5DataTypeVariant	tryGetTypeVariant(java.lang.String objectPath, java.lang.String attributeName) Returns the data type variant of attributeName of object objectPath, or null, if no type variant is defined for this objectPath.

Method Detail

getLinkInformation

HDF5LinkInformation getLinkInformation(java.lang.String objectPath)

Returns the link information for the given objectPath. If objectPath does not exist, the link information will have a type HDF5ObjectType.NONEXISTENT.

getObjectInformation

HDF5ObjectInformation getObjectInformation(java.lang.String objectPath)

Returns the object information for the given objectPath. If objectPath is a symbolic link, this method will return the type of the object that this link points to rather than the type of the link. If objectPath does not exist, the object information will have a type HDF5ObjectType.NONEXISTENT and the other fields will not be set.

getObjectType

HDF5ObjectType getObjectType(java.lang.String objectPath,
                             boolean followLink)

Returns the type of the given objectPath. If followLink is false and objectPath is a symbolic link, this method will return the type of the link rather than the type of the object that the link points to.

getObjectType

HDF5ObjectType getObjectType(java.lang.String objectPath)

Returns the type of the given objectPath. If objectPath is a symbolic link, this method will return the type of the object that this link points to rather than the type of the link, that is, it will follow symbolic links.

exists

boolean exists(java.lang.String objectPath,
               boolean followLink)

Returns true, if objectPath exists and false otherwise. if followLink is false and objectPath is a symbolic link, this method will return true regardless of whether the link target exists or not.

exists

boolean exists(java.lang.String objectPath)

Returns true, if objectPath exists and false otherwise. If objectPath is a symbolic link, the method will return true if the link target exists, that is, this method will follow symbolic links.

openDataSet

HDF5DataSet openDataSet(java.lang.String objectPath)

Opens a data set for reading (reader and writer) or writing (writer).

Parameters:

objectPath - The name (with path) of the data set to open

toHouseKeepingPath

java.lang.String toHouseKeepingPath(java.lang.String objectPath)

Creates and returns an internal (house-keeping) version of objectPath.

isHouseKeepingObject

boolean isHouseKeepingObject(java.lang.String objectPath)

Returns true if objectPath denotes an internal (house-keeping) object.

isGroup

boolean isGroup(java.lang.String objectPath,
                boolean followLink)

Returns true if the objectPath exists and represents a group and false otherwise. Note that if followLink is false this method will return false if objectPath is a symbolic link that points to a group.

isGroup

boolean isGroup(java.lang.String objectPath)

Returns true if the objectPath exists and represents a group and false otherwise. Note that if objectPath is a symbolic link, this method will return true if the link target of the symbolic link is a group, that is, this method will follow symbolic links.

isDataSet

boolean isDataSet(java.lang.String objectPath,
                  boolean followLink)

Returns true if the objectPath exists and represents a data set and false otherwise. Note that if followLink is false this method will return false if objectPath is a symbolic link that points to a data set.

isDataSet

boolean isDataSet(java.lang.String objectPath)

Returns true if the objectPath exists and represents a data set and false otherwise. Note that if objectPath is a symbolic link, this method will return true if the link target of the symbolic link is a data set, that is, this method will follow symbolic links.

isDataType

boolean isDataType(java.lang.String objectPath,
                   boolean followLink)

Returns true if the objectPath exists and represents a data type and false otherwise. Note that if followLink is false this method will return false if objectPath is a symbolic link that points to a data type.

isDataType

boolean isDataType(java.lang.String objectPath)

Returns true if the objectPath exists and represents a data type and false otherwise. Note that if objectPath is a symbolic link, this method will return true if the link target of the symbolic link is a data type, that is, this method will follow symbolic links.

isSoftLink

boolean isSoftLink(java.lang.String objectPath)

Returns true if the objectPath exists and represents a soft link and false otherwise.

isExternalLink

boolean isExternalLink(java.lang.String objectPath)

Returns true if the objectPath exists and represents an external link and false otherwise.

isSymbolicLink

boolean isSymbolicLink(java.lang.String objectPath)

Returns true if the objectPath exists and represents either a soft link or an external link and false otherwise.

tryGetSymbolicLinkTarget

java.lang.String tryGetSymbolicLinkTarget(java.lang.String objectPath)

Returns the target of the symbolic link that objectPath points to, or null, if objectPath is not a symbolic link.

Note that external links have a special format: They start with a prefix " EXTERNAL::", then comes the path of the external file (beware that this part uses the native path separator, i.e. "\" on Windows). Finally, separated by ":: ", the path of the link in the external file is provided (this part always uses "/" as path separator).

tryGetExternalLinkFilename

java.lang.String tryGetExternalLinkFilename(java.lang.String objectPath)

Returns the filename of an external link, or null, if this link does not exist or is not an external link.

tryGetExternalLinkTarget

java.lang.String tryGetExternalLinkTarget(java.lang.String objectPath)

Returns the external link target of this link, or null, if this link does not exist or is not an external link.

hasAttribute

boolean hasAttribute(java.lang.String objectPath,
                     java.lang.String attributeName)

Returns true, if the objectPath has an attribute with name attributeName.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

attributeName - The name of the attribute to read.

Returns:

true, if the attribute exists for the object.

getAttributeNames

java.util.List<java.lang.String> getAttributeNames(java.lang.String objectPath)

Returns the names of the attributes of the given objectPath.

Parameters:

objectPath - The name (including path information) of the object (data set or group) to return the attributes for.

getAllAttributeNames

java.util.List<java.lang.String> getAllAttributeNames(java.lang.String objectPath)

Returns the names of all attributes of the given objectPath.

This may include attributes that are used internally by the library and are not supposed to be changed by application programmers.

Parameters:

objectPath - The name (including path information) of the object (data set or group) to return the attributes for.

getAttributeInformation

HDF5DataTypeInformation getAttributeInformation(java.lang.String objectPath,
                                                java.lang.String attributeName)

Returns the information about a data set as a HDF5DataTypeInformation object.

Parameters:

objectPath - The name (including path information) of the object that has the attribute to return information about.

attributeName - The name of the attribute to get information about.

getAttributeInformation

HDF5DataTypeInformation getAttributeInformation(java.lang.String objectPath,
                                                java.lang.String attributeName,
                                                HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the information about a data set as a HDF5DataTypeInformation object.

Parameters:

objectPath - The name (including path information) of the object that has the attribute to return information about.

attributeName - The name of the attribute to get information about.

dataTypeInfoOptions - The options on which information to get about the member data types.

getDataSetInformation

HDF5DataSetInformation getDataSetInformation(java.lang.String objectPath)

Returns the information about a data set as a HDF5DataSetInformation object. It is a failure condition if the objectPath does not exist or does not identify a data set.

Parameters:

objectPath - The name (including path information) of the data set to return information about.

getDataSetInformation

HDF5DataSetInformation getDataSetInformation(java.lang.String objectPath,
                                             HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the information about a data set as a HDF5DataSetInformation object. It is a failure condition if the objectPath does not exist or does not identify a data set.

Parameters:

objectPath - The name (including path information) of the data set to return information about.

dataTypeInfoOptions - The options on which information to get about the member data types.

getSize

long getSize(java.lang.String objectPath)

Returns the total size (in bytes) of objectPath. It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getNumberOfElements

long getNumberOfElements(java.lang.String objectPath)

Returns the total number of elements of objectPath. It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getElementSize

int getElementSize(java.lang.String objectPath)

Returns the size of one element of objectPath. It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getSpaceRank

int getSpaceRank(java.lang.String objectPath)

Returns the rank of the space of objectPath (0 if this is a scalar space). It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getSpaceDimensions

long[] getSpaceDimensions(java.lang.String objectPath)

Returns the dimensions of the space of objectPath (empty if this is a scalar space). It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getArrayRank

int getArrayRank(java.lang.String objectPath)

Returns the rank of the array of objectPath (0 if this is no array type). It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getArrayDimensions

int[] getArrayDimensions(java.lang.String objectPath)

Returns the dimensions of objectPath(empty if this isno array type). It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getRank

int getRank(java.lang.String objectPath)

Returns the rank of this data set of objectPath. This combines the space rank and the array rank into one rank. It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

getDimensions

long[] getDimensions(java.lang.String objectPath)

Returns the dimensions of objectPath. This combines the space dimensions and the array dimensions into one rank. It is a failure condition if the objectPath does not exist or does not identify a data set. This method follows symbolic links.

copy

void copy(java.lang.String sourceObject,
          IHDF5Writer destinationWriter,
          java.lang.String destinationObject)

Copies the sourceObject to the destinationObject of the HDF5 file represented by the destinationWriter. If destiantionObject ends with "/", it will be considered a group and the name of sourceObject will be appended.

copy

void copy(java.lang.String sourceObject,
          IHDF5Writer destinationWriter)

Copies the sourceObject to the root group of the HDF5 file represented by the destinationWriter.

copyAll

void copyAll(IHDF5Writer destinationWriter)

Copies all objects of the file represented by this reader to the root group of the HDF5 file represented by the destinationWriter.

getGroupMembers

java.util.List<java.lang.String> getGroupMembers(java.lang.String groupPath)

Returns the members of groupPath. The order is not well defined.

Parameters:

groupPath - The path of the group to get the members for.

Throws:

java.lang.IllegalArgumentException - If groupPath is not a group.

getAllGroupMembers

java.util.List<java.lang.String> getAllGroupMembers(java.lang.String groupPath)

Returns all members of groupPath, including internal groups that may be used by the library to do house-keeping. The order is not well defined.

Parameters:

groupPath - The path of the group to get the members for.

Throws:

java.lang.IllegalArgumentException - If groupPath is not a group.

getGroupMemberPaths

java.util.List<java.lang.String> getGroupMemberPaths(java.lang.String groupPath)

Returns the paths of the members of groupPath (including the parent). The order is not well defined.

Parameters:

groupPath - The path of the group to get the member paths for.

Throws:

java.lang.IllegalArgumentException - If groupPath is not a group.

getGroupMemberInformation

java.util.List<HDF5LinkInformation> getGroupMemberInformation(java.lang.String groupPath,
                                                              boolean readLinkTargets)

Returns the link information about the members of groupPath. The order is not well defined.

Parameters:

groupPath - The path of the group to get the members for.

readLinkTargets - If true, for symbolic links the link targets will be available via HDF5LinkInformation.tryGetSymbolicLinkTarget().

Throws:

java.lang.IllegalArgumentException - If groupPath is not a group.

getAllGroupMemberInformation

java.util.List<HDF5LinkInformation> getAllGroupMemberInformation(java.lang.String groupPath,
                                                                 boolean readLinkTargets)

Returns the link information about all members of groupPath. The order is not well defined.

This may include attributes that are used internally by the library and are not supposed to be changed by application programmers.

Parameters:

groupPath - The path of the group to get the members for.

readLinkTargets - If true, the link targets will be read for symbolic links.

Throws:

java.lang.IllegalArgumentException - If groupPath is not a group.

tryGetTypeVariant

HDF5DataTypeVariant tryGetTypeVariant(java.lang.String objectPath)

Returns the data type variant of objectPath, or null, if no type variant is defined for this objectPath.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

Returns:

The data type variant or null.

tryGetTypeVariant

HDF5DataTypeVariant tryGetTypeVariant(java.lang.String objectPath,
                                      java.lang.String attributeName)

Returns the data type variant of attributeName of object objectPath, or null, if no type variant is defined for this objectPath.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

Returns:

The data type variant or null.

tryGetDataTypePath

java.lang.String tryGetDataTypePath(java.lang.String objectPath)

Returns the path of the data type of the data set objectPath, or null , if this data set is not of a named data type.

tryGetDataTypePath

java.lang.String tryGetDataTypePath(HDF5DataType type)

Returns the path of the data type, or null, if type is not a named data type.