VariableDS (NetCDF-Java All API v5.9.1)

java.lang.Object
- ucar.nc2.CDMNode
- - ucar.nc2.Variable
  - - ucar.nc2.dataset.VariableDS

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, java.lang.Iterable<Attribute>, IsMissingEvaluator, AttributeContainer, Enhancements, EnhanceScaleMissingUnsigned, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

CoordinateAxis
```
public class VariableDS
extends Variable
implements VariableEnhanced, EnhanceScaleMissingUnsigned
```
A wrapper around a Variable, creating an "enhanced" Variable. The original Variable is used for the I/O. There are several distinct uses:
1. Handle scale/offset/missing/enum/unsigned conversion; this can change DataType and data values
2. Container for coordinate system information
3. NcML modifications to underlying Variable
See Also:

NetcdfDataset

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VariableDS.Builder<T extends VariableDS.Builder<T>>
- Nested classes/interfaces inherited from class ucar.nc2.Variable
  Variable.Cache

Nested Classes
Modifier and Type	Class and Description
`static class`	`VariableDS.Builder<T extends VariableDS.Builder<T>>`

Field Summary

Fields
Modifier and Type Field and Description

protected DataType orgDataType

protected java.lang.String orgName

protected Variable orgVar
- 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

Fields
Modifier and Type	Field and Description
`protected DataType`	`orgDataType`
`protected java.lang.String`	`orgName`
`protected Variable`	`orgVar`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`VariableDS(Group group, Structure parent, java.lang.String shortName, Variable orgVar)` Deprecated. Use NetcdfDataset.builder()
	`VariableDS(Group g, Variable orgVar, boolean enhance)` Deprecated. Use NetcdfDataset.builder()
	`VariableDS(NetcdfDataset ds, Group group, Structure parentStructure, java.lang.String shortName, DataType dataType, java.lang.String dims, java.lang.String units, java.lang.String desc)` Deprecated. Use NetcdfDataset.builder()
