ucar.nc2

Class Group.Builder

java.lang.Object

ucar.nc2.Group.Builder

Enclosing class:

Group

public static class Group.Builder
extends java.lang.Object

A builder of Groups.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<EnumTypedef>	enumTypedefs
java.util.List<Group.Builder>	gbuilders
java.lang.String	shortName
java.util.List<Variable.Builder<?>>	vbuilders

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Group.Builder	addAttribute(Attribute att)
Group.Builder	addAttributes(java.lang.Iterable<Attribute> atts)
Group.Builder	addDimension(Dimension dim) Add Dimension with error if it already exists
boolean	addDimensionIfNotExists(Dimension dim) Add Dimension if it doesnt already exist
Group.Builder	addDimensions(java.util.Collection<Dimension> dims) Add Dimensions with error if any already exist
Group.Builder	addEnumTypedef(EnumTypedef typedef)
Group.Builder	addEnumTypedefs(java.util.Collection<EnumTypedef> typedefs)
Group.Builder	addGroup(Group.Builder nested) Add a nested Group.
Group.Builder	addGroups(java.util.Collection<Group.Builder> groups)
Group.Builder	addVariable(Variable.Builder<?> variable) Add a Variable, throw error if one of the same name if it exists.
Group.Builder	addVariables(java.util.Collection<Variable.Builder<?>> vars) Add Variables, throw error if one of the same name if it exists.
Group	build() Build the root group, with parent = null.
Group.Builder	commonParent(Group.Builder other) Find the common parent with the other group ?
boolean	contains(Dimension want) Is the Dimension contained within this Group or a parent Group
java.util.Optional<Dimension>	findDimension(java.lang.String name) Find Dimension in this Group or a parent Group
java.util.Optional<Dimension>	findDimensionLocal(java.lang.String name) Find Dimension local to this Group
java.util.Optional<EnumTypedef>	findEnumTypedef(java.lang.String name) Find a Enumeration in this Group Builder, using its short name.
java.util.Optional<EnumTypedef>	findEnumTypedef(java.lang.String name, boolean searchup) Find a Enumeration in this or a parent Group Builder, using its short name.
java.util.Optional<Group.Builder>	findGroupLocal(java.lang.String shortName)
java.util.Optional<Group.Builder>	findGroupNested(java.lang.String relativeName) Find a subgroup of this Group, with the specified relative name.
EnumTypedef	findOrAddEnumTypedef(java.lang.String name, java.util.Map<java.lang.Integer,java.lang.String> map) Add a EnumTypedef if it does not already exist.
java.util.Optional<EnumTypedef>	findSimilarEnumTypedef(EnumTypedef template, boolean searchup) Locate an enum type definition that is structurally similar to the template type def.
java.util.Optional<Variable.Builder<?>>	findVariableLocal(java.lang.String name)
java.util.Optional<Variable.Builder<?>>	findVariableNested(java.lang.String relativeName) Find a Variable, with the specified relative name.
java.util.Optional<Variable.Builder<?>>	findVariableOrInParent(java.lang.String varShortName) Find the Variable with the specified (short) name in this group or a parent group.
AttributeContainerMutable	getAttributeContainer()
java.lang.Iterable<Dimension>	getDimensions()
NetcdfFile	getNcfile() Deprecated.
Group.Builder	getParentGroup()
boolean	isParent(Group.Builder other) Is this group a parent of the other group ?
void	makeDimensionMap(Group.Builder parent, com.google.common.collect.Multimap<Dimension,Variable.Builder<?>> dimUsedMap) Make a multimap of Dimensions and all the variables that reference them, in this group and its nested groups.
com.google.common.collect.ImmutableList<Dimension>	makeDimensionsList(java.lang.String dimString) Make list of dimensions by looking in this Group or parent groups
java.lang.String	makeFullName() Make the full name of the this group.
boolean	removeDimension(java.lang.String name) Remove dimension, if it exists.
void	removeDimensionFromAllGroups(Group.Builder group, Dimension remove) Remove the given dimension from this group and any subgroups
boolean	removeGroup(java.lang.String name) Remove group, if it exists.
boolean	removeVariable(java.lang.String name) Remove variable, if it exists.
boolean	replaceDimension(Dimension dim) Replace dimension if it exists, else just add it.
boolean	replaceVariable(Variable.Builder<?> vb) Replace variable of same name, if it exists, else just add it.
Group.Builder	setName(java.lang.String shortName)
Group.Builder	setNcfile(NetcdfFile ncfile)
Group.Builder	setParentGroup(Group.Builder parentGroup)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gbuilders

public java.util.List<Group.Builder> gbuilders

vbuilders

public java.util.List<Variable.Builder<?>> vbuilders

shortName

public java.lang.String shortName

enumTypedefs

public java.util.List<EnumTypedef> enumTypedefs

Constructor Detail

Builder

public Builder()

Method Detail

setParentGroup

public Group.Builder setParentGroup(@Nullable
                                    Group.Builder parentGroup)

getParentGroup

@Nullable
public Group.Builder getParentGroup()

addAttribute

