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 Object

A builder for Variables.

Field Summary

Fields

Modifier and Type	Field and Description
ucar.nc2.Variable.Cache	cache
DataType	dataType
NetcdfFile	ncfile
Group	parent
Structure	parentStruct
ProxyReader	proxyReader
String	shortName
Object	spiObject

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
T	addAttribute(Attribute att)
T	addAttributes(Iterable<Attribute> atts)
T	addDimension(Dimension dim)
T	addDimensions(Collection<Dimension> dims)
Variable	build() Normally this is called by Group.build()
List<Dimension>	copyDimensions() Deprecated.
T	copyFrom(Variable.Builder<?> builder)
T	copyFrom(Variable orgVar) TODO Copy metadata from orgVar.
AttributeContainerMutable	getAttributeContainer()
String	getDimensionName(int index)
Iterable<String>	getDimensionNames()
com.google.common.collect.ImmutableList<Dimension>	getDimensions(Group.Builder gb)
com.google.common.collect.ImmutableSet<String>	getDimensionsAll()
String	getEnumTypeName()
String	getFirstDimensionName()
int	getRank()
String	makeDimensionsString()
boolean	replaceDimension(Dimension dim)
T	resetCache()
T	setAutoGen(double start, double incr)
T	setCachedData(Array cacheData, boolean isMetadata)
T	setCaching(boolean caching)
T	setDataType(DataType dataType)
T	setDimensions(List<Dimension> dims)
T	setDimensionsAnonymous(int[] shape) Set the dimensions using all anonymous (unshared) dimensions
T	setDimensionsByName(String dimString)
T	setElementSize(int elementSize)
T	setEnumTypeName(String enumTypeName)
T	setGroup(Group parent)
T	setIsScalar()
T	setName(String shortName)
T	setNcfile(NetcdfFile ncfile)
T	setParentStructure(Structure parent)
T	setProxyReader(ProxyReader proxy)
T	setSPobject(Object spiObject)

Methods inherited from class java.lang.Object

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

Field Detail

shortName

public String shortName

dataType

public DataType dataType

ncfile

public NetcdfFile ncfile

parent

public Group parent

parentStruct

public Structure parentStruct

spiObject

public Object spiObject

proxyReader

public ProxyReader proxyReader

cache

public ucar.nc2.Variable.Cache cache

Constructor Detail

Builder

public Builder()

Method Detail

addAttribute

public T addAttribute(Attribute att)

addAttributes

public T addAttributes(Iterable<Attribute> atts)

getAttributeContainer

public AttributeContainerMutable getAttributeContainer()

addDimension

public T addDimension(Dimension dim)

addDimensions

public T addDimensions(Collection<Dimension> dims)

setDimensions

public T setDimensions(List<Dimension> dims)

replaceDimension

public boolean replaceDimension(Dimension dim)

setDimensionsByName

public T setDimensionsByName(String dimString)

getFirstDimensionName

@Nullable
public String getFirstDimensionName()

getDimensionName

@Nullable
public String getDimensionName(int index)

getDimensionNames

public Iterable<String> getDimensionNames()

makeDimensionsString

public String makeDimensionsString()

copyDimensions

@Deprecated
public List<Dimension> copyDimensions()

Deprecated.

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:

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

getDimensions

public com.google.common.collect.ImmutableList<Dimension> getDimensions(@Nullable
                                                                        Group.Builder gb)

getDimensionsAll

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

setIsScalar

public T setIsScalar()

getRank

public int getRank()

setDataType

public T setDataType(DataType dataType)

getEnumTypeName

public String getEnumTypeName()

setElementSize

public T setElementSize(int elementSize)

setEnumTypeName

public T setEnumTypeName(String enumTypeName)

setNcfile

public T setNcfile(NetcdfFile ncfile)

setSPobject

public T setSPobject(Object spiObject)

setName

public T setName(String shortName)

setGroup

public T setGroup(Group parent)

setParentStructure

public T setParentStructure(Structure parent)

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)

copyFrom

public T copyFrom(Variable orgVar)

TODO Copy metadata from orgVar.

copyFrom

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

build

public Variable build()

Normally this is called by Group.build()