ucar.nc2

Class Group

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Group

All Implemented Interfaces:

java.lang.Iterable<Attribute>, AttributeContainer

public class Group
extends ucar.nc2.CDMNode
implements AttributeContainer

A logical collection of Variables, Attributes, and Dimensions. 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. TODO Group will be immutable in 6. TODO Group will not implement AttributeContainer in 6, use Group.attributes(). TODO Group will not extend CDMNode in 6.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.Builder A builder of Groups.

Method Summary

Modifier and Type	Method and Description
AttributeContainer	attributes() The attributes contained by this Group.
static Group.Builder	builder()
Group	commonParent(Group other) Get the common parent of this and the other group.
boolean	equals(java.lang.Object oo) Instances which have same name and parent are equal.
Attribute	findAttribute(java.lang.String name) Find the attribute by name, return null if not exist
java.lang.String	findAttributeString(java.lang.String attName, java.lang.String defaultValue) Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
Dimension	findDimension(Dimension dim) Find a Dimension in this or a parent Group, using equals.
Dimension	findDimension(java.lang.String name) Find a Dimension in this or a parent Group, matching on short name.
Dimension	findDimensionLocal(java.lang.String shortName) Find a Dimension using its (short) name, in this group only
EnumTypedef	findEnumeration(java.lang.String name) Find a Enumeration in this Group, using its short name.
EnumTypedef	findEnumeration(java.lang.String name, boolean searchup) Find a Enumeration in this or optionally the parent Groups, using its short name.
Group	findGroupLocal(java.lang.String groupShortName) Retrieve the Group with the specified (short) name.
EnumTypedef	findSimilarEnumTypedef(EnumTypedef template, boolean searchup) Locate an enum type definition that is structurally similar to the template type def.
Variable	findVariableByAttribute(java.lang.String attName, java.lang.String attValue) Look in this Group and in its nested Groups for a Variable with a String valued Attribute with the given name and value.
Variable	findVariableLocal(java.lang.String varShortName) Find the Variable with the specified (short) name in this group.
Variable	findVariableOrInParent(java.lang.String varShortName) Find the Variable with the specified (short) name in this group or a parent group.
java.util.List<Dimension>	getDimensions() Get the shared Dimensions contained directly in this group.
com.google.common.collect.ImmutableList<EnumTypedef>	getEnumTypedefs() Get the enumerations contained directly in this group.
java.lang.String	getFullName() Get the full name of this object.
com.google.common.collect.ImmutableList<Group>	getGroups() Get the Groups contained directly in this Group.
java.lang.String	getNameAndAttributes() Get String with name and attributes.
NetcdfFile	getNetcdfFile() Get the owning NetcdfFile
Group	getParentGroup() Get the parent Group, or null if its the root group.
java.util.List<Variable>	getVariables() Get the Variables contained directly in this group.
int	hashCode() Override Object.hashCode() to implement equals.
boolean	isParent(Group other) Is this a parent of the other Group?
boolean	isRoot() Is this the root group?
com.google.common.collect.ImmutableList<Dimension>	makeDimensionsList(java.lang.String dimString) Create a dimension list using dimension names.
Group.Builder	toBuilder() Turn into a mutable Builder.
java.lang.String	toString()

Methods inherited from class ucar.nc2.CDMNode

getShortName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.AttributeContainer

filter, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, getName, hasAttribute, hasAttributeIgnoreCase, isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

attributes

public AttributeContainer attributes()

The attributes contained by this Group.

builder

public static Group.Builder builder()

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

equals

public boolean equals(java.lang.Object oo)

Instances which have same name and parent are equal.

Overrides:

equals in class java.lang.Object

findAttribute

@Nullable
public Attribute findAttribute(java.lang.String name)

Find the attribute by name, return null if not exist

Specified by:

findAttribute in interface AttributeContainer

findAttributeString

public java.lang.String findAttributeString(java.lang.String attName,
                                            java.lang.String defaultValue)

Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.

Specified by:

findAttributeString in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

findDimension

@Nullable
public Dimension findDimension(Dimension dim)

Find a Dimension in this or a parent Group, using equals.

Parameters:

