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
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(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()
String	getDimensionName(int index)
Iterable<String>	getDimensionNames()
com.google.common.collect.ImmutableList<Dimension>	getDimensions()
com.google.common.collect.ImmutableSet<String>	getDimensionsAll()
int	getElementSize()
String	getEnumTypeName()
String	getFirstDimensionName()
String	getFullName()
Group.Builder	getParentGroupBuilder()
Structure.Builder<?>	getParentStructureBuilder()
int	getRank()
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()
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) Set dimensions by name.
T	setElementSize(int elementSize)
T	setEnumTypeName(String enumTypeName)
T	setIsScalar()
T	setName(String shortName)
T	setNcfile(NetcdfFile ncfile)
T	setParentGroupBuilder(Group.Builder parent)
T	setProxyReader(ProxyReader proxy)
T	setSPobject(Object spiObject)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cache

public ucar.nc2.Variable.Cache cache

dataType

public DataType dataType

ncfile

public NetcdfFile ncfile

proxyReader

public ProxyReader proxyReader

shortName

public String shortName

spiObject

public Object spiObject

Constructor Detail

Builder

public Builder()

Method Detail

addAttribute

public T addAttribute(Attribute att)

addAttributes

public T addAttributes(Iterable<Attribute> atts)

addDimension

public T addDimension(Dimension dim)

addDimensions

public T addDimensions(Collection<Dimension> dims)

build

public Variable build(Group parentGroup)

Normally this is called by Group.build()

copy

public Variable.Builder<?> copy()

copyFrom

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

copyFrom

public T copyFrom(Variable orgVar)

TODO Copy metadata from orgVar.

getAttributeContainer

public AttributeContainerMutable getAttributeContainer()

getDimensionName

@Nullable
public String getDimensionName(int index)

getDimensionNames

public Iterable<String> getDimensionNames()

getDimensions

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

getDimensionsAll

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

getElementSize

public int getElementSize()

getEnumTypeName

public String getEnumTypeName()

getFirstDimensionName

@Nullable
public String getFirstDimensionName()

getFullName

public String getFullName()

getParentGroupBuilder

public Group.Builder getParentGroupBuilder()

getParentStructureBuilder

public Structure.Builder<?> getParentStructureBuilder()

getRank

public int getRank()

makeDimensionsString

public String makeDimensionsString()

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

replaceDimensionByName

public boolean replaceDimensionByName(Dimension dim)

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

resetCache

public T resetCache()

setAutoGen

public T setAutoGen(double start,
                    double incr)

setCachedData

public T setCachedData(Array cacheData,
                       boolean isMetadata)

setCaching

public T setCaching(boolean caching)

setDataType

public T setDataType(DataType dataType)

setDimensions

public T setDimensions(List<Dimension> dims)

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.

setDimensionsByName

public T setDimensionsByName(String dimString)

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

setElementSize

public T setElementSize(int elementSize)

setEnumTypeName

public T setEnumTypeName(String enumTypeName)

setIsScalar

public T setIsScalar()

setName

public T setName(String shortName)

setNcfile

public T setNcfile(NetcdfFile ncfile)

setParentGroupBuilder

public T setParentGroupBuilder(Group.Builder parent)

setProxyReader

public T setProxyReader(ProxyReader proxy)

setSPobject

public T setSPobject(Object spiObject)

toString

public String toString()

Overrides:

toString in class Object