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, ucar.nc2.dataset.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

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

getCoordinateSystems, getDescription, getOriginalDataType, getOriginalName, getOriginalVariable, getUnitsString

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.AttributeContainer

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

Methods inherited from interface ucar.nc2.dataset.Enhancements

addCoordinateSystem, removeCoordinateSystem

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

getShortName

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

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()