ucar.nc2

Class Structure

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.Structure

All Implemented Interfaces:

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

Direct Known Subclasses:

Sequence, StructureDS

public class Structure
extends Variable

A Structure is a type of Variable that contains other Variables, like a struct in C. A Structure can be scalar or multidimensional.

A call to structure.read() will read all of the data in a Structure, including nested structures, and returns an Array of StructureData, with all of the data in memory. If there is a nested sequence, the sequence data may be read into memory all at once, or it may be read in increments as the iteration proceeds.

Generally, the programmer can assume that the data in one Structure are stored together, so that it is efficient to read an entire Structure, and then access the Variable data through the Arrays in the StructureData.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Structure.Builder<T extends Structure.Builder<T>> A builder of Structures.

Field Summary

Fields inherited from class ucar.nc2.Variable

defaultCoordsSizeToCache, defaultSizeToCache, permitCaching

Constructor Summary

Constructors

Constructor and Description
Structure(NetcdfFile ncfile, Group group, Structure parent, String shortName) Deprecated. Use Structure.builder()
Structure(NetcdfFile ncfile, Group group, Structure parent, String shortName, List<Dimension> dimList) Deprecated. Use Structure.builder()

Method Summary

Modifier and Type	Method and Description
Variable	addMemberVariable(Variable v) Deprecated. Use Structure.builder()
static Structure.Builder<?>	builder() Get Builder for this class that allows subclassing.
void	calcElementSize() Force recalculation of size of one element of this structure - equals the sum of sizes of its members.
Variable	findVariable(String shortName) Find the Variable member with the specified (short) name.
int	getElementSize() Get the size of one element of the Structure.
String	getNameAndAttributes() Get String with name and attributes.
int	getNumberOfMemberVariables() Get the number of variables contained directly in this Structure.
StructureDataIterator	getStructureIterator() Iterator over all the data in a Structure.
StructureDataIterator	getStructureIterator(int bufferSize) Get an efficient iterator over all the data in the Structure.
List<String>	getVariableNames() Get the (short) names of the variables contained directly in this Structure.
List<Variable>	getVariables() Get the variables contained directly in this Structure.
boolean	isCaching() Caching is not allowed
boolean	isSubset() Find if this was created from a subset() method.
StructureMembers	makeStructureMembers() Create a StructureMembers object that describes this Structure.
StructureData	readStructure() Use this when this is a scalar Structure.
StructureData	readStructure(int index) Use this when this is a one dimensional array of Structures, or you are doing the index calculation yourself for a multidimension array.
ArrayStructure	readStructure(int start, int count) For rank 1 array of Structures, read count Structures and return the data as an ArrayStructure.
boolean	removeMemberVariable(Variable v) Deprecated. Use Structure.builder()
boolean	replaceMemberVariable(Variable newVar) Deprecated. Use Structure.builder()
Structure	select(List<String> memberNames) Create a subset of the Structure consisting only of the given member variables
Structure	select(String varName) Create a subset of the Structure consisting only of the one member variable
void	setCaching(boolean caching) Caching is not allowed
Variable	setImmutable() Deprecated. Use Structure.builder()
void	setMemberVariables(List<Variable> vars) Deprecated. Use Structure.builder()
void	setParentGroup(Group group) Deprecated. Use Structure.builder()
Structure.Builder<?>	toBuilder() Turn into a mutable Builder.

Methods inherited from class ucar.nc2.Variable

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

Methods inherited from class ucar.nc2.CDMNode

annotate, annotation, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentStructure, getShortName, getSort, isMemberOfStructure, 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.VariableSimpleIF

getFullName, getName, getShortName

Methods inherited from interface ucar.nc2.AttributeContainer

getName, hasAttribute, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Structure

@Deprecated
public Structure(NetcdfFile ncfile,
                             Group group,
                             Structure parent,
                             String shortName)

Deprecated. Use Structure.builder()

Create a Structure "from scratch". Also must call setDimensions().

Parameters:

ncfile - the containing NetcdfFile.

group - the containing group; if null, use rootGroup

parent - parent Structure, may be null

shortName - variable shortName, must be unique within the Group

Structure

@Deprecated
public Structure(NetcdfFile ncfile,
                             Group group,
                             Structure parent,
                             String shortName,
                             List<Dimension> dimList)

Deprecated. Use Structure.builder()

Create a Structure "from scratch".

Parameters:

ncfile - the containing NetcdfFile.

group - the containing group; if null, use rootGroup

parent - parent Structure, may be null

shortName - variable shortName, must be unique within the Group

dimList - list of Dimensions

Method Detail

select

public Structure select(List<String> memberNames)

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

Parameters:

memberNames - list of Variable names, already a member

Returns:

Structure containing just those members

select

public Structure select(String varName)

Create a subset of the Structure consisting only of the one member variable

Parameters:

varName - name of member Variable

Returns:

containing just that member

isSubset

public boolean isSubset()

Find if this was created from a subset() method.

Returns:

true if this is a subset

isCaching

public boolean isCaching()

Caching is not allowed

Overrides:

isCaching in class Variable

Returns:

true is caching

setCaching

public void setCaching(boolean caching)

Caching is not allowed

Overrides:

setCaching in class Variable

Parameters:

