ucar.nc2.dataset

Class StructureDS

java.lang.Object

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dataset.StructureDS

All Implemented Interfaces:

Comparable<VariableSimpleIF>, StructureEnhanced, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

StructurePseudoDS

@Immutable
public class StructureDS
extends Structure
implements StructureEnhanced

An "enhanced" Structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureDS.Builder<T extends StructureDS.Builder<T>>

Nested classes/interfaces inherited from class ucar.nc2.Variable

Variable.Cache

Field Summary

Fields

Modifier and Type	Field and Description
protected String	orgName
protected Structure	orgVar
protected ucar.nc2.dataset.EnhancementsImpl	proxy

Fields inherited from class ucar.nc2.Structure

isSubset, members

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, dimensions, elementSize, hashCode, isVariableLength, ncfile, permitCaching, proxyReader, shape, spiObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructureDS(StructureDS.Builder<?> builder, Group parentGroup)

Method Summary

Modifier and Type	Method and Description
protected StructureDS.Builder<?>	addLocalFieldsToBuilder(StructureDS.Builder<? extends StructureDS.Builder<?>> b)
static StructureDS.Builder<?>	builder() Get a Builder of StructureDS.
com.google.common.collect.ImmutableList<CoordinateSystem>	getCoordinateSystems() Get the list of Coordinate Systems for this Variable, larger number of axes first.
String	getDescription() Get the description of the Variable.
ArrayType	getOriginalArrayType() When this wraps another Variable, get the original Variable's ArrayType.
DataType	getOriginalDataType() Deprecated. use getOriginalArrayType()
String	getOriginalName() When this wraps another Variable, get the original Variable's name.
Variable	getOriginalVariable() A StructureDS may wrap another Structure.
String	getUnitsString() Get the Unit String for the Variable.
Array<?>	proxyReadArray(Variable client, CancelTask cancelTask) public by accident, do not call directly.
Array<?>	proxyReadArray(Variable client, Section section, CancelTask cancelTask) public by accident, do not call directly.
Array	reallyRead(Variable client, CancelTask cancelTask) Deprecated.
Array	reallyRead(Variable client, Section section, CancelTask cancelTask) Deprecated.
StructureDS.Builder<?>	toBuilder() Turn into a mutable Builder.

Methods inherited from class ucar.nc2.Structure

addLocalFieldsToBuilder, findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isSubset, makeStructureMembers, makeStructureMembersBuilder, readStructure, readStructure, select, select, writeCDL

Methods inherited from class ucar.nc2.Variable

_read, _read, _readScalarData, addLocalFieldsToBuilder, attributes, compareTo, equals, extraInfo, findAttribute, findAttributeString, findDimensionIndex, getArrayType, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionSet, getDimensionsString, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getParentStructure, getRanges, getRank, getSection, getShape, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, invalidateCache, isCaching, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, lookupEnumString, read, read, read, read, read, readArray, readArray, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToStream, reduce, resetShape, section, section, setCachedData, setCaching, slice, toString, toStringDebug

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.dataset.StructureEnhanced

findVariable, getVariables

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

getFullName, getParentGroup, getShortName

Field Detail

proxy

protected final ucar.nc2.dataset.EnhancementsImpl proxy

orgVar

protected final Structure orgVar

orgName

protected final String orgName

Constructor Detail

StructureDS

protected StructureDS(StructureDS.Builder<?> builder,
                      Group parentGroup)

Method Detail

getOriginalVariable

@Nullable
public Variable getOriginalVariable()

A StructureDS may wrap another Structure.

Specified by:

getOriginalVariable in interface VariableEnhanced

getOriginalDataType

@Deprecated
public DataType getOriginalDataType()

Deprecated. use getOriginalArrayType()

getOriginalArrayType

public ArrayType getOriginalArrayType()

When this wraps another Variable, get the original Variable's ArrayType.

getOriginalName

public String getOriginalName()

When this wraps another Variable, get the original Variable's name.

Specified by:

getOriginalName in interface VariableEnhanced

reallyRead

@Deprecated
public Array reallyRead(Variable client,
                                     CancelTask cancelTask)
                              throws IOException

Deprecated.

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

reallyRead in interface ProxyReader

Overrides:

reallyRead in class Variable

Parameters:

client - the client Variable

cancelTask - user may cancel

Returns:

memory resident Array containing the data. Will have same shape as the Variable.

Throws:

IOException

proxyReadArray

public Array<?> proxyReadArray(Variable client,
                               CancelTask cancelTask)
                        throws IOException

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

proxyReadArray in interface ProxyReader

Overrides:

proxyReadArray in class Variable

Throws:

IOException

reallyRead

@Deprecated
public Array reallyRead(Variable client,
                                     Section section,
                                     CancelTask cancelTask)
                              throws IOException,
                                     InvalidRangeException

Deprecated.

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

reallyRead in interface ProxyReader

Overrides:

reallyRead in class Variable

Parameters:

client - the client Variable

section - the section of data to read.

cancelTask - user may cancel

Returns:

memory resident Array containing the data. Will have same shape as the Section.

Throws:

InvalidRangeException - if section has incorrect rank or illegal shape.

IOException

proxyReadArray

public Array<?> proxyReadArray(Variable client,
                               Section section,
                               CancelTask cancelTask)
                        throws IOException,
                               InvalidRangeException

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

proxyReadArray in interface ProxyReader

Overrides:

proxyReadArray in class Variable

Throws:

IOException

InvalidRangeException

getCoordinateSystems

public com.google.common.collect.ImmutableList<CoordinateSystem> getCoordinateSystems()

Description copied from interface: VariableEnhanced

Get the list of Coordinate Systems for this Variable, larger number of axes first.

Specified by:

getCoordinateSystems in interface VariableEnhanced

getDescription

public String getDescription()

Description copied from class: Variable

Get the description of the Variable. Default is to use CDM.LONG_NAME attribute value. If not exist, look for "description", "title", or "standard_name" attribute value (in that order).

Specified by:

getDescription in interface VariableEnhanced

Specified by:

getDescription in interface VariableSimpleIF

Overrides:

getDescription in class Variable

Returns:

description, or null if not found.

getUnitsString

public String getUnitsString()

Description copied from class: Variable

Get the Unit String for the Variable. Looks for the CDM.UNITS attribute value

Specified by:

getUnitsString in interface VariableEnhanced

Specified by:

getUnitsString in interface VariableSimpleIF

Overrides:

getUnitsString in class Variable

Returns:

unit string, or null if not found.

toBuilder

public StructureDS.Builder<?> toBuilder()

Description copied from class: Structure

Turn into a mutable Builder. Can use toBuilder().build() to copy.

Overrides:

toBuilder in class Structure

addLocalFieldsToBuilder

protected StructureDS.Builder<?> addLocalFieldsToBuilder(StructureDS.Builder<? extends StructureDS.Builder<?>> b)

builder

public static StructureDS.Builder<?> builder()

Get a Builder of StructureDS.