|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectncsa.hdf.object.HObject
ncsa.hdf.object.Group
ncsa.hdf.object.h5.H5Group
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.
Field Summary | |
static long[] |
DEFAULT_OID
The default object ID for HDF5 objects |
Fields inherited from class ncsa.hdf.object.HObject |
hasAttribute, oid, separator |
Constructor Summary | |
H5Group(FileFormat fileFormat,
java.lang.String name,
java.lang.String path,
Group parent)
|
|
H5Group(FileFormat fileFormat,
java.lang.String name,
java.lang.String path,
Group parent,
long[] theID)
Constructs an HDF5 group with specific name, path, and parent. |
Method Summary | |
void |
close(int gid)
close group access |
static H5Group |
create(java.lang.String name,
Group pgroup)
Creates a new group. |
java.util.List |
getMetadata()
Loads the metadata such as attributes and type of the the data object into memory if the metadata is not loaded. |
int |
open()
Opens access to this object. |
void |
removeMetadata(java.lang.Object info)
Deletes an attribute from this dataset. |
void |
setName(java.lang.String newName)
Sets the name of the data object. |
void |
setPath(java.lang.String newPath)
Sets the path of the data object. |
void |
writeMetadata(java.lang.Object info)
Creates a new attribute and attached to this dataset if attribute does not exist. |
Methods inherited from class ncsa.hdf.object.Group |
addToMemberList, getMemberList, getNumberOfMembersInFile, getParent, isRoot, removeFromMemberList, setNumberOfMembersInFile |
Methods inherited from class ncsa.hdf.object.HObject |
equalsOID, getFID, getFile, getFileFormat, getName, getOID, getPath, hasAttribute, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final long[] DEFAULT_OID
Constructor Detail |
public H5Group(FileFormat fileFormat, java.lang.String name, java.lang.String path, Group parent)
public H5Group(FileFormat fileFormat, java.lang.String name, java.lang.String path, Group parent, long[] theID)
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.Method Detail |
public java.util.List getMetadata() throws HDF5Exception
DataFormat
HDF5Exception
List
public void writeMetadata(java.lang.Object info) throws java.lang.Exception
info
- the atribute to attach
java.lang.Exception
public void removeMetadata(java.lang.Object info) throws HDF5Exception
info
- the attribute to delete.
HDF5Exception
public int open()
HObject
Sub-classes have to implement this interface so that different data objects have their own ways of how the data resources are opened.
open
in class HObject
public void close(int gid)
close
in class HObject
gid
- the object identifier.
Sub-classes have to implement this interface so that different data
objects have their own ways of how the data resources are closed.public static H5Group create(java.lang.String name, Group pgroup) throws java.lang.Exception
name
- the name of the group to create.pgroup
- the parent group of the new group.
java.lang.Exception
public void setName(java.lang.String newName) throws java.lang.Exception
setName
in class HObject
newName
- the new name of the object.
java.lang.Exception
public void setPath(java.lang.String newPath) throws java.lang.Exception
setPath
in class HObject
newPath
- the new path of the object.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |