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

Field Summary

Fields

Modifier and Type	Field and Description
Variable.Cache	cache
ArrayType	dataType
protected int	elementSize
NetcdfFile	ncfile
protected Group.Builder	parentBuilder
protected Structure.Builder<?>	parentStructureBuilder
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()
Dimension	getDimension(int idx)
String	getDimensionName(int index)
Iterable<String>	getDimensionNames()
com.google.common.collect.ImmutableSet<String>	getDimensionNamesAll()
com.google.common.collect.ImmutableList<Dimension>	getDimensions()
int	getElementSize()
String	getEnumTypeName()
String	getFirstDimensionName()
String	getFullName()
Group.Builder	getParentGroupBuilder()
Structure.Builder<?>	getParentStructureBuilder()
int	getRank()
int[]	getShape()
long	getSize()
boolean	isUnlimited()
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.
void	replaceDimension(int idx, Dimension dim) Replace the ith dimension.
boolean	replaceDimensionByName(Dimension dim) Find the dimension with the same name as dim, and replace it with dim
T	resetAutoGen()
T	resetCache()
protected abstract T	self()
T	setArrayType(ArrayType dataType)
T	setAutoGen(double start, double incr)
T	setCachedData(Array cacheData, boolean isMetadata) Deprecated. Use setSourceData(ucar.array.Array srcData)
T	setDataType(DataType dataType) Deprecated. use setArrayType()
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	setIsCaching(boolean caching)
T	setIsScalar()
T	setName(String shortName)
T	setNcfile(NetcdfFile ncfile)
T	setParentGroupBuilder(Group.Builder parent)
T	setProxyReader(ProxyReader proxy)
T	setSizeToCacheInBytes(int sizeToCacheBytes)
T	setSourceData(Array srcData) Deprecated. Use setSourceData(ucar.array.Array srcData)
T	setSourceData(Array<?> srcData)
T	setSPobject(Object spiObject)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

shortName

public String shortName

dataType

public ArrayType dataType

elementSize

protected int elementSize

ncfile

public NetcdfFile ncfile

parentBuilder

protected Group.Builder parentBuilder

parentStructureBuilder

protected Structure.Builder<?> parentStructureBuilder

spiObject

public 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(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)

replaceDimensionByName

public boolean replaceDimensionByName(Dimension dim)

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

replaceDimension

public void replaceDimension(int idx,
                             Dimension dim)

Replace the ith dimension.

setDimensionsByName

public T setDimensionsByName(String dimString)

Set dimensions by name. If not empty, the parent group builder must be set.

getFirstDimensionName

@Nullable
public String getFirstDimensionName()

getDimensionName

@Nullable
public String getDimensionName(int index)

getDimensionNames

public Iterable<String> getDimensionNames()

makeDimensionsString

public 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:

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

getDimensions

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

getDimension

public Dimension getDimension(int idx)

getDimensionNamesAll

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

isUnlimited

public boolean isUnlimited()

setIsScalar

public T setIsScalar()

getRank

public int getRank()

getShape

public int[] getShape()

getSize

public long getSize()

setDataType

@Deprecated
public T setDataType(DataType dataType)

Deprecated. use setArrayType()

setArrayType

public T setArrayType(ArrayType dataType)

getEnumTypeName

public String getEnumTypeName()

getElementSize

public int getElementSize()

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)

getFullName

public 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

@Deprecated
public T setCachedData(Array cacheData,
                                    boolean isMetadata)

Deprecated. Use setSourceData(ucar.array.Array srcData)

Parameters:

cacheData -

isMetadata -

setSourceData

@Deprecated
public T setSourceData(Array srcData)

Deprecated. Use setSourceData(ucar.array.Array srcData)

Parameters:

srcData -

setSourceData

public T setSourceData(Array<?> srcData)

setAutoGen

public T setAutoGen(double start,
                    double incr)

resetAutoGen

public T resetAutoGen()

resetCache

public T resetCache()

setIsCaching

public T setIsCaching(boolean caching)

setSizeToCacheInBytes

public T setSizeToCacheInBytes(int sizeToCacheBytes)

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

Overrides:

toString in class Object

build

public Variable build(Group parentGroup)

Normally this is called by Group.build()