caching - set if caching.

addMemberVariable

@Deprecated
public Variable addMemberVariable(Variable v)

Deprecated. Use Structure.builder()

Add a member variable

Parameters:

v - add this variable as a member of this structure

Returns:

the added variable

setMemberVariables

@Deprecated
public void setMemberVariables(List<Variable> vars)

Deprecated. Use Structure.builder()

Set the list of member variables.

Parameters:

vars - this is the list of member variables

removeMemberVariable

@Deprecated
public boolean removeMemberVariable(Variable v)

Deprecated. Use Structure.builder()

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

Parameters:

v - remove this variable as a member of this structure

Returns:

true if was found and removed

replaceMemberVariable

@Deprecated
public boolean replaceMemberVariable(Variable newVar)

Deprecated. Use Structure.builder()

Replace a Variable with another that has the same name : uses the variable name to find it. If old Var is not found, just add the new one

Parameters:

newVar - add this variable as a member of this structure

Returns:

true if was found and replaced

setParentGroup

@Deprecated
public void setParentGroup(Group group)

Deprecated. Use Structure.builder()

Set the parent group of this Structure, and all member variables.

Overrides:

setParentGroup in class Variable

Parameters:

group - set to this value

setImmutable

@Deprecated
public Variable setImmutable()

Deprecated. Use Structure.builder()

Description copied from class: Variable

Make this immutable.

Overrides:

setImmutable in class Variable

Returns:

this

getVariables

public List<Variable> getVariables()

Get the variables contained directly in this Structure.

Returns:

List of type Variable.

getNumberOfMemberVariables

public int getNumberOfMemberVariables()

Get the number of variables contained directly in this Structure.

Returns:

number of member variables

getVariableNames

public List<String> getVariableNames()

Get the (short) names of the variables contained directly in this Structure.

Returns:

List of type String.

findVariable

public Variable findVariable(String shortName)

Find the Variable member with the specified (short) name.

Parameters:

shortName - name of the member variable.

Returns:

the Variable member with the specified (short) name, or null if not found.

makeStructureMembers

public StructureMembers makeStructureMembers()

Create a StructureMembers object that describes this Structure. CAUTION: Do not use for iterating over a StructureData or ArrayStructure - get the StructureMembers object directly from the StructureData or ArrayStructure.

Returns:

a StructureMembers object that describes this Structure.

getElementSize

public int getElementSize()

Get the size of one element of the Structure.

Overrides:

getElementSize in class Variable

Returns:

size (in bytes)

calcElementSize

public void calcElementSize()

Force recalculation of size of one element of this structure - equals the sum of sizes of its members. This is used only by low level classes like IOSPs.

readStructure

public StructureData readStructure()
                            throws IOException

Use this when this is a scalar Structure. Its the same as read(), but it extracts the single StructureData out of the Array.

Returns:

StructureData for a scalar

Throws:

IOException - on read error

readStructure

public StructureData readStructure(int index)
                            throws IOException,
                                   InvalidRangeException

Use this when this is a one dimensional array of Structures, or you are doing the index calculation yourself for a multidimension array. This will read only the ith structure, and return the data as a StructureData object.

Parameters:

index - index into 1D array

Returns:

ith StructureData

Throws:

IOException - on read error

InvalidRangeException - if index out of range

readStructure

public ArrayStructure readStructure(int start,
                                    int count)
                             throws IOException,
                                    InvalidRangeException

For rank 1 array of Structures, read count Structures and return the data as an ArrayStructure. Use only when this is a one dimensional array of Structures.

Parameters:

start - start at this index

count - return this many StructureData

Returns:

the StructureData recordsfrom start to start+count-1

Throws:

IOException - on read error

InvalidRangeException - if start, count out of range

getStructureIterator

public StructureDataIterator getStructureIterator()
                                           throws IOException

Iterator over all the data in a Structure.

 StructureDataIterator ii = structVariable.getStructureIterator();
 while (ii.hasNext()) {
   StructureData sdata = ii.next();
 }
 

Returns:

StructureDataIterator over type StructureData

Throws:

IOException - on read error

See Also:

getStructureIterator(int bufferSize)

getStructureIterator

public StructureDataIterator getStructureIterator(int bufferSize)
                                           throws IOException

Get an efficient iterator over all the data in the Structure. This is the efficient way to get all the data, it can be much faster than reading one record at a time, and is optimized for large datasets. This is accomplished by buffering bufferSize amount of data at once.

 Example:

  StructureDataIterator ii = structVariable.getStructureIterator(100 * 1000);
  while (ii.hasNext()) {
    StructureData sdata = ii.next();
  }
 

Parameters:

bufferSize - size in bytes to buffer, set < 0 to use default size

Returns:

StructureDataIterator over type StructureData

Throws:

IOException - on read error

getNameAndAttributes

public String getNameAndAttributes()

Get String with name and attributes. Used in short descriptions like tooltips.

Returns:

name and attributes String

toBuilder

public Structure.Builder<?> toBuilder()

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

Overrides:

toBuilder in class Variable

builder

public static Structure.Builder<?> builder()

Get Builder for this class that allows subclassing.

See Also:

"https://community.oracle.com/blogs/emcmanus/2010/10/24/using-builder-pattern-subclasses"