`protected`	`VariableDS(VariableDS.Builder<?> builder, Group parentGroup)`
`protected`	`VariableDS(VariableDS vds, boolean isCopy)` Deprecated. Use NetcdfDataset.builder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Array`	`_read()`
`protected Array`	`_read(Section section)`
`void`	`addCoordinateSystem(CoordinateSystem cs)` Deprecated. Use VariableDS.builder()
`boolean`	`addEnhancement(NetcdfDataset.Enhance enhancement)` Deprecated. Use NetcdfDataset.builder()
`protected VariableDS.Builder<?>`	`addLocalFieldsToBuilder(VariableDS.Builder<? extends VariableDS.Builder<?>> builder)`
`Array`	`applyScaleOffset(Array data)` Apply scale and offset to each element of `in` and return the result as a new Array, but only if `EnhanceScaleMissingUnsigned.hasScaleOffset()`.
`double`	`applyScaleOffset(java.lang.Number value)` Apply scale and offset to the specified value if `EnhanceScaleMissingUnsigned.hasScaleOffset()`.
`static VariableDS.Builder<?>`	`builder()` Get Builder for this class that allows subclassing.
`void`	`clearCoordinateSystems()` Deprecated. Use NetcdfDataset.builder()
`Array`	`convert(Array in, boolean convertUnsigned, boolean applyScaleOffset, boolean convertMissing)` Deprecated. use implementations in filters package
`Array`	`convertMissing(Array in)` Returns a copy of `in`, except that each `missing` value is replaced by `Double.NaN`.
`java.lang.Number`	`convertMissing(java.lang.Number value)` If `value` `is missing`, return `Double.NaN`.
`Array`	`convertUnsigned(Array in)` Performs an `unsigned conversion` of each element of `in` and returns the result as a new Array.
`java.lang.Number`	`convertUnsigned(java.lang.Number value)` Convert `value` to the next largest integral data type by an `unsigned conversion`.
`java.lang.Number`	`convertUnsigned(java.lang.Number value, DataType dataType)`
`protected VariableDS`	`copy()` Deprecated. Use `toBuilder()`
`void`	`enhance(java.util.Set<NetcdfDataset.Enhance> enhancements)` Deprecated. Use NetcdfDataset.builder()
`boolean`	`fillValueIsMissing()`
`com.google.common.collect.ImmutableList<CoordinateSystem>`	`getCoordinateSystems()` Get the list of Coordinate Systems for this Variable.
`java.lang.String`	`getDatasetLocation()` The location of the dataset this belongs to.
`java.lang.String`	`getDescription()` Get the description of the Variable.
`java.util.Set<NetcdfDataset.Enhance>`	`getEnhanceMode()` Returns the enhancements applied to this variable.
`double`	`getFillValue()` return value of _FillValue attribute
`Array`	`getMissingDataArray(int[] shape)` Return Array with missing data
`double[]`	`getMissingValues()` return values of missing_value attributes
`NetcdfFile`	`getNetcdfFile()` Get the NetcdfFile that this variable is contained in.
`double`	`getOffset()` The number to be added to the data after it is read.
`DataType`	`getOriginalDataType()` When this wraps another Variable, get the original Variable's DataType.
`java.lang.String`	`getOriginalName()` When this wraps another Variable, get the original Variable's name.
`Variable`	`getOriginalVariable()` A VariableDS usually wraps another Variable.
`DataType`	`getScaledOffsetType()` Return the data type for values that have undergone scale/offset conversion.
`double`	`getScaleFactor()` The data are to be multiplied by this value after the data are read.
`DataType.Signedness`	`getSignedness()` Returns the signedness of the decorated variable.
`java.lang.String`	`getUnitsString()` Get the Unit String for the Variable.
`DataType`	`getUnsignedConversionType()` Return the data type for values that have undergone unsigned conversion.
`double`	`getValidMax()` return the maximum value in the valid range
`double`	`getValidMin()` return the minimum value in the valid range
`boolean`	`hasCachedDataRecurse()` Deprecated. Removed in v6
`boolean`	`hasFillValue()` true if Variable has _FillValue attribute
`boolean`	`hasMissing()` true if Variable has missing data values
`boolean`	`hasMissingValue()` true if Variable has missing_value attribute
`boolean`	`hasScaleOffset()` true if Variable data will be converted using scale and offset
`boolean`	`hasValidData()` true if Variable has valid_range, valid_min or valid_max attributes
`boolean`	`invalidDataIsMissing()`
`boolean`	`isFillValue(double val)` return true if val equals the _FillValue
`boolean`	`isInvalidData(double val)` return true if val is outside the valid range
`boolean`	`isMissing(double val)` Returns `true` if the argument is a missing value.
`boolean`	`isMissingValue(double val)` return true if val equals a missing_value (low-level)
`java.lang.String`	`lookupEnumString(int val)` Lookup the enum string for this value.
`boolean`	`missingDataIsMissing()`
`long`	`readToStream(Section section, java.io.OutputStream out)` Read variable data to a stream.
`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 cs)` Deprecated. Use VariableDS.builder()
`boolean`	`removeEnhancement(NetcdfDataset.Enhance enhancement)` Deprecated. Use NetcdfDataset.builder()
`void`	`setCaching(boolean caching)` Deprecated. Use NetcdfDataset.builder()
`void`	`setFillValueIsMissing(boolean b)` Deprecated. Use NetcdfDataset.builder()
`void`	`setInvalidDataIsMissing(boolean b)` Deprecated. Use NetcdfDataset.builder()
`void`	`setMissingDataIsMissing(boolean b)` Deprecated. Use NetcdfDataset.builder()
`java.lang.String`	`setName(java.lang.String newName)` Deprecated. Use NetcdfDataset.builder()
`void`	`setOriginalVariable(Variable orgVar)` Deprecated. Use NetcdfDataset.builder()
`void`	`setUnitsString(java.lang.String units)` Deprecated. Use NetcdfDataset.builder()
`void`	`showScaleMissingProxy(java.util.Formatter f)` public for debugging
`VariableDS.Builder<?>`	`toBuilder()` Turn into a mutable Builder.
`java.lang.String`	`toStringDebug()` String representation of Variable and its attributes.

Methods inherited from class ucar.nc2.Variable
_readScalarData, addAll, addAttribute, addLocalFieldsToBuilder, attributes, compareTo, createNewCache, equals, extraInfo, findAttribute, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, findAttributeString, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getParentGroup, getParentGroupOrRoot, getParentStructure, getProxyReader, getRanges, getRank, getScalarData, getShape, getShape, getShapeAll, getShapeAsSection, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, invalidateCache, isCaching, isCoordinateVariable, isEmpty, isImmutable, isMemberOfStructure, isMetadata, isScalar, isUnknownLength, isUnlimited, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, reduce, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setImmutable, setIsScalar, setParentGroup, setProxyReader, setSizeToCache, setSPobject, setValues, setValues, slice, toString, writeCDL, writeCDL

Methods inherited from class ucar.nc2.CDMNode
annotate, annotation, getDODSName, getFullNameEscaped, getGroup, getImmutable, getName, getShortName, getSort, localhash, setDODSName, 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.dataset.VariableEnhanced
getFullName, getShortName

Methods inherited from interface ucar.nc2.VariableSimpleIF
getName, getShortName

Methods inherited from interface ucar.nc2.AttributeContainer
filter, findAttValueIgnoreCase, getName, hasAttribute, hasAttributeIgnoreCase, iterator

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - orgVar
```
protected Variable orgVar
```
  - orgDataType
```
protected DataType orgDataType
```
  - orgName
```
protected java.lang.String orgName
```
- Constructor Detail
  - VariableDS
```
@Deprecated
public VariableDS(NetcdfDataset ds,
                              Group group,
                              Structure parentStructure,
                              java.lang.String shortName,
                              DataType dataType,
                              java.lang.String dims,
                              java.lang.String units,
                              java.lang.String desc)
