Package ucar.nc2.dataset

Class StructureDS

java.lang.Object

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dataset.StructureDS

All Implemented Interfaces:

Comparable<Variable>, StructureEnhanced, VariableEnhanced, ProxyReader

@Immutable
public class StructureDS
extends Structure
implements StructureEnhanced

An "enhanced" Structure.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class ucar.nc2.Variable

permitCaching

Method Summary

Modifier and Type	Method	Description
static StructureDS.Builder<?>	builder()	Get a Builder of StructureDS.
List<CoordinateSystem>	getCoordinateSystems()	Get the list of Coordinate Systems for this Variable, larger number of axes first.
String	getDescription()	Get the description of the Variable.
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, Section section, CancelTask cancelTask)	public by accident, do not call directly.
Array<?>	proxyReadArray(Variable client, CancelTask cancelTask)	public by accident, do not call directly.
StructureDS.Builder<?>	toBuilder()	Turn into a mutable Builder.

Methods inherited from class ucar.nc2.Structure

findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getVariableNames, getVariables, isSubset, makeStructureMembersBuilder, readRecord, select, select

Methods inherited from class ucar.nc2.Variable

attributes, compareTo, equals, findAttribute, findAttributeString, findDimensionIndex, getArrayType, getDatasetLocation, getDimension, getDimensions, getDimensionSet, getDimensionsString, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getParentStructure, getRank, getSection, getShape, getShape, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, isCaching, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, lookupEnumString, readArray, readArray, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, reduce, section, setCaching, slice, toString

Methods inherited from class java.lang.Object

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

Method Detail

getOriginalVariable

@Nullable
public Variable getOriginalVariable()

A StructureDS may wrap another Structure.

Specified by:

getOriginalVariable in interface VariableEnhanced

getOriginalName

public String getOriginalName()

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

Specified by:

getOriginalName in interface VariableEnhanced

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

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 List<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

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

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

builder

public static StructureDS.Builder<?> builder()

Get a Builder of StructureDS.