ch.systemsx.cisd.hdf5

Class HDF5LinkInformation

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5LinkInformation

public final class HDF5LinkInformation
extends java.lang.Object

Information about a link in an HDF5 file.

Method Summary

Modifier and Type	Method and Description
void	checkExists()
boolean	equals(java.lang.Object obj)
boolean	exists() Returns true, if the link exists.
java.lang.String	getName() Returns the name of this link in the HDF5 file (the path without the parent).
java.lang.String	getParentPath() Returns the parent of the path of this link the HDF5 file.
java.lang.String	getPath() Returns the path of this link in the HDF5 file.
HDF5ObjectType	getType() Returns the type of this link.
int	hashCode()
boolean	isDataSet() Returns true, if the link is a data set.
boolean	isDataType() Returns true, if the link is a data type.
boolean	isExternalLink() Returns true, if the link is an external link.
boolean	isGroup() Returns true, if the link is a group.
boolean	isSoftLink() Returns true, if the link is a soft link.
boolean	isSymbolicLink() Returns true, if the link is either a soft link or an external link.
java.lang.String	tryGetExternalLinkFilename() 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() 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() Returns the symbolic link target of this link, or null, if this link does not exist or is not a symbolic link.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

tryGetSymbolicLinkTarget

public java.lang.String tryGetSymbolicLinkTarget()

Returns the symbolic link target of this link, or null, if this link does not exist or 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

public java.lang.String tryGetExternalLinkFilename()

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

tryGetExternalLinkTarget

public java.lang.String tryGetExternalLinkTarget()

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

isSoftLink

public boolean isSoftLink()

Returns true, if the link is a soft link.

isExternalLink

public boolean isExternalLink()

Returns true, if the link is an external link.

isSymbolicLink

public boolean isSymbolicLink()

Returns true, if the link is either a soft link or an external link.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

checkExists

public void checkExists()
                 throws HDF5JavaException

Throws:

HDF5JavaException - If the link does not exist.

getPath

public java.lang.String getPath()

Returns the path of this link in the HDF5 file.

getParentPath

public java.lang.String getParentPath()

Returns the parent of the path of this link the HDF5 file. If this link corresponds to the root, then this method will return the root ("/") itself.

getName

public java.lang.String getName()

Returns the name of this link in the HDF5 file (the path without the parent).

getType

public HDF5ObjectType getType()

Returns the type of this link.

exists

public boolean exists()

Returns true, if the link exists.

isGroup

public boolean isGroup()

Returns true, if the link is a group.

isDataSet

public boolean isDataSet()

Returns true, if the link is a data set.

isDataType

public boolean isDataType()

Returns true, if the link is a data type.