dim - Dimension .

Returns:

the Dimension, or null if not found

findDimension

@Nullable
public Dimension findDimension(java.lang.String name)

Find a Dimension in this or a parent Group, matching on short name.

Parameters:

name - Dimension name.

Returns:

the Dimension, or null if not found

findDimensionLocal

@Nullable
public Dimension findDimensionLocal(java.lang.String shortName)

Find a Dimension using its (short) name, in this group only

Parameters:

shortName - Dimension name.

Returns:

the Dimension, or null if not found

findEnumeration

@Nullable
public EnumTypedef findEnumeration(java.lang.String name)

Find a Enumeration in this Group, using its short name.

findEnumeration

@Nullable
public EnumTypedef findEnumeration(java.lang.String name,
                                             boolean searchup)

Find a Enumeration in this or optionally the parent Groups, using its short name.

findGroupLocal

@Nullable
public Group findGroupLocal(java.lang.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

findSimilarEnumTypedef

public EnumTypedef findSimilarEnumTypedef(EnumTypedef template,
                                          boolean searchup)

Locate an enum type definition that is structurally similar to the template type def. The Enum names are ignored.

Parameters:

template - match this enum type def

searchup - if true, then search this group and then parent groups.

findVariableByAttribute

@Nullable
public Variable findVariableByAttribute(java.lang.String attName,
                                                  java.lang.String attValue)

Look in this Group and in its nested Groups for a Variable with a String valued Attribute with the given name and value.

Parameters:

attName - look for an Attribuite with this name.

attValue - look for an Attribuite with this value.

Returns:

the first Variable that matches, or null if none match.

findVariableLocal

@Nullable
public Variable findVariableLocal(java.lang.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

@Nullable
public Variable findVariableOrInParent(java.lang.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

getDimensions

public java.util.List<Dimension> getDimensions()

Get the shared Dimensions contained directly in this group.

Returns:

List of type Dimension; may be empty, not null. TODO return ImmutableList

getEnumTypedefs

public com.google.common.collect.ImmutableList<EnumTypedef> getEnumTypedefs()

Get the enumerations contained directly in this group.

Returns:

List of type EnumTypedef; may be empty, not null.

getFullName

public java.lang.String getFullName()

Get the full name of this object. Certain characters are backslash escaped (see NetcdfFiles.getFullName(Group)) Not deprecated.

Overrides:

getFullName in class ucar.nc2.CDMNode

Returns:

full name with backslash escapes

getGroups

public com.google.common.collect.ImmutableList<Group> getGroups()

Get the Groups contained directly in this Group.

Returns:

List of type Group; may be empty, not null.

getNameAndAttributes

public java.lang.String getNameAndAttributes()

Get String with name and attributes. Used in short descriptions like tooltips.

Returns:

name and attributes String.

getNetcdfFile

public NetcdfFile getNetcdfFile()

Get the owning NetcdfFile

getParentGroup

@Nullable
public Group getParentGroup()

Get the parent Group, or null if its the root group. Not deprecated.

Overrides:

getParentGroup in class ucar.nc2.CDMNode

Returns:

parent Group

getVariables

public java.util.List<Variable> getVariables()

Get the Variables contained directly in this group.

Returns:

List of type Variable; may be empty, not null. TODO return ImmutableList

hashCode

public int hashCode()

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class java.lang.Object

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

isRoot

public boolean isRoot()

Is this the root group?

Returns:

true if root group

makeDimensionsList

public com.google.common.collect.ImmutableList<Dimension> makeDimensionsList(java.lang.String dimString)
                                                                      throws java.lang.IllegalArgumentException

Create a dimension list using dimension names. The dimension is searched for recursively in the parent groups.

Parameters:

dimString - : whitespace separated list of dimension names, or '*' for Dimension.UNKNOWN, or number for anon dimension. null or empty String is a scalar.

Returns:

list of dimensions, will return ImmutableList<> in version 6

Throws:

java.lang.IllegalArgumentException - if cant find dimension or parse error.

toBuilder

public Group.Builder toBuilder()

Turn into a mutable Builder. Can use toBuilder().build() to copy.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object