Group (NetCDF-Java CDM API v5.0.0)

java.lang.Object
- ucar.nc2.CDMNode
- - ucar.nc2.Group

All Implemented Interfaces:

AttributeContainer
```
public class Group
extends CDMNode
implements AttributeContainer
```
A Group is a logical collection of Variables. The Groups in a Dataset form a hierarchical tree, like directories on a disk. A Group has a name and optionally a set of Attributes. There is always at least one Group in a dataset, the root Group, whose name is the empty string.
Immutable if setImmutable() was called.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AttributeContainerHelper`	`attributes`
`protected List<Dimension>`	`dimensions`
`protected List<EnumTypedef>`	`enumTypedefs`
`protected List<Group>`	`groups`
`protected NetcdfFile`	`ncfile`
`protected List<Variable>`	`variables`

Fields inherited from class ucar.nc2.CDMNode
annotations, dodsname, group, immutable, parentstruct, shortName, sort

Constructor Summary

Constructors
Constructor and Description

Group(NetcdfFile ncfile, Group parent, String shortName)
Constructor

Constructors
Constructor and Description
`Group(NetcdfFile ncfile, Group parent, String shortName)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAll(Iterable<Attribute> atts)` Add all; replace old if has same name
`Attribute`	`addAttribute(Attribute att)` Add new or replace old if has same name
`void`	`addDimension(Dimension dim)` Adds the specified shared dimension to this group.
`boolean`	`addDimensionIfNotExists(Dimension dim)` Adds the specified shared dimension to this group, but only if another dimension with the same name doesn't already exist.
`void`	`addEnumeration(EnumTypedef e)` Add an Enumeration
`void`	`addGroup(Group g)` Add a nested Group
`void`	`addVariable(Variable v)` Add a Variable
`Group`	`commonParent(Group other)` Get the common parent of this and the other group.
`boolean`	`equals(Object oo)` Instances which have same name and parent are equal.
`Attribute`	`findAttribute(String name)`
`Attribute`	`findAttributeIgnoreCase(String name)`
`String`	`findAttValueIgnoreCase(String attName, String defaultValue)` Find a String-valued Attribute by Attribute name (ignore case), return the (string) value of the Attribute.
`Dimension`	`findDimension(String name)` Retrieve a Dimension using its (short) name.
`Dimension`	`findDimensionLocal(String name)` Retrieve a Dimension using its (short) name, in this group only
`EnumTypedef`	`findEnumeration(String name)` Find an Enumeration Typedef using its (short) name.
`Group`	`findGroup(String groupShortName)` Retrieve the Group with the specified (short) name.
`Variable`	`findVariable(String varShortName)` Find the Variable with the specified (short) name in this group.
`Variable`	`findVariableOrInParent(String varShortName)` Find the Variable with the specified (short) name in this group or a parent group.
`List<Attribute>`	`getAttributes()` Returns the list of attributes for this variable.
`List<Dimension>`	`getDimensions()` Get the shared Dimensions contained directly in this group.
`List<EnumTypedef>`	`getEnumTypedefs()` Get the enumerations contained directly in this group.
`List<Group>`	`getGroups()` Get the Groups contained directly in this Group.
`String`	`getNameAndAttributes()` Get String with name and attributes.
`NetcdfFile`	`getNetcdfFile()` Get the owning NetcdfFile
`String`	`getShortName()` Get the "short" name, unique within its parent Group.
`List<Variable>`	`getVariables()` Get the Variables contained directly in this group.
`int`	`hashCode()` Override Object.hashCode() to implement equals.
`void`	`hashCodeShow(Indent indent)`
`boolean`	`isParent(Group other)` Is this a parent of the other Group?
`boolean`	`isRoot()` Is this the root group?
`Group`	`makeRelativeGroup(NetcdfFile ncf, String path, boolean ignorelast)` Create groups to ensure path is defined
`boolean`	`remove(Attribute a)` Remove an Attribute : uses the attribute hashCode to find it.
`boolean`	`remove(Dimension d)` Remove an Dimension : uses the dimension hashCode to find it.
`boolean`	`remove(Group g)` Remove an Attribute : uses the Group hashCode to find it.
`boolean`	`remove(Variable v)` Remove a Variable : uses the variable hashCode to find it.
`boolean`	`removeAttribute(String attName)` Remove an Attribute by name.
`boolean`	`removeAttributeIgnoreCase(String attName)` Remove an Attribute by name, ignoring case
`boolean`	`removeDimension(String dimName)` remove a Dimension using its name, in this group only
`boolean`	`removeVariable(String shortName)` remove a Variable using its (short) name, in this group only
`Group`	`setImmutable()` Make this immutable.
`String`	`setName(String shortName)` Set the short name, converting to valid CDM object name if needed.
`void`	`setParentGroup(Group parent)` Set the Group's parent Group
`String`	`toString()`
`String`	`writeCDL(boolean strict)` CDL representation.
`protected void`	`writeCDL(Formatter out, Indent indent, boolean strict)`

Methods inherited from class ucar.nc2.CDMNode
annotate, annotation, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentGroup, getParentStructure, getSort, isMemberOfStructure, localhash, setDODSName, setParentStructure, setShortName, setSort, unwrap

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

Methods inherited from interface ucar.nc2.AttributeContainer
getName

- Field Detail
  - ncfile
```
protected NetcdfFile ncfile
```
  - variables
```
protected List<Variable> variables
```
  - dimensions
```
protected List<Dimension> dimensions
```
  - groups
```
protected List<Group> groups
```
  - attributes
```
protected AttributeContainerHelper attributes
```
  - enumTypedefs
```
protected List<EnumTypedef> enumTypedefs
```
- Constructor Detail
  - Group
```
public Group(NetcdfFile ncfile,
             Group parent,
             String shortName)
