public abstract class Group extends HObject
Members of a group may include other groups, datasets or links.
Modifier and Type | Field and Description |
---|---|
static int |
CRT_ORDER_INDEXED |
static int |
CRT_ORDER_TRACKED |
static int |
LINK_TYPE_EXTERNAL |
static int |
LINK_TYPE_HARD |
static int |
LINK_TYPE_SOFT |
protected int |
nMembersInFile
Total number of (Groups and Datasets) of this group in file.
|
protected Group |
parent
The parent group where this group is located.
|
fileFormat, linkTargetObjName, oid, separator
Constructor and Description |
---|
Group(FileFormat theFile,
String name,
String path,
Group parent)
Constructs an instance of the group with specific name, path and parent
group.
|
Group(FileFormat theFile,
String name,
String path,
Group parent,
long[] oid)
Deprecated.
Not for public use in the future.
Using Group(FileFormat, String, String, Group) |
Modifier and Type | Method and Description |
---|---|
void |
addToMemberList(HObject object)
Adds an object to the member list of this group in memory.
|
void |
clear()
Clears up member list and other resources in memory for the group.
|
List<HObject> |
getMemberList()
Returns the list of members of this group.
|
int |
getNumberOfMembersInFile()
Returns the total number of members of this group in file.
|
Group |
getParent() |
boolean |
isRoot()
Checks if it is a root group.
|
void |
removeFromMemberList(HObject object)
Removes an object from the member list of this group in memory.
|
void |
setName(String newName)
Sets the name of the group.
|
close, debug, equals, equalsOID, getFID, getFile, getFileFormat, getFullName, getLinkTargetObjName, getName, getOID, getPath, open, setLinkTargetObjName, setPath, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getMetadata, hasAttribute, removeMetadata, updateMetadata, writeMetadata
protected Group parent
protected int nMembersInFile
public static final int LINK_TYPE_HARD
public static final int LINK_TYPE_SOFT
public static final int LINK_TYPE_EXTERNAL
public static final int CRT_ORDER_TRACKED
public static final int CRT_ORDER_INDEXED
public Group(FileFormat theFile, String name, String path, Group parent)
For example, in H5Group(h5file, "grp", "/groups/", pgroup), "grp" is the name of the group, "/groups/" is the group path of the group, and pgroup is the group where "grp" is located.
theFile
- the file containing the group.name
- the name of this group, e.g. "grp01".path
- the full path of this group, e.g. "/groups/".parent
- the parent of this group.@Deprecated public Group(FileFormat theFile, String name, String path, Group parent, long[] oid)
Group(FileFormat, String, String, Group)
theFile
- the file containing the group.name
- the name of this group, e.g. "grp01".path
- the full path of this group, e.g. "/groups/".parent
- the parent of this group.oid
- the oid of this group.public void clear()
public void addToMemberList(HObject object)
object
- the HObject (Group or Dataset) to be added to the member list.public void removeFromMemberList(HObject object)
object
- the HObject (Group or Dataset) to be removed from the member
list.public List<HObject> getMemberList()
public void setName(String newName) throws Exception
setName (String newName) changes the name of the group in memory and file.
setName() updates the path in memory for all the objects that are under the group with the new name.
public final boolean isRoot()
public int getNumberOfMembersInFile()
getNumberOfMembersInFile() returns the number of objects in this group. The number of objects in memory is obtained by getMemberList().size().
Copyright © 2017. All Rights Reserved.