Package ucar.nc2.dataset

Class StructurePseudoDS

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dataset.StructureDS

ucar.nc2.dataset.StructurePseudoDS

All Implemented Interfaces:

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

Direct Known Subclasses:

StructurePseudo2Dim

public class StructurePseudoDS
extends StructureDS

Make a collection of variables with the same outer dimension into a fake Structure. Its fake because the variables are not stored contiguously.

  so
   var1(dim, other);
   var2(dim, other);
   var3(dim, other);
 becomes
   struct {
     var1(other);
     var2(other);
     var3(other);
   } name(dim);
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class ucar.nc2.Variable

defaultCoordsSizeToCache, defaultSizeToCache, permitCaching

Constructor Summary

Constructors

Constructor	Description
StructurePseudoDS(NetcdfDataset ncfile, Group group, String shortName, List<String> varNames, Dimension outerDim)	Deprecated. Use StructurePseudoDS.builder()

Method Summary

Modifier and Type	Method	Description
static StructurePseudoDS.Builder<?>	builder()
Array	reallyRead(Variable mainv, Section section, CancelTask cancelTask)	public by accident, do not call directly.
Array	reallyRead(Variable mainv, CancelTask cancelTask)	public by accident, do not call directly.
boolean	removeMemberVariable(Variable v)	Deprecated. Use StructurePseudoDS.builder()
Structure	select(List<String> memberNames)	Create a subset of the Structure consisting only of the given member variables
StructurePseudoDS.Builder<?>	toBuilder()	Turn into a mutable Builder.

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

StructurePseudoDS

@Deprecated
public StructurePseudoDS(NetcdfDataset ncfile,
 Group group,
 String shortName,
 List<String> varNames,
 Dimension outerDim)

Deprecated.

Use StructurePseudoDS.builder()

Make a Structure out of all Variables with the named dimension as their outermost dimension, or from a list named Variables, each has the same named outermost dimension.

Parameters:

ncfile - part of this file

group - part of this group

shortName - short name of this Structure

varNames - limited to these variables, all must have dim as outer dimension. If null, use all Variables with that outer dimension

outerDim - existing, outer dimension

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 StructureDS

Parameters:

memberNames - list of Variable names, already a member

Returns:

Structure containing just those members

removeMemberVariable

@Deprecated
public boolean removeMemberVariable(Variable v)

Deprecated.

Use StructurePseudoDS.builder()

Description copied from class: Structure

Remove a Variable : uses the Variable name to find it.

Overrides:

removeMemberVariable in class Structure

Parameters:

v - remove this variable as a member of this structure

Returns:

true if was found and removed

reallyRead

public Array reallyRead(Variable mainv,
 CancelTask cancelTask)
                 throws IOException

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

reallyRead in interface ProxyReader

Overrides:

reallyRead in class StructureDS

Parameters:

mainv - the client Variable

cancelTask - user may cancel

Returns:

Array

Throws:

IOException - on error

reallyRead

public Array reallyRead(Variable mainv,
 Section section,
 CancelTask cancelTask)
                 throws IOException,
InvalidRangeException

Description copied from class: Variable

public by accident, do not call directly.

Specified by:

reallyRead in interface ProxyReader

Overrides:

reallyRead in class StructureDS

Parameters:

mainv - the client Variable

section - the section of data to read.

cancelTask - user may cancel

Returns:

Array

Throws:

IOException - on error

InvalidRangeException - if section has incorrect rank or illegal shape.

toBuilder

public StructurePseudoDS.Builder<?> toBuilder()

Description copied from class: Structure

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

Overrides:

toBuilder in class StructureDS

builder

public static StructurePseudoDS.Builder<?> builder()