ucar.nc2.dods
Class DODSStructure

java.lang.Object
  ucar.nc2.Variable
      ucar.nc2.Structure
          ucar.nc2.dods.DODSStructure

All Implemented Interfaces:

VariableIF

public class DODSStructure
extends Structure

A DODS Structure.

Version:

$Revision:51 $ $Date:2006-07-12 17:13:13Z $

Author:

caron

Nested Class Summary

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

Structure.Iterator

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

Variable.Cache

Field Summary

protected DODSNetcdfFile	dodsfile
protected java.lang.String	dodsShortName

Fields inherited from class ucar.nc2.Structure

memberHash, memberNames, members

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, debugCaching, defaultSizeToCache, dimensions, elementSize, group, isCoordinateAxis, isMetadata, isSection, isSlice, isVlen, ncfile, orgVar, parent, scalarIndex, sectionRanges, shape, shortName, sizeToCache, sliceDim, sliceRanges

Method Summary

protected void	calcIsCoordinateVariable()
protected java.lang.String	getDODSshortName()
Structure.Iterator	getStructureIterator(java.lang.String CE) Return an iterator over the set of repeated structures.
java.lang.String	writeCDL(java.lang.String space, boolean useFullName, boolean strict) Let the Structure fill in here.

Methods inherited from class ucar.nc2.Structure

addMemberVariable, calcElementSize, calcStructureSize, findVariable, getElementSize, getNameAndAttributes, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, makeStructureMembers, readStructure, readStructure, readStructure, removeMemberVariable, replaceMemberVariable, section, setCaching, setMemberVariables, setParentGroup, toString

Methods inherited from class ucar.nc2.Variable

_read, _read, _readMemberData, addAttribute, attributes, equals, extraInfo, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getCoordinateDimension, getDataType, getDescription, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getIOVar, getName, getNameAndDimensions, getNameAndDimensions, getParentGroup, getParentStructure, getRanges, getRank, getSectionRanges, getShape, getShortName, getSize, getSizeToCache, getSPobject, getUnitsString, hasCachedData, hashCode, invalidateCache, isMemberOfStructure, isMetadata, isScalar, isSection, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, makeSection, makeSectionAddParents, makeSectionRanges, makeSectionWithParents, makeSlice, makeSliceRanges, read, read, read, read, readAllStructures, readAllStructuresSpec, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, remove, replaceDimension, setCachedData, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setIOVar, setIsCoordinateAxis, setName, setParentStructure, setSizeToCache, setSPobject, slice, toStringDebug

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

dodsfile

protected DODSNetcdfFile dodsfile

dodsShortName

protected java.lang.String dodsShortName

Method Detail

calcIsCoordinateVariable

protected void calcIsCoordinateVariable()

Overrides:

calcIsCoordinateVariable in class Variable

writeCDL

public java.lang.String writeCDL(java.lang.String space,
                                 boolean useFullName,
                                 boolean strict)

Let the Structure fill in here.

Overrides:

writeCDL in class Structure

Parameters:

space - start each line with this much space

useFullName - use full name, else use short name

strict - stictly comply with ncgen syntax

Returns:

CDL representation of the Variable.

getDODSshortName

protected java.lang.String getDODSshortName()

getStructureIterator

public Structure.Iterator getStructureIterator(java.lang.String CE)
                                        throws java.io.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:

java.io.IOException

See Also:

DODSStructure