Package ucar.nc2.dataset

Class StructurePseudo2Dim

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dataset.StructureDS

ucar.nc2.dataset.StructurePseudoDS

ucar.nc2.dataset.StructurePseudo2Dim

All Implemented Interfaces:

Comparable<VariableSimpleIF>, Iterable<Attribute>, AttributeContainer, Enhancements, VariableEnhanced, ProxyReader, VariableSimpleIF

public class StructurePseudo2Dim
extends StructurePseudoDS

Make a collection of variables with the same 2 outer dimensions into a fake 2D Structure(outer,inner)

Since:

Oct 21, 2009

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class ucar.nc2.Variable

defaultCoordsSizeToCache, defaultSizeToCache, permitCaching

Constructor Summary

Constructors

Constructor	Description
StructurePseudo2Dim(NetcdfDataset ncfile, Group group, String shortName, List<String> varNames, Dimension outer, Dimension inner)	Deprecated. Use StructureDS.builder()

Method Summary

Modifier and Type	Method	Description
static StructurePseudo2Dim.Builder<?>	builder()
Structure	select(List<String> memberNames)	Create a subset of the Structure consisting only of the given member variables
StructurePseudo2Dim.Builder<?>	toBuilder()	Turn into a mutable Builder.

Methods inherited from class ucar.nc2.dataset.StructurePseudoDS

reallyRead, reallyRead, removeMemberVariable

Methods inherited from class ucar.nc2.dataset.StructureDS

addCoordinateSystem, clearCoordinateSystems, enhance, getCoordinateSystems, getDescription, getOriginalDataType, getOriginalName, getOriginalVariable, getUnitsString, removeCoordinateSystem, setName, setOriginalVariable, setUnitsString

Methods inherited from class ucar.nc2.Structure

addMemberVariable, calcElementSize, findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, readStructure, readStructure, readStructure, replaceMemberVariable, select, setCaching, setImmutable, setMemberVariables, setParentGroup

Methods inherited from class ucar.nc2.Variable

addAll, addAttribute, attributes, compareTo, createNewCache, equals, findAttribute, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, findAttributeString, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getParentGroupOrRoot, getParentStructure, getProxyReader, getRanges, getRank, getShape, getShape, getShapeAll, getShapeAsSection, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, invalidateCache, isCoordinateVariable, isEmpty, isImmutable, isMemberOfStructure, isMetadata, isScalar, isUnknownLength, isUnlimited, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, readToStream, reduce, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setIsScalar, setProxyReader, setSizeToCache, setSPobject, setValues, setValues, slice, toString, toStringDebug, writeCDL

Methods inherited from class ucar.nc2.CDMNode

annotate, annotation, getDODSName, getFullNameEscaped, getGroup, getImmutable, getName, getShortName, getSort, localhash, setDODSName, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.AttributeContainer

findAttValueIgnoreCase, getName, hasAttribute, hasAttributeIgnoreCase, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

getFullName, getShortName

Methods inherited from interface ucar.nc2.VariableSimpleIF

getName, getShortName

Constructor Details

StructurePseudo2Dim

@Deprecated
public StructurePseudo2Dim(NetcdfDataset ncfile,
 Group group,
 String shortName,
 List<String> varNames,
 Dimension outer,
 Dimension inner)

Deprecated.

Use StructureDS.builder()

Make a Structure out of named Variables which have var(outer, inner, ...)

Parameters:

ncfile - the containing file

group - the containing group, if null use root group

shortName - short name of this Structure

varNames - limited to these variables. all must var(outer, inner, ...). If null, then find all such variables.

outer - the outer dimension, may not be null

inner - the inner dimension, may not be null

Method Details

select

public Structure select(List<String> memberNames)

Description copied from class: Structure

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

Overrides:

select in class StructurePseudoDS

Parameters:

memberNames - list of Variable names, already a member

Returns:

Structure containing just those members

toBuilder

public StructurePseudo2Dim.Builder<?> toBuilder()

Description copied from class: Structure

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

Overrides:

toBuilder in class StructurePseudoDS

builder

public static StructurePseudo2Dim.Builder<?> builder()