public Group.Builder addAttribute(Attribute att)

addAttributes

public Group.Builder addAttributes(java.lang.Iterable<Attribute> atts)

getAttributeContainer

public AttributeContainerMutable getAttributeContainer()

addDimension

public Group.Builder addDimension(Dimension dim)

Add Dimension with error if it already exists

addDimensionIfNotExists

public boolean addDimensionIfNotExists(Dimension dim)

Add Dimension if it doesnt already exist

addDimensions

public Group.Builder addDimensions(java.util.Collection<Dimension> dims)

Add Dimensions with error if any already exist

replaceDimension

public boolean replaceDimension(Dimension dim)

Replace dimension if it exists, else just add it.

Returns:

true if there was an existing dimension of that name

removeDimension

public boolean removeDimension(java.lang.String name)

Remove dimension, if it exists.

Returns:

true if there was an existing dimension of that name

findDimensionLocal

public java.util.Optional<Dimension> findDimensionLocal(java.lang.String name)

Find Dimension local to this Group

contains

public boolean contains(Dimension want)

Is the Dimension contained within this Group or a parent Group

findDimension

public java.util.Optional<Dimension> findDimension(java.lang.String name)

Find Dimension in this Group or a parent Group

getDimensions

public java.lang.Iterable<Dimension> getDimensions()

addGroup

public Group.Builder addGroup(Group.Builder nested)

Add a nested Group.

addGroups

public Group.Builder addGroups(java.util.Collection<Group.Builder> groups)

removeGroup

public boolean removeGroup(java.lang.String name)

Remove group, if it exists.

Returns:

true if there was an existing group of that name

findGroupLocal

public java.util.Optional<Group.Builder> findGroupLocal(java.lang.String shortName)

findGroupNested

public java.util.Optional<Group.Builder> findGroupNested(java.lang.String relativeName)

Find a subgroup of this Group, with the specified relative name. An embedded "/" separates group names. Can have a leading "/" only if this is the root group.

Parameters:

relativeName - eg "group/subgroup/wantGroup".

Returns:

Group or empty if not found.

isParent

public boolean isParent(Group.Builder other)

Is this group a parent of the other group ?

commonParent

public Group.Builder commonParent(Group.Builder other)

Find the common parent with the other group ?

findSimilarEnumTypedef

public java.util.Optional<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.

findEnumTypedef

public java.util.Optional<EnumTypedef> findEnumTypedef(java.lang.String name)

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

findEnumTypedef

public java.util.Optional<EnumTypedef> findEnumTypedef(java.lang.String name,
                                                       boolean searchup)

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

Parameters:

name - for which to search

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

addEnumTypedef

public Group.Builder addEnumTypedef(EnumTypedef typedef)

addEnumTypedefs

public Group.Builder addEnumTypedefs(java.util.Collection<EnumTypedef> typedefs)

findOrAddEnumTypedef

public EnumTypedef findOrAddEnumTypedef(java.lang.String name,
                                        java.util.Map<java.lang.Integer,java.lang.String> map)

Add a EnumTypedef if it does not already exist. Return new or existing.

addVariable

public Group.Builder addVariable(Variable.Builder<?> variable)

Add a Variable, throw error if one of the same name if it exists.

addVariables

public Group.Builder addVariables(java.util.Collection<Variable.Builder<?>> vars)

Add Variables, throw error if one of the same name if it exists.

replaceVariable

public boolean replaceVariable(Variable.Builder<?> vb)

Replace variable of same name, if it exists, else just add it.

Returns:

true if there was an existing variable of that name

removeVariable

public boolean removeVariable(java.lang.String name)

Remove variable, if it exists.

Returns:

true if there was an existing variable of that name

findVariableLocal

public java.util.Optional<Variable.Builder<?>> findVariableLocal(java.lang.String name)

findVariableNested

public java.util.Optional<Variable.Builder<?>> findVariableNested(java.lang.String relativeName)

Find a Variable, with the specified relative name. No structure members.

Parameters:

relativeName - eg "group/subgroup/varname".

findVariableOrInParent

public java.util.Optional<Variable.Builder<?>> 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 empty.

setNcfile

public Group.Builder setNcfile(NetcdfFile ncfile)

setName

public Group.Builder setName(java.lang.String shortName)

getNcfile

@Deprecated
public NetcdfFile getNcfile()

Deprecated.

makeDimensionsList

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

Make list of dimensions by looking in this Group or parent groups

Throws:

java.lang.IllegalArgumentException

makeFullName

public java.lang.String makeFullName()

Make the full name of the this group. TODO In light of CF groups, we may have to start full names with '/'

removeDimensionFromAllGroups

public void removeDimensionFromAllGroups(Group.Builder group,
                                         Dimension remove)

Remove the given dimension from this group and any subgroups

makeDimensionMap

public void makeDimensionMap(Group.Builder parent,
                             com.google.common.collect.Multimap<Dimension,Variable.Builder<?>> dimUsedMap)

Make a multimap of Dimensions and all the variables that reference them, in this group and its nested groups.

build

public Group build()

Build the root group, with parent = null.