ucar.nc2

Class Group.Builder

java.lang.Object

ucar.nc2.Group.Builder

Enclosing class:

Group

public static class Group.Builder
extends Object

A builder of Groups.

Field Summary

Fields

Modifier and Type	Field and Description
List<Group.Builder>	gbuilders
Group.Builder	parentGroup
String	shortName
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(Iterable<Attribute> atts)
Group.Builder	addDimension(Dimension dim)
boolean	addDimensionIfNotExists(Dimension dim)
Group.Builder	addDimensions(Collection<Dimension> dims)
Group.Builder	addEnumTypedef(EnumTypedef typedef)
Group.Builder	addEnumTypedefs(Collection<EnumTypedef> typedefs)
Group.Builder	addGroup(Group.Builder nested) Add a nested Group.
Group.Builder	addGroups(Collection<Group.Builder> groups)
Group.Builder	addVariable(Variable.Builder<?> variable) Add a Variable, replacing one of same name if its exists.
Group.Builder	addVariables(Collection<Variable.Builder<?>> vars)
Group	build(Group parent) Normally this is called by NetcdfFile.build()
Group.Builder	commonParent(Group.Builder other)
Optional<Dimension>	findDimension(String name)
Optional<Dimension>	findDimensionLocal(String name)
Optional<EnumTypedef>	findEnumTypedef(String name)
Optional<Group.Builder>	findGroup(String name)
EnumTypedef	findOrAddEnumTypedef(String name, Map<Integer,String> map) Add a EnumTypedef if it does not already exist.
Optional<Variable.Builder<?>>	findVariable(String name)
AttributeContainerMutable	getAttributeContainer()
Iterable<Dimension>	getDimensions()
NetcdfFile	getNcfile() Deprecated.
boolean	isParent(Group.Builder other)
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(String dimString)
boolean	removeDimension(String name) Remove dimension, if it exists.
void	removeFromAny(Group.Builder group, Dimension want)
boolean	removeGroup(String name) Remove group, if it exists.
boolean	removeVariable(String name) Remove variable, if it exists.
boolean	replaceDimension(Dimension dim) Replace dimension of same name, 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(String shortName)
Group.Builder	setNcfile(NetcdfFile ncfile)
Group.Builder	setParentGroup(Group.Builder parentGroup)

Methods inherited from class java.lang.Object

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

Field Detail

parentGroup

@Nullable
public Group.Builder parentGroup

gbuilders

public List<Group.Builder> gbuilders

vbuilders

public List<Variable.Builder<?>> vbuilders

shortName

public String shortName

Constructor Detail

Builder

public Builder()

Method Detail

setParentGroup

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

addAttribute

public Group.Builder addAttribute(Attribute att)

addAttributes

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

getAttributeContainer

public AttributeContainerMutable getAttributeContainer()

addDimension

public Group.Builder addDimension(Dimension dim)

addDimensionIfNotExists

public boolean addDimensionIfNotExists(Dimension dim)

addDimensions

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

replaceDimension

public boolean replaceDimension(Dimension dim)

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

Returns:

true if there was an existing dimension of that name

removeDimension

public boolean removeDimension(String name)

Remove dimension, if it exists.

Returns:

true if there was an existing dimension of that name

findDimensionLocal

public Optional<Dimension> findDimensionLocal(String name)

findDimension

public Optional<Dimension> findDimension(String name)

getDimensions

public Iterable<Dimension> getDimensions()

addGroup

public Group.Builder addGroup(Group.Builder nested)

Add a nested Group.

addGroups

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

removeGroup

public boolean removeGroup(String name)

Remove group, if it exists.

Returns:

true if there was an existing group of that name

findGroup

public Optional<Group.Builder> findGroup(String name)

isParent

public boolean isParent(Group.Builder other)

commonParent

public Group.Builder commonParent(Group.Builder other)

addEnumTypedef

public Group.Builder addEnumTypedef(EnumTypedef typedef)

addEnumTypedefs

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

findOrAddEnumTypedef

public EnumTypedef findOrAddEnumTypedef(String name,
                                        Map<Integer,String> map)

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

findEnumTypedef

public Optional<EnumTypedef> findEnumTypedef(String name)

addVariable

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

Add a Variable, replacing one of same name if its exists.

addVariables

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

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(String name)

Remove variable, if it exists.

Returns:

true if there was an existing variable of that name

findVariable

public Optional<Variable.Builder<?>> findVariable(String name)

setNcfile

public Group.Builder setNcfile(NetcdfFile ncfile)

setName

public Group.Builder setName(String shortName)

getNcfile

@Deprecated
public NetcdfFile getNcfile()

Deprecated.

makeDimensionsList

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

Throws:

IllegalArgumentException

build

public Group build(Group parent)

Normally this is called by NetcdfFile.build()

removeFromAny

public void removeFromAny(Group.Builder group,
                          Dimension want)

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.