```
    Deprecated. Use NetcdfDataset.builder()
    Constructor when there's no underlying variable. You must also set the values by doing one of:
    1. set the values with setCachedData()
    2. set a proxy reader with setProxyReader()
    Otherwise, it is assumed to have constant values (using the fill value)
    Parameters:
    
    ds - the containing dataset
    
    group - the containing group
    
    parentStructure - the containing Structure (may be null)
    
    shortName - the (short) name
    
    dataType - the data type
    
    dims - list of dimension names, these must already exist in the Group; empty String = scalar
    
    units - String value of units, may be null
    
    desc - String value of description, may be null
  - VariableDS
```
@Deprecated
public VariableDS(Group group,
                              Structure parent,
                              java.lang.String shortName,
                              Variable orgVar)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Make a new VariableDS, delegate data reading to the original variable, but otherwise dont take any info from it. This is used by NcML explicit mode.
    
    Parameters:
    
    group - the containing group; may not be null
    
    parent - parent Structure, may be null
    
    shortName - variable shortName, must be unique within the Group
    
    orgVar - the original Variable to wrap. The original Variable is not modified. Must not be a Structure, use StructureDS instead.
  - VariableDS
```
@Deprecated
public VariableDS(Group g,
                              Variable orgVar,
                              boolean enhance)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Wrap the given Variable, making it into a VariableDS. Delegate data reading to the original variable. Take all metadata from original variable. Does not share cache, iosp.
    
    Parameters:
    
    g - logical container, if null use orgVar's group
    
    orgVar - the original Variable to wrap. The original Variable is not modified. Must not be a Structure, use StructureDS instead.
    
    enhance - if true, use NetcdfDataset.defaultEnhanceMode to define what enhancements are made. Note that this can change DataType and data values. You can also call enhance() later. If orgVar is VariableDS, then enhance is inherited from there, and this parameter is ignored.
  - VariableDS
```
@Deprecated
protected VariableDS(VariableDS vds,
                                 boolean isCopy)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Copy constructor, for subclasses. Used by copy() and CoordinateAxis Share everything except the coord systems.
    
    Parameters:
    
    vds - copy from here.
    
    isCopy - called from copy()
  - VariableDS
