H5Group (hdf5 API)

java.lang.Object

nz.org.riskscape.hdf5.H5Object

nz.org.riskscape.hdf5.H5Group

All Implemented Interfaces:: AutoCloseable

public class H5Group extends H5Object

Methods for inspecting and accessing elements within an H5Group. Groups should be constructed/accessed via H5File

Field Summary

Fields inherited from class nz.org.riskscape.hdf5.H5Object
ptr
Method Summary

Modifier and Type

Method

Description

void

close()

String

getGroupName()

H5Group

getParent()

The group above this one.

boolean

isRoot()

H5Object

openChild(String childName)

Opens either a group or dataset, which is a member of this group, by its name

String

toString()

void

visit(H5GroupVisitor visitor)

Visit all the child objects (other groups and datasets) of this group using a callback

Methods inherited from class nz.org.riskscape.hdf5.H5Object
getPointer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- close
  
  public void close()
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in class H5Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- isRoot
  
  public boolean isRoot()
  
  Returns:
  
  true if this group is at the root of an hdf5file, e.g. its name is "/"
- visit
  
  public void visit(H5GroupVisitor visitor)
  
  Visit all the child objects (other groups and datasets) of this group using a callback
  
  Parameters:
  
  visitor - callback that sees the children.
- openChild
  
  public H5Object openChild(String childName)
  
  Opens either a group or dataset, which is a member of this group, by its name
- getParent
  
  public H5Group getParent()
  
  The group above this one. Note that this isn't going to be 100% reliable right now - it might skip path elements depending on how it was constructed. Returns itself if this is the parent group
- getGroupName
  
  public String getGroupName()