```
    Constructor
    
    Parameters:
    
    ncfile - NetcdfFile owns this Group
    
    parent - parent of Group. If null, this is the root Group.
    
    shortName - short name of Group.
- Method Detail
  - isRoot
```
public boolean isRoot()
```
    Is this the root group?
    
    Returns:
    
    true if root group
  - getShortName
```
public String getShortName()
```
    Get the "short" name, unique within its parent Group.
    
    Overrides:
    
    getShortName in class CDMNode
    
    Returns:
    
    group short name
  - getVariables
```
public List<Variable> getVariables()
```
    Get the Variables contained directly in this group.
    
    Returns:
    
    List of type Variable; may be empty, not null.
  - findVariable
```
public Variable findVariable(String varShortName)
```
    Find the Variable with the specified (short) name in this group.
    
    Parameters:
    
    varShortName - short name of Variable within this group.
    
    Returns:
    
    the Variable, or null if not found
  - findVariableOrInParent
```
public Variable findVariableOrInParent(String varShortName)
```
    Find the Variable with the specified (short) name in this group or a parent group.
    
    Parameters:
    
    varShortName - short name of Variable.
    
    Returns:
    
    the Variable, or null if not found
  - getGroups
```
public List<Group> getGroups()
```
    Get the Groups contained directly in this Group.
    
    Returns:
    
    List of type Group; may be empty, not null.
  - getNetcdfFile
```
public NetcdfFile getNetcdfFile()
```
    Get the owning NetcdfFile
    
    Returns:
    
    owning NetcdfFile.
  - findGroup
```
public Group findGroup(String groupShortName)
```
    Retrieve the Group with the specified (short) name.
    
    Parameters:
    
    groupShortName - short name of the nested group you are looking for.
    
    Returns:
    
    the Group, or null if not found
  - getDimensions
```
public List<Dimension> getDimensions()
```
    Get the shared Dimensions contained directly in this group.
    
    Returns:
    
    List of type Dimension; may be empty, not null.
  - getEnumTypedefs
```
public List<EnumTypedef> getEnumTypedefs()
```
    Get the enumerations contained directly in this group.
    
    Returns:
    
    List of type EnumTypedef; may be empty, not null.
  - findDimension
```
public Dimension findDimension(String name)
```
    Retrieve a Dimension using its (short) name. If it doesnt exist in this group, recursively look in parent groups.
    
    Parameters:
    
    name - Dimension name.
    
    Returns:
    
    the Dimension, or null if not found
  - findDimensionLocal
```
public Dimension findDimensionLocal(String name)
```
    Retrieve a Dimension using its (short) name, in this group only
    
    Parameters:
    
    name - Dimension name.
    
    Returns:
    
    the Dimension, or null if not found
  - getAttributes
```
public List<Attribute> getAttributes()
```
    Description copied from interface: AttributeContainer
    
    Returns the list of attributes for this variable.
    
    Specified by:
    
    getAttributes in interface AttributeContainer
    
    Returns:
    
    list of attributes, immutable
  - findAttribute
```
public Attribute findAttribute(String name)
```
    Specified by:
    
    findAttribute in interface AttributeContainer
  - findAttributeIgnoreCase
```
public Attribute findAttributeIgnoreCase(String name)
```
    Specified by:
    
    findAttributeIgnoreCase in interface AttributeContainer
  - findAttValueIgnoreCase
```
public String findAttValueIgnoreCase(String attName,
                                     String defaultValue)
