Package ucar.nc2.dods

Class DODSStructure

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

ucar.nc2.Structure

ucar.nc2.dods.DODSStructure

All Implemented Interfaces:

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

public class DODSStructure
extends Structure
implements DODSNode

A DODS Structure.

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.Structure

Structure.Builder<T extends Structure.Builder<T>>

Nested classes/interfaces inherited from class ucar.nc2.Variable

Variable.Cache

Field Summary

Fields

Modifier and Type	Field	Description
protected DODSNetcdfFile	dodsfile
protected String	dodsShortName

Fields inherited from class ucar.nc2.Structure

isSubset, members

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, debugCaching, defaultCoordsSizeToCache, defaultSizeToCache, dimensions, elementSize, hashCode, isVariableLength, ncfile, permitCaching, proxyReader, shape, sizeToCache, spiObject

Fields inherited from class ucar.nc2.CDMNode

annotations, dodsname, group, immutable, parentstruct, shortName, sort

Method Summary

Modifier and Type	Method	Description
protected DODSStructure	copy()	Deprecated. Use Structure.toBuilder()
String	getDODSName()	Get the dodsname
protected String	getDODSshortName()
StructureDataIterator	getStructureIterator(String CE)	Return an iterator over the set of repeated structures.
void	setDODSName(String name)	Store the original dods name

Methods inherited from class ucar.nc2.Structure

addLocalFieldsToBuilder, addMemberVariable, builder, calcElementSize, calcStructureSize, findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, readStructure, readStructure, readStructure, removeMemberVariable, replaceMemberVariable, select, select, setCaching, setImmutable, setMemberVariables, setParentGroup, toBuilder, writeCDL

Methods inherited from class ucar.nc2.Variable

_read, _read, _readScalarData, addAll, addAttribute, addLocalFieldsToBuilder, attributes, compareTo, createNewCache, equals, extraInfo, findAttribute, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, findAttributeString, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDatasetLocation, getDataType, getDescription, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getParentGroupOrRoot, getParentStructure, getProxyReader, getRanges, getRank, getScalarData, getShape, getShape, getShapeAll, getShapeAsSection, getSize, getSizeToCache, getSPobject, getUnitsString, 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, 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, getFullNameEscaped, getGroup, getImmutable, getName, getShortName, getSort, localhash, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

clone, finalize, 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.VariableSimpleIF

getName, getShortName

Field Detail

dodsfile

protected DODSNetcdfFile dodsfile

dodsShortName

protected String dodsShortName

Method Detail

copy

@Deprecated
protected DODSStructure copy()

Deprecated.

Use Structure.toBuilder()

Overrides:

copy in class Structure

getDODSshortName

protected String getDODSshortName()

getStructureIterator

public StructureDataIterator getStructureIterator(String CE)
                                           throws IOException

Return an iterator over the set of repeated structures. The iterator will return an object of type Structure. When you call this method, the Sequence will be read using the given constraint expression, and the data returned sequentially.
If the data has been cached by a read() to an enclosing container, you must leave the CE null. Otherwise a new call will be made to the server.

Parameters:

CE - constraint expression, or null.

Returns:

iterator over type DODSStructure.

Throws:

IOException - on io error

See Also:

DODSStructure

getDODSName

public String getDODSName()

Description copied from class: CDMNode

Get the dodsname

Specified by:

getDODSName in interface DODSNode

Overrides:

getDODSName in class CDMNode

Returns:

the original names from the DDS or DAS; if null, then return the short name

setDODSName

public void setDODSName(String name)

Description copied from class: CDMNode

Store the original dods name

Specified by:

setDODSName in interface DODSNode

Overrides:

setDODSName in class CDMNode

Parameters:

name - The original name from the DDS/DAS