ucar.nc2

Class Group

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Group

All Implemented Interfaces:

Iterable<Attribute>, AttributeContainer

public class Group
extends 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.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Group(NetcdfFile ncfile, Group parent, String shortName) Deprecated. Use Group.builder()

Method Summary

Modifier and Type	Method and Description
void	addAll(Iterable<Attribute> atts) Deprecated. Use Group.builder()
Attribute	addAttribute(Attribute att) Deprecated. Use Group.builder()
void	addDimension(Dimension dim) Deprecated. Use Group.builder()
boolean	addDimensionIfNotExists(Dimension dim) Deprecated. Use Group.builder()
void	addEnumeration(EnumTypedef e) Deprecated. Use Group.builder()
void	addGroup(Group g) Deprecated. Use Group.builder()
void	addVariable(Variable v) Deprecated. Use Group.builder()
AttributeContainer	attributes()
static Group.Builder	builder(Group.Builder parent)
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) Find the attribute by name, return null if not exist
double	findAttributeDouble(String attName, double defaultValue) Deprecated. Use attributes()
Attribute	findAttributeIgnoreCase(String name) Deprecated. Use attributes()
int	findAttributeInteger(String attName, int defaultValue) Deprecated. Use attributes()
String	findAttValueIgnoreCase(String attName, 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(String name) Retrieve a Dimension using its (short) name.
Dimension	findDimensionLocal(String shortName) 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() Deprecated. Use attributes()
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
Group	getParentGroup() Get its parent Group, or null if its the root group.
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.
boolean	isParent(Group other) Is this a parent of the other Group?
boolean	isRoot() Is this the root group?
List<Dimension>	makeDimensionsList(String dimString) Create a dimension list using dimension names.
Group	makeRelativeGroup(NetcdfFile ncf, String path, boolean ignorelast) Deprecated. do not use
boolean	remove(Attribute a) Deprecated. Use Group.builder()
boolean	remove(Dimension d) Deprecated. Use Group.builder()
boolean	remove(Group g) Deprecated. Use Group.builder()
boolean	remove(Variable v) Deprecated. Use Group.builder()
boolean	removeAttribute(String attName) Deprecated. Use Group.builder()
boolean	removeAttributeIgnoreCase(String attName) Deprecated. Use Group.builder()
boolean	removeDimension(String dimName) Deprecated. Use Group.builder()
boolean	removeVariable(String shortName) Deprecated. Use Group.builder()
Group	setImmutable() Deprecated. Use Group.builder()
String	setName(String shortName) Deprecated. Use Group.builder()
void	setParentGroup(Group parent) Deprecated. Use Group.builder()
Group.Builder	toBuilder() Turn into a mutable Builder.
String	toString()
String	writeCDL(boolean strict) Deprecated. use CDLWriter

Methods inherited from class ucar.nc2.CDMNode

annotate, annotation, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentStructure, getSort, isMemberOfStructure, localhash, setDODSName, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.AttributeContainer

getName, hasAttribute, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Group

@Deprecated
public Group(NetcdfFile ncfile,
                         Group parent,
                         String shortName)

Deprecated. Use Group.builder()

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. Will return ImmutableList<> in version 6

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

getParentGroup

@Nullable
public Group getParentGroup()

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

Overrides:

getParentGroup in class CDMNode

Returns:

parent Group

getGroups

public List<Group> getGroups()

Get the Groups contained directly in this Group.

Returns:

List of type Group; may be empty, not null. Will return ImmutableList<> in version 6

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. Will return ImmutableList<> in version 6

makeDimensionsList

public List<Dimension> makeDimensionsList(String dimString)
                                   throws 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:

IllegalArgumentException - if cant find dimension or parse error.

getEnumTypedefs

public List<EnumTypedef> getEnumTypedefs()

Get the enumerations contained directly in this group.

Returns:

List of type EnumTypedef; may be empty, not null. Will return ImmutableList<> in version 6

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

findDimension

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

findDimensionLocal

public Dimension findDimensionLocal(String shortName)

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

Parameters:

shortName - Dimension name.

Returns:

the Dimension, or null if not found

attributes

public AttributeContainer attributes()

findAttribute

@Nullable
public Attribute findAttribute(String name)

Find the attribute by name, return null if not exist

Specified by:

findAttribute in interface AttributeContainer

findAttValueIgnoreCase

public String findAttValueIgnoreCase(String attName,
                                     String defaultValue)

Find a String-valued Attribute by 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

getAttributes

@Deprecated
public List<Attribute> getAttributes()

Deprecated. Use attributes()

Description copied from interface: AttributeContainer

Returns immutable list of attributes.

Specified by:

getAttributes in interface AttributeContainer

findAttributeIgnoreCase

@Deprecated
public Attribute findAttributeIgnoreCase(String name)

Deprecated. Use attributes()

Description copied from interface: AttributeContainer

Find an Attribute by name, first try doing an exact match, then try ignoring case.

Specified by:

findAttributeIgnoreCase in interface AttributeContainer

findAttributeDouble

@Deprecated
public double findAttributeDouble(String attName,
                                              double defaultValue)

Deprecated. Use attributes()

Description copied from interface: AttributeContainer

Find a Numeric Attribute by name (ignore case), return the double value of the Attribute.

Specified by:

findAttributeDouble in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

findAttributeInteger

@Deprecated
public int findAttributeInteger(String attName,
                                            int defaultValue)

Deprecated. Use attributes()

Description copied from interface: AttributeContainer

Find a Numeric Attribute by name (ignore case), return the integer value of the Attribute.

Specified by:

findAttributeInteger in interface AttributeContainer

Returns:

the attribute value, or defaultValue if not found

addAttribute

@Deprecated
public Attribute addAttribute(Attribute att)

Deprecated. Use Group.builder()

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

@Deprecated
public void addAll(Iterable<Attribute> atts)

Deprecated. Use Group.builder()

Description copied from interface: AttributeContainer

Add all; replace old if has same name

Specified by:

addAll in interface AttributeContainer

remove

@Deprecated
public boolean remove(Attribute a)

Deprecated. Use Group.builder()

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

@Deprecated
public boolean removeAttribute(String attName)

Deprecated. Use Group.builder()

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

@Deprecated
public boolean removeAttributeIgnoreCase(String attName)

Deprecated. Use Group.builder()

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

@Deprecated
public String writeCDL(boolean strict)

Deprecated. use CDLWriter

CDL representation.

Parameters:

strict - if true, write in strict adherence to CDL definition.

Returns:

CDL representation.

setParentGroup

@Deprecated
public void setParentGroup(Group parent)

Deprecated. Use Group.builder()

Set the Group's parent Group

Overrides:

setParentGroup in class CDMNode

Parameters:

parent - parent group.

setName

@Deprecated
public String setName(String shortName)

Deprecated. Use Group.builder()

Set the short name, converting to valid CDM object name if needed.

Parameters:

shortName - set to this value

Returns:

valid CDM object name

addDimension

@Deprecated
public void addDimension(Dimension dim)

Deprecated. Use Group.builder()

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

@Deprecated
public boolean addDimensionIfNotExists(Dimension dim)

Deprecated. Use Group.builder()

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

@Deprecated
public void addGroup(Group g)

Deprecated. Use Group.builder()

Add a nested Group

Parameters:

g - add this Group.

addEnumeration

@Deprecated
public void addEnumeration(EnumTypedef e)

Deprecated. Use Group.builder()

Add an Enumeration

Parameters:

e - add this Enumeration.

addVariable

@Deprecated
public void addVariable(Variable v)

Deprecated. Use Group.builder()

Add a Variable

Parameters:

v - add this Variable.

remove

@Deprecated
public boolean remove(Dimension d)

Deprecated. Use Group.builder()

Remove an Dimension : uses the dimension hashCode to find it.

Parameters:

d - remove this Dimension.

Returns:

true if was found and removed

remove

@Deprecated
public boolean remove(Group g)

Deprecated. Use Group.builder()

Remove an Attribute : uses the Group hashCode to find it.

Parameters:

g - remove this Group.

Returns:

true if was found and removed

remove

@Deprecated
public boolean remove(Variable v)

Deprecated. Use Group.builder()

Remove a Variable : uses the variable hashCode to find it.

Parameters:

v - remove this Variable.

Returns:

true if was found and removed

removeDimension

@Deprecated
public boolean removeDimension(String dimName)

Deprecated. Use Group.builder()

remove a Dimension using its name, in this group only

Parameters:

dimName - Dimension name.

Returns:

true if dimension found and removed

removeVariable

@Deprecated
public boolean removeVariable(String shortName)

Deprecated. Use Group.builder()

remove a Variable using its (short) name, in this group only

Parameters:

shortName - Variable name.

Returns:

true if Variable found and removed

setImmutable

@Deprecated
public Group setImmutable()

Deprecated. Use Group.builder()

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

makeRelativeGroup

@Deprecated
public Group makeRelativeGroup(NetcdfFile ncf,
                                           String path,
                                           boolean ignorelast)

Deprecated. do not use

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

toBuilder

public Group.Builder toBuilder()

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

builder

public static Group.Builder builder(@Nullable
                                    Group.Builder parent)