```
protected VariableDS(VariableDS.Builder<?> builder,
                     Group parentGroup)
```
- Method Detail
  - getNetcdfFile
```
public NetcdfFile getNetcdfFile()
```
    Description copied from class: Variable
    
    Get the NetcdfFile that this variable is contained in. May be null.
    
    Overrides:
    
    getNetcdfFile in class Variable
  - copy
```
@Deprecated
protected VariableDS copy()
```
    Deprecated. Use toBuilder()
    
    Overrides:
    
    copy in class Variable
  - clearCoordinateSystems
```
@Deprecated
public void clearCoordinateSystems()
```
    Deprecated. Use NetcdfDataset.builder()
    
    Remove coordinate system info.
    
    Specified by:
    
    clearCoordinateSystems in interface VariableEnhanced
  - enhance
```
@Deprecated
public void enhance(java.util.Set<NetcdfDataset.Enhance> enhancements)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Calculate scale/offset/missing/enum/unsigned value info. This may change the DataType.
    
    Specified by:
    
    enhance in interface VariableEnhanced
  - getEnhanceMode
```
public java.util.Set<NetcdfDataset.Enhance> getEnhanceMode()
```
    Returns the enhancements applied to this variable. If this variable wraps another variable, the returned set will also contain the enhancements applied to the nested variable, recursively.
    
    Returns:
    
    the enhancements applied to this variable.
  - addEnhancement
```
@Deprecated
public boolean addEnhancement(NetcdfDataset.Enhance enhancement)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Add enhancement to this variable. It may result in a change of data type.
    
    Parameters:
    
    enhancement - the enhancement to add.
    
    Returns:
    
    true if the set of enhancements changed as a result of the call.
  - removeEnhancement
```
@Deprecated
public boolean removeEnhancement(NetcdfDataset.Enhance enhancement)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Remove enhancement from this variable. It may result in a change of data type.
    
    Parameters:
    
    enhancement - the enhancement to remove.
    
    Returns:
    
    true if the set of enhancements changed as a result of the call.
  - getOriginalVariable
```
public Variable getOriginalVariable()
```
    A VariableDS usually wraps another Variable.
    
    Specified by:
    
    getOriginalVariable in interface VariableEnhanced
    
    Returns:
    
    original Variable or null
  - setOriginalVariable
```
@Deprecated
public void setOriginalVariable(Variable orgVar)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Set the Variable to wrap. Used by NcML explicit mode.
    
    Specified by:
    
    setOriginalVariable in interface VariableEnhanced
    
    Parameters:
    
    orgVar - original Variable, must not be a Structure
  - getOriginalDataType
```
public DataType getOriginalDataType()
```
    When this wraps another Variable, get the original Variable's DataType.
    
    Returns:
    
    original Variable's DataType, or current data type if it doesnt wrap another variable
  - getOriginalName
```
public java.lang.String getOriginalName()
```
    When this wraps another Variable, get the original Variable's name.
    
    Specified by:
    
    getOriginalName in interface VariableEnhanced
    
    Returns:
    
    original Variable's name
  - lookupEnumString
```
public java.lang.String lookupEnumString(int val)
```
    Description copied from class: Variable
    
    Lookup the enum string for this value. Can only be called on enum types, where dataType.isEnum() is true.
    
    Overrides:
    
    lookupEnumString in class Variable
    
    Parameters:
    
    val - the integer value of this enum
    
    Returns:
    
    the String value
  - setName