```
    Description copied from interface: AttributeContainer
    
    Find a String-valued Attribute by Attribute name (ignore case), return the (string) value of the Attribute.
    
    Specified by:
    
    findAttValueIgnoreCase in interface AttributeContainer
    
    Returns:
    
    the attribute value, or defaultValue if not found
  - addAttribute
```
public Attribute addAttribute(Attribute att)
```
    Description copied from interface: AttributeContainer
    
    Add new or replace old if has same name
    
    Specified by:
    
    addAttribute in interface AttributeContainer
    
    Parameters:
    
    att - add this Attribute
    
    Returns:
    
    the added attribute
  - addAll
```
public void addAll(Iterable<Attribute> atts)
```
    Description copied from interface: AttributeContainer
    
    Add all; replace old if has same name
    
    Specified by:
    
    addAll in interface AttributeContainer
  - remove
```
public boolean remove(Attribute a)
```
    Description copied from interface: AttributeContainer
    
    Remove an Attribute : uses the attribute hashCode to find it.
    
    Specified by:
    
    remove in interface AttributeContainer
    
    Parameters:
    
    a - remove this attribute
    
    Returns:
    
    true if was found and removed
  - removeAttribute
```
public boolean removeAttribute(String attName)
```
    Description copied from interface: AttributeContainer
    
    Remove an Attribute by name.
    
    Specified by:
    
    removeAttribute in interface AttributeContainer
    
    Parameters:
    
    attName - if exists, remove this attribute
    
    Returns:
    
    true if was found and removed
  - removeAttributeIgnoreCase
```
public boolean removeAttributeIgnoreCase(String attName)
```
    Description copied from interface: AttributeContainer
    
    Remove an Attribute by name, ignoring case
    
    Specified by:
    
    removeAttributeIgnoreCase in interface AttributeContainer
    
    Parameters:
    
    attName - if exists, remove this attribute
    
    Returns:
    
    true if was found and removed
  - findEnumeration
```
public EnumTypedef findEnumeration(String name)
```
    Find an Enumeration Typedef using its (short) name. If it doesnt exist in this group, recursively look in parent groups.
    
    Parameters:
    
    name - Enumeration name.
    
    Returns:
    
    the Enumeration, or null if not found
  - commonParent
```
public Group commonParent(Group other)
```
    Get the common parent of this and the other group. Cant fail, since the root group is always a parent of any 2 groups.
    
    Parameters:
    
    other - the other group
    
    Returns:
    
    common parent of this and the other group
  - isParent
```
public boolean isParent(Group other)
```
    Is this a parent of the other Group?
    
    Parameters:
    
    other - another Group
    
    Returns:
    
    true is it is equal or a parent
  - getNameAndAttributes
```
public String getNameAndAttributes()
```
    Get String with name and attributes. Used in short descriptions like tooltips.
    
    Returns:
    
    name and attributes String.
  - writeCDL
```
public String writeCDL(boolean strict)
```
    CDL representation.
    
    Parameters:
    
    strict - if true, write in strict adherence to CDL definition.
    
    Returns:
    
    CDL representation.
  - writeCDL
```
protected void writeCDL(Formatter out,
                        Indent indent,
                        boolean strict)
