public class StructureDS extends Structure implements VariableEnhanced
NetcdfDataset
Modifier and Type | Class and Description |
---|---|
static class |
StructureDS.Builder<T extends StructureDS.Builder<T>> |
defaultCoordsSizeToCache, defaultSizeToCache, permitCaching
Constructor and Description |
---|
StructureDS(Group g,
Structure orgVar)
Deprecated.
Use StructureDS.builder()
|
StructureDS(NetcdfDataset ds,
Group group,
Structure parentStructure,
String shortName,
String dims,
String units,
String desc)
Deprecated.
Use StructureDS.builder()
|
StructureDS(NetcdfDataset ds,
Group group,
Structure parent,
String shortName,
Structure orgVar)
Deprecated.
Use StructureDS.builder()
|
Modifier and Type | Method and Description |
---|---|
void |
addCoordinateSystem(CoordinateSystem p0)
Deprecated.
Use StructureDS.builder()
|
static StructureDS.Builder<?> |
builder() |
void |
clearCoordinateSystems()
Deprecated.
Use StructureDS.builder()
|
void |
enhance(Set<NetcdfDataset.Enhance> mode)
Deprecated.
do not use
|
List<CoordinateSystem> |
getCoordinateSystems()
Get the list of Coordinate Systems for this Variable.
|
String |
getDescription()
Get the description of the Variable.
|
DataType |
getOriginalDataType()
When this wraps another Variable, get the original Variable's DataType.
|
String |
getOriginalName()
When this wraps another Variable, get the original Variable's DataType.
|
Variable |
getOriginalVariable()
A StructureDS may wrap another Structure.
|
String |
getUnitsString()
Get the Unit String for the Variable.
|
Array |
reallyRead(Variable client,
CancelTask cancelTask)
public by accident, do not call directly.
|
Array |
reallyRead(Variable client,
Section section,
CancelTask cancelTask)
public by accident, do not call directly.
|
void |
removeCoordinateSystem(CoordinateSystem p0)
Deprecated.
Use StructureDS.builder()
|
Structure |
select(List<String> memberNames)
Create a subset of the Structure consisting only of the given member variables
|
String |
setName(String newName)
Set the short name, converting to valid CDM object name if needed.
|
void |
setOriginalVariable(Variable orgVar)
Deprecated.
Use StructureDS.builder()
|
void |
setUnitsString(String units)
Deprecated.
Use StructureDS.builder()
|
StructureDS.Builder<?> |
toBuilder()
Turn into a mutable Builder.
|
addMemberVariable, calcElementSize, findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, readStructure, readStructure, readStructure, removeMemberVariable, replaceMemberVariable, select, setCaching, setImmutable, setMemberVariables, setParentGroup
addAll, addAttribute, attributes, compareTo, createNewCache, equals, findAttribute, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, findAttValueIgnoreCase, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getEnumTypedef, getFileTypeId, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getProxyReader, getRanges, getRank, getShape, getShape, getShapeAll, getShapeAsSection, getSize, getSizeToCache, getSPobject, 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, 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
annotate, annotation, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getName, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setParentStructure, setShortName, setSort, unwrap
getFullName, getShortName
getFullName, getName, getShortName
getName, hasAttribute, iterator
forEach, spliterator
@Deprecated public StructureDS(NetcdfDataset ds, Group group, Structure parentStructure, String shortName, String dims, String units, String desc)
ds
- the containing NetcdfDataset.group
- the containing group; if null, use rootGroupparentStructure
- parent Structure, may be nullshortName
- variable shortName, must be unique within the Groupdims
- list of dimension names, space delimitedunits
- unit string (may be null)desc
- description (may be null)@Deprecated public StructureDS(Group g, Structure orgVar)
g
- parent grouporgVar
- original Structure@Deprecated public StructureDS(NetcdfDataset ds, Group group, Structure parent, String shortName, Structure orgVar)
ds
- the containing NetcdfDataset.group
- the containing group; may not be nullparent
- parent Structure, may be nullshortName
- variable shortName, must be unique within the GrouporgVar
- the original Structure to wrap.public Structure select(List<String> memberNames)
Structure
public Variable getOriginalVariable()
getOriginalVariable
in interface VariableEnhanced
@Deprecated public void setOriginalVariable(Variable orgVar)
setOriginalVariable
in interface VariableEnhanced
orgVar
- original Variable, must be a Structurepublic DataType getOriginalDataType()
public String getOriginalName()
getOriginalName
in interface VariableEnhanced
public String setName(String newName)
Variable
public Array reallyRead(Variable client, CancelTask cancelTask) throws IOException
Variable
reallyRead
in interface ProxyReader
reallyRead
in class Variable
client
- the client VariablecancelTask
- user may cancelIOException
- on errorpublic Array reallyRead(Variable client, Section section, CancelTask cancelTask) throws IOException, InvalidRangeException
Variable
reallyRead
in interface ProxyReader
reallyRead
in class Variable
client
- the client Variablesection
- the section of data to read.cancelTask
- user may cancelIOException
- on errorInvalidRangeException
- if section has incorrect rank or illegal shape.@Deprecated public void enhance(Set<NetcdfDataset.Enhance> mode)
enhance
in interface VariableEnhanced
@Deprecated public void clearCoordinateSystems()
VariableEnhanced
clearCoordinateSystems
in interface VariableEnhanced
@Deprecated public void addCoordinateSystem(CoordinateSystem p0)
Enhancements
addCoordinateSystem
in interface Enhancements
p0
- add this Coordinate System@Deprecated public void removeCoordinateSystem(CoordinateSystem p0)
Enhancements
removeCoordinateSystem
in interface Enhancements
p0
- remove this coordinate systempublic List<CoordinateSystem> getCoordinateSystems()
Enhancements
getCoordinateSystems
in interface Enhancements
public String getDescription()
Variable
getDescription
in interface Enhancements
getDescription
in interface VariableSimpleIF
getDescription
in class Variable
public String getUnitsString()
Variable
getUnitsString
in interface Enhancements
getUnitsString
in interface VariableSimpleIF
getUnitsString
in class Variable
@Deprecated public void setUnitsString(String units)
VariableEnhanced
setUnitsString
in interface VariableEnhanced
units
- unit stringpublic StructureDS.Builder<?> toBuilder()
Structure
public static StructureDS.Builder<?> builder()