Object
hdf.object.HObject
hdf.object.h5.H5Link
- All Implemented Interfaces:
MetaDataContainer,Serializable
public class H5Link extends HObject implements MetaDataContainer
An H5Link object represents an existing HDF5 object in file.
H5Link object is an HDF5 object that is either a soft or an external link to an object in a file that does not exist. The type of the object is unknown. Once the object being linked to is created, and the type is known, then H5link object will change its type.
- Version:
- 2.7.2 7/6/2010
- Author:
- Nidhi Gupta
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from class hdf.object.HObject
fileFormat, linkTargetObjName, oid, SEPARATOR -
Constructor Summary
Constructors Constructor Description H5Link(FileFormat theFile, String name, String path)Constructs an HDF5 link with specific name, path, and parent.H5Link(FileFormat theFile, String theName, String thePath, long[] oid) -
Method Summary
Modifier and Type Method Description voidclose(long id)Closes access to the object.ListgetMetadata()Retrieves the object's metadata, such as attributes, from the file.ListgetMetadata(int... attrPropList)booleanhasAttribute()Check if the object has any attributes attached.longopen()Opens an existing object such as a dataset or group for access.voidremoveMetadata(Object info)Deletes an existing piece of metadata from this object.voidsetName(String newName)Sets the name of the object.voidupdateMetadata(Object info)Updates an existing piece of metadata attached to this object.voidwriteMetadata(Object info)Writes a specific piece of metadata (such as an attribute) into the file.Methods inherited from class hdf.object.HObject
createFullname, debug, equals, equals, equalsOID, getFID, getFile, getFileFormat, getFullName, getLinkTargetObjName, getName, getOID, getPath, hashCode, setFullname, setLinkTargetObjName, setPath, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
H5Link
Constructs an HDF5 link with specific name, path, and parent.- Parameters:
theFile- the file which containing the link.name- the name of this link, e.g. "link1".path- the full path of this link, e.g. "/groups/".
-
H5Link
-
-
Method Details
-
close
Description copied from class:HObjectCloses access to the object.Sub-classes must implement this interface because different data objects have their own ways of how the data resources are closed.
For example, H5Group.close() calls the hdf.hdf5lib.H5.H5Gclose() method and closes the group resource specified by the group id.
-
open
Description copied from class:HObjectOpens an existing object such as a dataset or group for access. The return value is an object identifier obtained by implementing classes such as H5.H5Dopen(). This function is needed to allow other objects to be able to access the object. For instance, H5File class uses the open() function to obtain object identifier for copyAttributes(long src_id, long dst_id) and other purposes. The open() function should be used in pair with close(long) function.- Specified by:
openin classHObject- Returns:
- the object identifier if successful; otherwise returns a negative value.
- See Also:
HObject.close(long)
-
getMetadata
Description copied from interface:MetaDataContainerRetrieves the object's metadata, such as attributes, from the file.Metadata, such as attributes, is stored in a List.
- Specified by:
getMetadatain interfaceMetaDataContainer- Returns:
- the list of metadata objects.
- Throws:
Exception- if the metadata can not be retrieved
-
hasAttribute
Description copied from interface:MetaDataContainerCheck if the object has any attributes attached.- Specified by:
hasAttributein interfaceMetaDataContainer- Returns:
- true if it has any attributes, false otherwise.
-
removeMetadata
Description copied from interface:MetaDataContainerDeletes an existing piece of metadata from this object.- Specified by:
removeMetadatain interfaceMetaDataContainer- Parameters:
info- the metadata to delete.- Throws:
Exception- if the metadata can not be removed
-
writeMetadata
Description copied from interface:MetaDataContainerWrites a specific piece of metadata (such as an attribute) into the file. If an HDF(4&5) attribute exists in the file, this method updates its value. If the attribute does not exist in the file, it creates the attribute in the file and attaches it to the object. It will fail to write a new attribute to the object where an attribute with the same name already exists. To update the value of an existing attribute in the file, one needs to get the instance of the attribute by getMetadata(), change its values, then use writeMetadata() to write the value.- Specified by:
writeMetadatain interfaceMetaDataContainer- Parameters:
info- the metadata to write.- Throws:
Exception- if the metadata can not be written
-
updateMetadata
Description copied from interface:MetaDataContainerUpdates an existing piece of metadata attached to this object.- Specified by:
updateMetadatain interfaceMetaDataContainer- Parameters:
info- the metadata to update.- Throws:
Exception- if the metadata can not be updated
-
getMetadata
- Throws:
Exception
-
setName
Description copied from class:HObjectSets the name of the object. setName (String newName) changes the name of the object in the file.
-