```
@Deprecated
public java.lang.String setName(java.lang.String newName)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from class: Variable
    
    Set the short name, converting to valid CDM object name if needed.
    
    Overrides:
    
    setName in class Variable
    
    Parameters:
    
    newName - set to this value
    
    Returns:
    
    valid CDM object name
  - toStringDebug
```
public java.lang.String toStringDebug()
```
    Description copied from class: Variable
    
    String representation of Variable and its attributes.
    
    Overrides:
    
    toStringDebug in class Variable
  - getDatasetLocation
```
public java.lang.String getDatasetLocation()
```
    Description copied from class: Variable
    
    The location of the dataset this belongs to. Labeling purposes only.
    
    Overrides:
    
    getDatasetLocation in class Variable
  - hasCachedDataRecurse
```
@Deprecated
public boolean hasCachedDataRecurse()
```
    Deprecated. Removed in v6
  - setCaching
```
@Deprecated
public void setCaching(boolean caching)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from class: Variable
    
    Set whether to cache or not. Implies that the entire array will be stored, once read. Normally this is set automatically based on size of data.
    
    Overrides:
    
    setCaching in class Variable
    
    Parameters:
    
    caching - set if caching.
  - _read
```
protected Array _read()
               throws java.io.IOException
```
    Overrides:
    
    _read in class Variable
    
    Throws:
    
    java.io.IOException
  - _read
```
protected Array _read(Section section)
               throws java.io.IOException,
                      InvalidRangeException
```
    Overrides:
    
    _read in class Variable
    
    Throws:
    
    java.io.IOException
    
    InvalidRangeException
  - reallyRead
```
public Array reallyRead(Variable client,
                        CancelTask cancelTask)
                 throws java.io.IOException
```
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Overrides:
    
    reallyRead in class Variable
    
    Parameters:
    
    client - the client Variable
    
    cancelTask - user may cancel
    
    Returns:
    
    Array
    
    Throws:
    
    java.io.IOException - on error
  - reallyRead
```
public Array reallyRead(Variable client,
                        Section section,
                        CancelTask cancelTask)
                 throws java.io.IOException,
                        InvalidRangeException
```
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Overrides:
    
    reallyRead in class Variable
    
    Parameters:
    
    client - the client Variable
    
    section - the section of data to read.
    
    cancelTask - user may cancel
    
    Returns:
    
    Array
    
    Throws:
    
    java.io.IOException - on error
    
    InvalidRangeException - if section has incorrect rank or illegal shape.
  - readToStream
```
public long readToStream(Section section,
                         java.io.OutputStream out)
                  throws java.io.IOException,
                         InvalidRangeException
```
    Description copied from class: Variable
    
    Read variable data to a stream. Support for NcStreamWriter.
    
    Overrides:
    
    readToStream in class Variable
    
    Throws:
    
    java.io.IOException
    
    InvalidRangeException
  - getMissingDataArray
```
public Array getMissingDataArray(int[] shape)
```
    Return Array with missing data
    
    Parameters:
    
    shape - of this shape
    
    Returns:
    
    Array with given shape
  - showScaleMissingProxy
```
public void showScaleMissingProxy(java.util.Formatter f)
```
    public for debugging
    
    Parameters:
    
    f - put info here
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from class: Variable
    
    Get the description of the Variable. Default is to use CDM.LONG_NAME attribute value. If not exist, look for "description", "title", or "standard_name" attribute value (in that order).
    
    Specified by:
    
    getDescription in interface Enhancements
    
    Specified by:
    
    getDescription in interface VariableSimpleIF
    
    Overrides:
    
    getDescription in class Variable
    
    Returns:
    
    description, or null if not found.
  - getUnitsString
```
public java.lang.String getUnitsString()
```
    Description copied from class: Variable
    
    Get the Unit String for the Variable. Looks for the CDM.UNITS attribute value
    
    Specified by:
    
    getUnitsString in interface Enhancements
    
    Specified by:
    
    getUnitsString in interface VariableSimpleIF
    
    Overrides:
    
    getUnitsString in class Variable
    
    Returns:
    
    unit string, or null if not found.
  - setUnitsString
```
@Deprecated
public void setUnitsString(java.lang.String units)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from interface: VariableEnhanced
    
    Set the Unit String for this Variable. Default is to use the CDM.UNITS attribute.
    
    Specified by:
    
    setUnitsString in interface VariableEnhanced
    
    Parameters:
    
    units - unit string
  - getCoordinateSystems
```
public com.google.common.collect.ImmutableList<CoordinateSystem> getCoordinateSystems()
```
    Description copied from interface: Enhancements
    
    Get the list of Coordinate Systems for this Variable.
    
    Specified by:
    
    getCoordinateSystems in interface Enhancements
    
    Returns:
    
    list of type CoordinateSystem; may be empty but not null.
  - addCoordinateSystem
```
@Deprecated
public void addCoordinateSystem(CoordinateSystem cs)
```
    Deprecated. Use VariableDS.builder()
    
    Description copied from interface: Enhancements
    
    Add a CoordinateSystem to the dataset.
    
    Specified by:
    
    addCoordinateSystem in interface Enhancements
    
    Parameters:
    
    cs - add this Coordinate System
  - removeCoordinateSystem
```
@Deprecated
public void removeCoordinateSystem(CoordinateSystem cs)
```
    Deprecated. Use VariableDS.builder()
    
    Description copied from interface: Enhancements
    
    Remove a CoordinateSystem from the dataset.
    
    Specified by:
    
    removeCoordinateSystem in interface Enhancements
    
    Parameters:
    
    cs - remove this coordinate system
  - hasScaleOffset
```
public boolean hasScaleOffset()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable data will be converted using scale and offset
    
    Specified by:
    
    hasScaleOffset in interface EnhanceScaleMissingUnsigned
  - getScaleFactor
```
public double getScaleFactor()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    The data are to be multiplied by this value after the data are read. By default it is 1.0, i.e. no scaling. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.
    
    Specified by:
    
    getScaleFactor in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the multiplier to apply to the data.
  - getOffset
```
public double getOffset()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    The number to be added to the data after it is read. If both CDM.SCALE_FACTOR and CDM.ADD_OFFSET attributes are present, the data are first scaled before the offset is added. By default it is 0.0, i.e. no offset. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.
    
    Specified by:
    
    getOffset in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the number to add to the data.
  - hasMissing
```
public boolean hasMissing()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has missing data values
    
    Specified by:
    
    hasMissing in interface IsMissingEvaluator
    
    Specified by:
    
    hasMissing in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    true if Variable has missing data values
  - isMissing
```
public boolean isMissing(double val)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns true if the argument is a missing value. Note that Float.NaN and Double.NaN are considered missing data.
    
    Specified by:
    
    isMissing in interface IsMissingEvaluator
    
    Specified by:
    
    isMissing in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    val - an unpacked value.
    
    Returns:
    
    true if the argument is a missing value.
  - hasValidData
```
public boolean hasValidData()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has valid_range, valid_min or valid_max attributes
    
    Specified by:
    
    hasValidData in interface EnhanceScaleMissingUnsigned
  - getValidMin
```
public double getValidMin()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return the minimum value in the valid range
    
    Specified by:
    
    getValidMin in interface EnhanceScaleMissingUnsigned
  - getValidMax
```
public double getValidMax()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return the maximum value in the valid range
    
    Specified by:
    
    getValidMax in interface EnhanceScaleMissingUnsigned
  - isInvalidData
```
public boolean isInvalidData(double val)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val is outside the valid range
    
    Specified by:
    
    isInvalidData in interface EnhanceScaleMissingUnsigned
  - hasFillValue
```
public boolean hasFillValue()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has _FillValue attribute
    
    Specified by:
    
    hasFillValue in interface EnhanceScaleMissingUnsigned
  - getFillValue
```
public double getFillValue()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return value of _FillValue attribute
    
    Specified by:
    
    getFillValue in interface EnhanceScaleMissingUnsigned
  - isFillValue
```
public boolean isFillValue(double val)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val equals the _FillValue
    
    Specified by:
    
    isFillValue in interface EnhanceScaleMissingUnsigned
  - hasMissingValue
```
public boolean hasMissingValue()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has missing_value attribute
    
    Specified by:
    
    hasMissingValue in interface EnhanceScaleMissingUnsigned
  - getMissingValues
```
public double[] getMissingValues()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return values of missing_value attributes
    
    Specified by:
    
    getMissingValues in interface EnhanceScaleMissingUnsigned
  - isMissingValue
```
public boolean isMissingValue(double val)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val equals a missing_value (low-level)
    
    Specified by:
    
    isMissingValue in interface EnhanceScaleMissingUnsigned
  - setFillValueIsMissing
```
@Deprecated
public void setFillValueIsMissing(boolean b)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Set if _FillValue is considered isMissing().
    
    Specified by:
    
    setFillValueIsMissing in interface EnhanceScaleMissingUnsigned
  - setInvalidDataIsMissing
```
@Deprecated
public void setInvalidDataIsMissing(boolean b)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    set if valid_range is considered isMissing(); better set in constructor if possible
    
    Specified by:
    
    setInvalidDataIsMissing in interface EnhanceScaleMissingUnsigned
  - missingDataIsMissing
```
public boolean missingDataIsMissing()
```
  - fillValueIsMissing
```
public boolean fillValueIsMissing()
```
  - invalidDataIsMissing
```
public boolean invalidDataIsMissing()
```
  - setMissingDataIsMissing
```
@Deprecated
public void setMissingDataIsMissing(boolean b)
```
    Deprecated. Use NetcdfDataset.builder()
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    set if missing_data is considered isMissing(); better set in constructor if possible
    
    Specified by:
    
    setMissingDataIsMissing in interface EnhanceScaleMissingUnsigned
  - getScaledOffsetType
```
@Nullable
public DataType getScaledOffsetType()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Return the data type for values that have undergone scale/offset conversion. This will be null if the decorated variable lacks scale_factor or add_offset attributes. You can check with EnhanceScaleMissingUnsigned.hasScaleOffset().
    
    Specified by:
    
    getScaledOffsetType in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the data type for values that have undergone scale/offset conversion.
  - getUnsignedConversionType
```
public DataType getUnsignedConversionType()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Return the data type for values that have undergone unsigned conversion. This will never be null, even when no unsigned conversion is necessary (because the underlying variable isn't unsigned). In such cases, this data type will be the same as that of the underlying variable.
    
    Specified by:
    
    getUnsignedConversionType in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the data type for values that have undergone unsigned conversion.
  - getSignedness
```
public DataType.Signedness getSignedness()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns the signedness of the decorated variable.
    
    Specified by:
    
    getSignedness in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the signedness of the decorated variable.
  - applyScaleOffset
```
public double applyScaleOffset(java.lang.Number value)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Apply scale and offset to the specified value if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value.
    
    Specified by:
    
    applyScaleOffset in interface EnhanceScaleMissingUnsigned
  - applyScaleOffset
```
public Array applyScaleOffset(Array data)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Apply scale and offset to each element of in and return the result as a new Array, but only if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value. Otherwise, just return data.
    
    Specified by:
    
    applyScaleOffset in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    data - convert this
    
    Returns:
    
    converted data.
  - convertUnsigned
```
public java.lang.Number convertUnsigned(java.lang.Number value)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Convert value to the next largest integral data type by an unsigned conversion. The conversion only happens if the decorated variable is unsigned and value is a negative integer. Otherwise, simply return value.
    
    Specified by:
    
    convertUnsigned in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    value - an integral number to convert.
    
    Returns:
    
    the result of an unsigned conversion of value.
  - convertUnsigned
```
public java.lang.Number convertUnsigned(java.lang.Number value,
                                        DataType dataType)
```
  - convertUnsigned
```
public Array convertUnsigned(Array in)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Performs an unsigned conversion of each element of in and returns the result as a new Array. The data type of the returned array will be EnhanceScaleMissingUnsigned.getUnsignedConversionType().
    
    Specified by:
    
    convertUnsigned in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - an Array containing integral Numbers to convert.
    
    Returns:
    
    the result of an unsigned conversion of each element of in.
  - convertMissing
```
public java.lang.Number convertMissing(java.lang.Number value)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    If value is missing, return Double.NaN. Otherwise, simply return value
    
    Specified by:
    
    convertMissing in interface EnhanceScaleMissingUnsigned
  - convertMissing
```
public Array convertMissing(Array in)
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns a copy of in, except that each missing value is replaced by Double.NaN.
    
    Specified by:
    
    convertMissing in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - an array containing floating-point numbers to convert.
    
    Returns:
    
    the result of a missing conversion of each element of in.
  - convert
```
@Deprecated
public Array convert(Array in,
                                 boolean convertUnsigned,
                                 boolean applyScaleOffset,
                                 boolean convertMissing)
```
    Deprecated. use implementations in filters package
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Perform the specified conversions on each element of in and return the result as a new Array. Note that this method is more efficient than calling EnhanceScaleMissingUnsigned.convertUnsigned(Array), followed by EnhanceScaleMissingUnsigned.applyScaleOffset(Array), followed by EnhanceScaleMissingUnsigned.convertMissing(Array), as only one copy of in is made.
    
    Specified by:
    
    convert in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - a numeric array.
    
    convertUnsigned - true if we should convert unsigned.
    
    applyScaleOffset - true if we should apply scale/offset.
    
    convertMissing - true if we should convert missing.
    
    Returns:
    
    a new array, with the specified conversions performed.
  - toBuilder
```
public VariableDS.Builder<?> toBuilder()
```
    Description copied from class: Variable
    
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
    
    Overrides:
    
    toBuilder in class Variable
  - addLocalFieldsToBuilder
```
protected VariableDS.Builder<?> addLocalFieldsToBuilder(VariableDS.Builder<? extends VariableDS.Builder<?>> builder)
```
  - builder
```
public static VariableDS.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"

Class VariableDS

Nested Class Summary

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

Field Summary

Fields inherited from class ucar.nc2.Variable

Fields inherited from class ucar.nc2.CDMNode

Constructor Summary

Method Summary

Methods inherited from class ucar.nc2.Variable

Methods inherited from class ucar.nc2.CDMNode

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

Methods inherited from interface ucar.nc2.VariableSimpleIF

Methods inherited from interface ucar.nc2.AttributeContainer

Methods inherited from interface java.lang.Iterable

Field Detail

orgVar

orgDataType

orgName

Constructor Detail

VariableDS

VariableDS

VariableDS

VariableDS

VariableDS

Method Detail

getNetcdfFile

copy

clearCoordinateSystems

enhance

getEnhanceMode

addEnhancement

removeEnhancement

getOriginalVariable

setOriginalVariable

getOriginalDataType

getOriginalName

lookupEnumString

setName

toStringDebug

getDatasetLocation

hasCachedDataRecurse

setCaching

_read

_read

reallyRead

reallyRead

readToStream

getMissingDataArray

showScaleMissingProxy

getDescription

getUnitsString

setUnitsString

getCoordinateSystems

addCoordinateSystem

removeCoordinateSystem

hasScaleOffset

getScaleFactor

getOffset

hasMissing

isMissing

hasValidData

getValidMin

getValidMax

isInvalidData

hasFillValue

getFillValue

isFillValue

hasMissingValue

getMissingValues

isMissingValue

setFillValueIsMissing

setInvalidDataIsMissing

missingDataIsMissing

fillValueIsMissing

invalidDataIsMissing

setMissingDataIsMissing

getScaledOffsetType

getUnsignedConversionType

getSignedness