ucar.nc2

Class Variable.Builder<T extends Variable.Builder<T>>

java.lang.Object

ucar.nc2.Variable.Builder<T>

Direct Known Subclasses:

Structure.Builder, VariableDS.Builder

Enclosing class:

Variable

public abstract static class Variable.Builder<T extends Variable.Builder<T>>
extends java.lang.Object

A builder for Variables.

Field Summary

Fields

Modifier and Type	Field and Description
Variable.Cache	cache
DataType	dataType
NetcdfFile	ncfile
protected Group.Builder	parentBuilder
protected Structure.Builder<?>	parentStructureBuilder
ProxyReader	proxyReader
java.lang.String	shortName
java.lang.Object	spiObject

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
T	addAttribute(Attribute att)
T	addAttributes(java.lang.Iterable<Attribute> atts)
T	addDimension(Dimension dim)
T	addDimensions(java.util.Collection<Dimension> dims)
Variable	build(Group parentGroup) Normally this is called by Group.build()
Variable.Builder<?>	copy()
T	copyFrom(Variable.Builder<?> builder)
T	copyFrom(Variable orgVar) TODO Copy metadata from orgVar.
AttributeContainerMutable	getAttributeContainer()
java.lang.String	getDimensionName(int index)
java.lang.Iterable<java.lang.String>	getDimensionNames()
com.google.common.collect.ImmutableList<Dimension>	getDimensions()
com.google.common.collect.ImmutableSet<java.lang.String>	getDimensionsAll()
int	getElementSize()
java.lang.String	getEnumTypeName()
java.lang.String	getFirstDimensionName()
java.lang.String	getFullName()
Group.Builder	getParentGroupBuilder()
Structure.Builder<?>	getParentStructureBuilder()
int	getRank()
java.lang.String	makeDimensionsString()
Variable.Builder<?>	makeSliceBuilder(int dim, int index) Create a new Variable.Builder that is a logical slice of this one, by fixing the specified dimension at the specified index value.
boolean	replaceDimensionByName(Dimension dim) Find the dimension with the same name as dim, and replace it with dim
T	resetCache()
protected abstract T	self()
T	setAutoGen(double start, double incr)
T	setCachedData(Array cacheData, boolean isMetadata)
T	setCaching(boolean caching)
T	setDataType(DataType dataType)
T	setDimensions(java.util.List<Dimension> dims)
T	setDimensionsAnonymous(int[] shape) Set the dimensions using all anonymous (unshared) dimensions
T	setDimensionsByName(java.lang.String dimString) Set dimensions by name.
T	setElementSize(int elementSize)
T	setEnumTypeName(java.lang.String enumTypeName)
T	setIsScalar()
T	setName(java.lang.String shortName)
T	setNcfile(NetcdfFile ncfile)
T	setParentGroupBuilder(Group.Builder parent)
T	setProxyReader(ProxyReader proxy)
T	setSPobject(java.lang.Object spiObject)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

shortName

public java.lang.String shortName

dataType

public DataType dataType

ncfile

public NetcdfFile ncfile

parentBuilder

protected Group.Builder parentBuilder

parentStructureBuilder

protected Structure.Builder<?> parentStructureBuilder

spiObject

public java.lang.Object spiObject

proxyReader

public ProxyReader proxyReader

cache

public Variable.Cache cache

Constructor Detail

Builder

public Builder()

Method Detail

self

protected abstract T self()

addAttribute

public T addAttribute(Attribute att)

addAttributes

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

getAttributeContainer

public AttributeContainerMutable getAttributeContainer()

addDimension

public T addDimension(Dimension dim)

addDimensions

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

setDimensions

public T setDimensions(java.util.List<Dimension> dims)

replaceDimensionByName

public boolean replaceDimensionByName(Dimension dim)

Find the dimension with the same name as dim, and replace it with dim

setDimensionsByName

public T setDimensionsByName(java.lang.String dimString)

Set dimensions by name. The parent group builder must be set.

getFirstDimensionName

@Nullable
public java.lang.String getFirstDimensionName()

getDimensionName

@Nullable
public java.lang.String getDimensionName(int index)

getDimensionNames

public java.lang.Iterable<java.lang.String> getDimensionNames()

makeDimensionsString

public java.lang.String makeDimensionsString()

setDimensionsAnonymous

public T setDimensionsAnonymous(int[] shape)

Set the dimensions using all anonymous (unshared) dimensions

Parameters:

shape - defines the dimension lengths. must be > 0, or -1 for VLEN

Throws:

java.lang.RuntimeException - if any shape < 1 and not -1.

getDimensions

public com.google.common.collect.ImmutableList<Dimension> getDimensions()

getDimensionsAll

public com.google.common.collect.ImmutableSet<java.lang.String> getDimensionsAll()

setIsScalar

public T setIsScalar()

getRank

public int getRank()

setDataType

public T setDataType(DataType dataType)

getEnumTypeName

public java.lang.String getEnumTypeName()

getElementSize

public int getElementSize()

setElementSize

public T setElementSize(int elementSize)

setEnumTypeName

public T setEnumTypeName(java.lang.String enumTypeName)

setNcfile

public T setNcfile(NetcdfFile ncfile)

setSPobject

public T setSPobject(java.lang.Object spiObject)

setName

public T setName(java.lang.String shortName)

getFullName

public java.lang.String getFullName()

setParentGroupBuilder

public T setParentGroupBuilder(Group.Builder parent)

getParentGroupBuilder

public Group.Builder getParentGroupBuilder()

getParentStructureBuilder

public Structure.Builder<?> getParentStructureBuilder()

setProxyReader

public T setProxyReader(ProxyReader proxy)

setCachedData

public T setCachedData(Array cacheData,
                       boolean isMetadata)

setAutoGen

public T setAutoGen(double start,
                    double incr)

resetCache

public T resetCache()

setCaching

public T setCaching(boolean caching)

makeSliceBuilder

public Variable.Builder<?> makeSliceBuilder(int dim,
                                            int index)

Create a new Variable.Builder that is a logical slice of this one, by fixing the specified dimension at the specified index value.

Parameters:

dim - which dimension to fix

index - at what index value

copy

public Variable.Builder<?> copy()

copyFrom

public T copyFrom(Variable orgVar)

TODO Copy metadata from orgVar.

copyFrom

public T copyFrom(Variable.Builder<?> builder)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

build

public Variable build(Group parentGroup)

Normally this is called by Group.build()