ucar.nc2.dataset

Class StructureDS

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dataset.StructureDS

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, java.lang.Iterable<Attribute>, AttributeContainer, ucar.nc2.dataset.Enhancements, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

StructurePseudoDS

public class StructureDS
extends Structure
implements VariableEnhanced

An "enhanced" Structure.

See Also:

NetcdfDataset

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class ucar.nc2.Variable

defaultCoordsSizeToCache, defaultSizeToCache, permitCaching

Method Summary

Modifier and Type	Method and Description
static StructureDS.Builder<?>	builder()
com.google.common.collect.ImmutableList<CoordinateSystem>	getCoordinateSystems() Get the list of Coordinate Systems for this Variable.
java.lang.String	getDescription() Get the description of the Variable.
DataType	getOriginalDataType() When this wraps another Variable, get the original Variable's DataType.
java.lang.String	getOriginalName() When this wraps another Variable, get the original Variable's DataType.
Variable	getOriginalVariable() A StructureDS may wrap another Structure.
java.lang.String	getUnitsString() Get the Unit String for the Variable.
Array	reallyRead(Variable client, CancelTask cancelTask) public by accident, do not call directly.
Array	reallyRead(Variable client, Section section, CancelTask cancelTask) public by accident, do not call directly.
Structure	select(java.util.List<java.lang.String> memberNames) Create a subset of the Structure consisting only of the given member variables
java.lang.String	setName(java.lang.String newName) Deprecated.
StructureDS.Builder<?>	toBuilder() Turn into a mutable Builder.

Methods inherited from class ucar.nc2.Structure

findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, readStructure, readStructure, select, setCaching

Methods inherited from class ucar.nc2.Variable

attributes, compareTo, createNewCache, equals, findAttribute, findAttributeString, findDimensionIndex, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionsString, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getParentStructure, getRanges, getRank, getShape, getShape, getShapeAsSection, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToStream, reduce, section, section, slice, toString, toStringDebug

Methods inherited from class ucar.nc2.CDMNode

getShortName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

getFullName, getShortName

Methods inherited from interface ucar.nc2.dataset.Enhancements

addCoordinateSystem, removeCoordinateSystem

Methods inherited from interface ucar.nc2.VariableSimpleIF

getShortName

Methods inherited from interface ucar.nc2.AttributeContainer

filter, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, getName, hasAttribute, hasAttributeIgnoreCase, isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

builder

public static StructureDS.Builder<?> builder()

getCoordinateSystems

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

Description copied from interface: Enhancements

Get the list of Coordinate Systems for this Variable.

Specified by:

getCoordinateSystems in interface ucar.nc2.dataset.Enhancements

Returns:

list of type CoordinateSystem; may be empty but not null.

getDescription

public java.lang.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 ucar.nc2.dataset.Enhancements

Specified by:

getDescription in interface VariableSimpleIF

Overrides:

getDescription in class Variable

Returns:

description, or null if not found.

getOriginalDataType

public DataType getOriginalDataType()

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

Returns:

original Variable's DataType

getOriginalName

public java.lang.String getOriginalName()

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

Specified by:

getOriginalName in interface VariableEnhanced

Returns:

original Variable's DataType

getOriginalVariable

public Variable getOriginalVariable()

A StructureDS may wrap another Structure.

Specified by:

getOriginalVariable in interface VariableEnhanced

Returns:

original Structure or null

getUnitsString

public java.lang.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 ucar.nc2.dataset.Enhancements

Specified by:

getUnitsString in interface VariableSimpleIF

Overrides:

getUnitsString in class Variable

Returns:

unit string, or null if not found.

reallyRead

public Array reallyRead(Variable client,
                        CancelTask cancelTask)
                 throws java.io.IOException

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:

Array

Throws:

java.io.IOException - on error

reallyRead

public Array reallyRead(Variable client,
                        Section section,
                        CancelTask cancelTask)
                 throws java.io.IOException,
                        InvalidRangeException

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:

Array

Throws:

java.io.IOException - on error

InvalidRangeException - if section has incorrect rank or illegal shape.

select

public Structure select(java.util.List<java.lang.String> memberNames)

Description copied from class: Structure

Create a subset of the Structure consisting only of the given member variables

Overrides:

select in class Structure

Parameters:

memberNames - list of Variable names, already a member

Returns:

Structure containing just those members

setName

@Deprecated
public java.lang.String setName(java.lang.String newName)

Deprecated.

Description copied from class: Variable

Set the short name, converting to valid CDM object name if needed.

Overrides:

setName in class Variable

Parameters:

newName - set to this value

Returns:

valid CDM object name

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