Object
hdf.object.HObject
hdf.object.Group
hdf.object.fits.FitsGroup
- All Implemented Interfaces:
MetaDataContainer,Serializable
An H5Group represents HDF5 group, inheriting from Group.
Every HDF5 object has at least one name. An HDF5 group is used to store
a set of the names together in one place, i.e. a group. The general
structure of a group is similar to that of the UNIX file system in
that the group may contain references to other groups or data objects
just as the UNIX directory may contain subdirectories or files.
- Version:
- 1.1 9/4/2007
- Author:
- Peter X. Cao
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from class hdf.object.Group
CRT_ORDER_INDEXED, CRT_ORDER_TRACKED, LINK_TYPE_EXTERNAL, LINK_TYPE_HARD, LINK_TYPE_SOFT, nMembersInFile, parentFields inherited from class hdf.object.HObject
fileFormat, linkTargetObjName, oid, SEPARATOR -
Constructor Summary
ConstructorsConstructorDescriptionFitsGroup(FileFormat fileFormat, String name, String path, Group parent, long[] theID)Constructs an HDF5 group with specific name, path, and parent. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose(long gid)close group accessstatic FitsGroupCreates a new group.Retrieves the object's metadata, such as attributes, from the file.getMetadata(int... attrPropList)booleanCheck 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 attribute from this dataset.voidupdateMetadata(Object info)Updates an existing piece of metadata attached to this object.voidwriteMetadata(Object info)Creates a new attribute and attached to this dataset if attribute does not exist.Methods inherited from class hdf.object.Group
addToMemberList, breadthFirstMemberList, clear, depthFirstMemberList, getMember, getMemberList, getNumberOfMembersInFile, getParent, isRoot, removeFromMemberList, setNameMethods inherited from class hdf.object.HObject
createFullname, debug, equals, equals, equalsOID, getFID, getFile, getFileFormat, getFullName, getLinkTargetObjName, getName, getOID, getPath, hashCode, setFullname, setLinkTargetObjName, setPath, toString
-
Constructor Details
-
FitsGroup
Constructs an HDF5 group with specific name, path, and parent.- Parameters:
fileFormat- the file which containing the group.name- the name of this group.path- the full path of this group.parent- the parent of this group.theID- the unique identifier of this data object.
-
-
Method Details
-
hasAttribute
Description copied from interface:MetaDataContainerCheck if the object has any attributes attached.- Returns:
- true if it has any attributes, false otherwise.
-
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.
- Returns:
- the list of metadata objects.
- Throws:
Exception- if the metadata can not be retrieved
-
writeMetadata
Creates a new attribute and attached to this dataset if attribute does not exist. Otherwise, just update the value of the attribute.- Parameters:
info- the atribute to attach- Throws:
Exception- if the metadata can not be written
-
removeMetadata
Deletes an attribute from this dataset.- Parameters:
info- the attribute to delete.- Throws:
Exception- if the metadata can not be removed
-
updateMetadata
Description copied from interface:MetaDataContainerUpdates an existing piece of metadata attached to this object.- Parameters:
info- the metadata to update.- Throws:
Exception- if the metadata can not be updated
-
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)
-
close
close group access -
create
Creates a new group.- Parameters:
name- the name of the group to create.pgroup- the parent group of the new group.- Returns:
- the new group if successful. Otherwise returns null.
- Throws:
Exception- if there is an error
-
getMetadata
- Throws:
Exception
-