```
  - setParentGroup
```
public void setParentGroup(Group parent)
```
    Set the Group's parent Group
    
    Overrides:
    
    setParentGroup in class CDMNode
    
    Parameters:
    
    parent - parent group.
  - setName
```
public String setName(String shortName)
```
    Set the short name, converting to valid CDM object name if needed.
    
    Parameters:
    
    shortName - set to this value
    
    Returns:
    
    valid CDM object name
  - addDimension
```
public void addDimension(Dimension dim)
```
    Adds the specified shared dimension to this group.
    
    Parameters:
    
    dim - the dimension to add.
    
    Throws:
    
    IllegalStateException - if this dimension is immutable.
    
    IllegalArgumentException - if dim isn't shared or a dimension with dim's name already exists within the group.
  - addDimensionIfNotExists
```
public boolean addDimensionIfNotExists(Dimension dim)
```
    Adds the specified shared dimension to this group, but only if another dimension with the same name doesn't already exist.
    
    Parameters:
    
    dim - the dimension to add.
    
    Returns:
    
    true if dim was successfully added to the group. Otherwise, false will be returned, meaning that a dimension with dim's name already exists within the group.
    
    Throws:
    
    IllegalStateException - if this dimension is immutable.
    
    IllegalArgumentException - if dim isn't shared.
  - addGroup
```
public void addGroup(Group g)
```
    Add a nested Group
    
    Parameters:
    
    g - add this Group.
  - addEnumeration
```
public void addEnumeration(EnumTypedef e)
```
    Add an Enumeration
    
    Parameters:
    
    e - add this Enumeration.
  - addVariable
```
public void addVariable(Variable v)
```
    Add a Variable
    
    Parameters:
    
    v - add this Variable.
  - remove
```
public boolean remove(Dimension d)
```
    Remove an Dimension : uses the dimension hashCode to find it.
    
    Parameters:
    
    d - remove this Dimension.
    
    Returns:
    
    true if was found and removed
  - remove
```
public boolean remove(Group g)
```
    Remove an Attribute : uses the Group hashCode to find it.
    
    Parameters:
    
    g - remove this Group.
    
    Returns:
    
    true if was found and removed
  - remove
```
public boolean remove(Variable v)
```
    Remove a Variable : uses the variable hashCode to find it.
    
    Parameters:
    
    v - remove this Variable.
    
    Returns:
    
    true if was found and removed
  - removeDimension
```
public boolean removeDimension(String dimName)
```
    remove a Dimension using its name, in this group only
    
    Parameters:
    
    dimName - Dimension name.
    
    Returns:
    
    true if dimension found and removed
  - removeVariable
```
public boolean removeVariable(String shortName)
```
    remove a Variable using its (short) name, in this group only
    
    Parameters:
    
    shortName - Variable name.
    
    Returns:
    
    true if Variable found and removed
  - setImmutable
```
public Group setImmutable()
```
    Make this immutable.
    
    Overrides:
    
    setImmutable in class CDMNode
    
    Returns:
    
    this
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object oo)
```
    Instances which have same name and parent are equal.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Override Object.hashCode() to implement equals.
    
    Overrides:
    
    hashCode in class Object
  - hashCodeShow
```
public void hashCodeShow(Indent indent)
```
    Specified by:
    
    hashCodeShow in class CDMNode
  - makeRelativeGroup
```
public Group makeRelativeGroup(NetcdfFile ncf,
                               String path,
                               boolean ignorelast)
```
    Create groups to ensure path is defined
    
    Parameters:
    
    ncf - the containing netcdf file object
    
    path - the path to the desired group
    
    ignorelast - true => ignore last element in the path
    
    Returns:
    
    the Group, or null if not found

Class Group

Field Summary

Fields inherited from class ucar.nc2.CDMNode

Constructor Summary

Method Summary

Methods inherited from class ucar.nc2.CDMNode

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.nc2.AttributeContainer

Field Detail

ncfile

variables

dimensions

groups

attributes

enumTypedefs

Constructor Detail

Group

Method Detail

isRoot

getShortName

getVariables

findVariable

findVariableOrInParent

getGroups

getNetcdfFile

findGroup

getDimensions

getEnumTypedefs

findDimension

findDimensionLocal

getAttributes

findAttribute

findAttributeIgnoreCase

findAttValueIgnoreCase

addAttribute

addAll

remove

removeAttribute

removeAttributeIgnoreCase

findEnumeration

commonParent

isParent

getNameAndAttributes

writeCDL

writeCDL

setParentGroup

setName

addDimension

addDimensionIfNotExists

addGroup

addEnumeration

addVariable

remove

remove

remove

removeDimension

removeVariable

setImmutable

toString

equals

hashCode

hashCodeShow

makeRelativeGroup