Variable (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.Variable

All Implemented Interfaces:

Comparable<VariableSimpleIF>, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

Structure, VariableDS
```
@Immutable
public class Variable
extends Object
implements VariableSimpleIF, ProxyReader
```
A logical container for data, with a dataType, a set of Dimensions that define its array shape, and a set of Attributes.
The data is a multidimensional array of primitive types, Strings, or Structures. Data access is done through the read() methods, which return a memory resident Array.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Variable.Builder<T extends Variable.Builder<T>>

protected static class Variable.Cache

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected AttributeContainer`	`attributes`
`protected Variable.Cache`	`cache`
`protected ArrayType`	`dataType`
`protected com.google.common.collect.ImmutableList<Dimension>`	`dimensions`
`protected int`	`elementSize`
`protected int`	`hashCode`
`protected boolean`	`isVariableLength`
`protected NetcdfFile`	`ncfile`
`static boolean`	`permitCaching` Globally permit or prohibit caching.
`protected ProxyReader`	`proxyReader`
`protected int[]`	`shape`
`protected Object`	`spiObject`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Variable(Variable.Builder<?> builder, Group parentGroup)

Constructors
Modifier	Constructor and Description
`protected`	`Variable(Variable.Builder<?> builder, Group parentGroup)`

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)`
`protected Array`	`_readScalarData()` Deprecated. do not use
`protected Variable.Builder<?>`	`addLocalFieldsToBuilder(Variable.Builder<? extends Variable.Builder<?>> builder)`
`AttributeContainer`	`attributes()` The attributes contained by this Variable.
`static Variable.Builder<?>`	`builder()` Get Builder for this class that allows subclassing.
`int`	`compareTo(VariableSimpleIF o)` Sort by name
`boolean`	`equals(Object oo)`
`protected String`	`extraInfo()`
`Attribute`	`findAttribute(String name)` Find the attribute by name, return null if not exist
`String`	`findAttributeString(String attName, String defaultValue)` Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
`int`	`findDimensionIndex(String name)` Find the index of the named Dimension in this Variable.
`ArrayType`	`getArrayType()` Get the data type of the Variable.
`String`	`getDatasetLocation()` The location of the dataset this belongs to.
`DataType`	`getDataType()` Deprecated. use getArrayType()
`String`	`getDescription()` Get the description of the Variable.
`Dimension`	`getDimension(int i)` Get the ith dimension.
`com.google.common.collect.ImmutableList<Dimension>`	`getDimensions()` Get the list of dimensions used by this variable.
`com.google.common.collect.ImmutableSet<Dimension>`	`getDimensionSet()` Get the variable's Dimensions as a Set.
`String`	`getDimensionsString()` Get the list of Dimension names, space delineated.
`int`	`getElementSize()` Get the number of bytes for one element of this Variable.
`EnumTypedef`	`getEnumTypedef()` Get the EnumTypedef, only use if getDataType.isEnum()
`String`	`getFileTypeId()` Get the file type id for the underlying data source.
`String`	`getFullName()` Get the full name of this Variable.
`String`	`getNameAndDimensions()` Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
`void`	`getNameAndDimensions(Formatter buf, boolean useFullName, boolean strict)` Add display name plus the dimensions to the Formatter
`NetcdfFile`	`getNetcdfFile()` Get the NetcdfFile that this variable is contained in.
`Group`	`getParentGroup()` Get its containing Group, never null
`Structure`	`getParentStructure()` Get its parent structure, or null if not in structure
`com.google.common.collect.ImmutableList<Range>`	`getRanges()` Get shape as an List of Range objects.
`int`	`getRank()` Get the number of dimensions of the Variable, aka the rank.
`Section`	`getSection()` Get shape as a Section object.
`int[]`	`getShape()` Get the shape: length of Variable in each dimension.
`int`	`getShape(int index)` Get the size of the ith dimension
`Section`	`getShapeAsSection()` Deprecated. use getSection()
`String`	`getShortName()` The short name of the variable
`long`	`getSize()` Get the total number of elements in the Variable.
`int`	`getSizeToCache()` If total data size is less than SizeToCache in bytes, then cache.
`Object`	`getSPobject()` Get immutable service provider opaque object.
`String`	`getUnitsString()` Get the Unit String for the Variable.
`boolean`	`hasCachedData()` If this has cached data, or source data.
`int`	`hashCode()`
`void`	`invalidateCache()` Remove any cached values (but not srcData)
`boolean`	`isCaching()` Will this Variable be cached when read.
`boolean`	`isCoordinateVariable()` Calculate if this is a classic coordinate variable: has same name as its first dimension.
`boolean`	`isMemberOfStructure()` Is this a Structure Member?
`boolean`	`isMetadata()` Is this variable metadata?.
`boolean`	`isScalar()` Whether this is a scalar Variable (rank == 0).
`boolean`	`isUnlimited()` Can this variable's size grow?.
`boolean`	`isVariableLength()` Does this variable have a variable length dimension? If so, it has as one of its dimensions Dimension.VLEN.
`String`	`lookupEnumString(int val)` Lookup the enum string for this value.
`Array<?>`	`proxyReadArray(Variable client, CancelTask cancelTask)` public by accident, do not call directly.
`Array<?>`	`proxyReadArray(Variable client, Section section, CancelTask cancelTask)` public by accident, do not call directly.
`Array`	`read()` Deprecated. use readArray()
`Array`	`read(int[] origin, int[] shape)` Deprecated. use readArray(Section)
`Array`	`read(List<Range> ranges)` Deprecated. use readArray(new Section(ranges))
`Array`	`read(Section section)` Deprecated. use readArray(Section)
`Array`	`read(String sectionSpec)` Deprecated. use readArray(new Section(sectionSpec))
`Array<?>`	`readArray()` Read all the data for this Variable and return a memory resident Array.
`Array<?>`	`readArray(Section section)` Read a section of the data for this Variable from the netcdf file and return a memory resident Array.
`byte`	`readScalarByte()` Deprecated. use (byte) readArray().getScalar();
`double`	`readScalarDouble()` Deprecated. use (double) readArray().getScalar();
`float`	`readScalarFloat()` Deprecated. use (float) readArray().getScalar();
`int`	`readScalarInt()` Deprecated. use (int) readArray().getScalar();
`long`	`readScalarLong()` Deprecated. use (long) readArray().getScalar();
`short`	`readScalarShort()` Deprecated. use (short) readArray().getScalar();
`String`	`readScalarString()` Deprecated. use (String) readArray().getScalar() or if CHAR, readArray().makeStringFromChar()
`long`	`readToStream(Section section, OutputStream out)` Deprecated. do not use.
`Array`	`reallyRead(Variable client, CancelTask cancelTask)` Deprecated.
`Array`	`reallyRead(Variable client, Section section, CancelTask cancelTask)` Deprecated.
`Variable`	`reduce(List<Dimension> dims)` Create a new Variable that is a logical view of this Variable, by eliminating the specified dimension(s) of length 1.
`void`	`resetShape()` Deprecated. Use Variable.builder()
`Variable`	`section(List<Range> ranges)` Create a new Variable that is a logical subsection of this Variable.
`Variable`	`section(Section subsection)` Create a new Variable that is a logical subsection of this Variable.
`protected void`	`setCachedData(Array<?> cacheData)`
`void`	`setCaching(boolean caching)` Set whether to cache or not.
`Variable`	`slice(int dim, int value)` Create a new Variable that is a logical slice of this Variable, by fixing the specified dimension at the specified index value.
`Variable.Builder<?>`	`toBuilder()` Turn into a mutable Builder.
`String`	`toString()`
`String`	`toStringDebug()` Debugging info
`protected void`	`writeCDL(Formatter buf, Indent indent, boolean useFullName, boolean strict)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - permitCaching
```
public static boolean permitCaching
```
    Globally permit or prohibit caching. For use during testing and debugging.
    A true value for this field does not indicate whether a Variable is caching, only that it's permitted to cache.
  - hashCode
```
protected int hashCode
```
  - ncfile
```
@Nullable
protected final NetcdfFile ncfile
```
  - spiObject
```
@Nullable
protected final Object spiObject
```
  - dimensions
```
protected final com.google.common.collect.ImmutableList<Dimension> dimensions
```
  - attributes
```
protected final AttributeContainer attributes
```
  - proxyReader
```
protected final ProxyReader proxyReader
```
  - shape
```
protected int[] shape
```
  - isVariableLength
```
protected boolean isVariableLength
```
  - elementSize
```
protected int elementSize
```
  - dataType
```
protected ArrayType dataType
```
  - cache
```
protected Variable.Cache cache
```
- Constructor Detail
  - Variable
```
protected Variable(Variable.Builder<?> builder,
                   Group parentGroup)
```
- Method Detail
  - findDimensionIndex
```
public int findDimensionIndex(String name)
```
    Find the index of the named Dimension in this Variable.
    
    Parameters:
    
    name - the name of the dimension
    
    Returns:
    
    the index of the named Dimension, or -1 if not found.
  - getDatasetLocation
```
public String getDatasetLocation()
```
    The location of the dataset this belongs to. Labeling purposes only.
  - getDataType
```
@Deprecated
public DataType getDataType()
```
    Deprecated. use getArrayType()
    
    Get the data type of the Variable.
    
    Specified by:
    
    getDataType in interface VariableSimpleIF
  - getArrayType
```
public ArrayType getArrayType()
```
    Get the data type of the Variable.
    
    Specified by:
    
    getArrayType in interface VariableSimpleIF
  - getDescription
```
public String getDescription()
```
    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 VariableSimpleIF
    
    Returns:
    
    description, or null if not found.
  - getDimensions
```
public com.google.common.collect.ImmutableList<Dimension> getDimensions()
```
    Get the list of dimensions used by this variable. The most slowly varying (leftmost for Java and C programmers) dimension is first. For scalar variables, the list is empty.
    
    Specified by:
    
    getDimensions in interface VariableSimpleIF
  - getDimensionSet
```
public com.google.common.collect.ImmutableSet<Dimension> getDimensionSet()
```
    Get the variable's Dimensions as a Set.
  - getDimension
```
public Dimension getDimension(int i)
```
    Get the ith dimension.
    
    Parameters:
    
    i - index of the dimension.
    
    Returns:
    
    requested Dimension, or null if i is out of bounds.
  - getDimensionsString
```
public String getDimensionsString()
```
    Get the list of Dimension names, space delineated.
    
    Returns:
    
    Dimension names, space delineated
  - getElementSize
```
public int getElementSize()
```
    Get the number of bytes for one element of this Variable. For Variables of primitive type, this is equal to getDataType().getSize(). Variables of String type dont know their size, so what they return is undefined. Variables of Structure type return the total number of bytes for all the members of one Structure, plus possibly some extra padding, depending on the underlying format. Variables of Sequence type return the number of bytes of one element.
    
    Returns:
    
    total number of bytes for the Variable
  - getEnumTypedef
```
@Nullable
public EnumTypedef getEnumTypedef()
```
    Get the EnumTypedef, only use if getDataType.isEnum()
  - getFileTypeId
```
@Nullable
public String getFileTypeId()
```
    Get the file type id for the underlying data source.
    
    Returns:
    
    registered id of the file type
    
    See Also:
    
    "https://www.unidata.ucar.edu/software/netcdf-java/formats/FileTypes.html"
  - getFullName
```
public String getFullName()
```
    Get the full name of this Variable. see NetcdfFiles.makeFullName(Variable)
    
    Specified by:
    
    getFullName in interface VariableSimpleIF
  - getNetcdfFile
```
@Nullable
public NetcdfFile getNetcdfFile()
```
    Get the NetcdfFile that this variable is contained in. May be null when the Variable is self contained.
  - getParentGroup
```
public Group getParentGroup()
```
    Get its containing Group, never null
  - getParentStructure
```
@Nullable
public Structure getParentStructure()
```
    Get its parent structure, or null if not in structure
  - getRanges
```
public com.google.common.collect.ImmutableList<Range> getRanges()
```
    Get shape as an List of Range objects. The List is immutable.
    
    Returns:
    
    List of Ranges, one for each Dimension.
  - getRank
```
public int getRank()
```
    Get the number of dimensions of the Variable, aka the rank.
    
    Specified by:
    
    getRank in interface VariableSimpleIF
  - getShape
```
public int[] getShape()
```
    Get the shape: length of Variable in each dimension. A scalar (rank 0) will have an int[0] shape.
    
    Specified by:
    
    getShape in interface VariableSimpleIF
  - getShape
```
public int getShape(int index)
```
    Get the size of the ith dimension
  - getShapeAsSection
```
@Deprecated
public Section getShapeAsSection()
```
    Deprecated. use getSection()
  - getSection
```
public Section getSection()
```
    Get shape as a Section object.
    
    Returns:
    
    Section describing this Variable's shape.
  - getShortName
```
public String getShortName()
```
    The short name of the variable
    
    Specified by:
    
    getShortName in interface VariableSimpleIF
  - getSize
```
public long getSize()
```
    Get the total number of elements in the Variable. If this is an unlimited Variable, will use the current number of elements. If this is a Sequence, will return 1. If variable length, will skip vlen dimensions
    
    Returns:
    
    total number of elements in the Variable.
  - getUnitsString
```
@Nullable
public String getUnitsString()
```
    Get the Unit String for the Variable. Looks for the CDM.UNITS attribute value
    
    Specified by:
    
    getUnitsString in interface VariableSimpleIF
    
    Returns:
    
    unit string, or null if not found.
  - isCoordinateVariable
```
public boolean isCoordinateVariable()
```
    Calculate if this is a classic coordinate variable: has same name as its first dimension. If type char, must be 2D, else must be 1D.
    
    Returns:
    
    true if a coordinate variable.
  - isMemberOfStructure
```
public boolean isMemberOfStructure()
```
    Is this a Structure Member?
  - isMetadata
```
public boolean isMetadata()
```
    Is this variable metadata?. True if its values need to be included explicitly in NcML output.
  - isScalar
```
public boolean isScalar()
```
    Whether this is a scalar Variable (rank == 0).
  - isUnlimited
```
public boolean isUnlimited()
```
    Can this variable's size grow?. This is equivalent to saying at least one of its dimensions is unlimited.
    
    Returns:
    
    boolean true iff this variable can grow
  - isVariableLength
```
public boolean isVariableLength()
```
    Does this variable have a variable length dimension? If so, it has as one of its dimensions Dimension.VLEN.
    
    Returns:
    
    true if Variable has a variable length dimension?
  - lookupEnumString
```
@Nullable
public String lookupEnumString(int val)
```
    Lookup the enum string for this value. Can only be called on enum types, where dataType.isEnum() is true.
    
    Parameters:
    
    val - the integer value of this enum
    
    Returns:
    
    the String value, or null if not exist.
  - section
```
public Variable section(List<Range> ranges)
                 throws InvalidRangeException
```
    Create a new Variable that is a logical subsection of this Variable. No data is read until a read method is called on it.
    
    Parameters:
    
    ranges - List of type ucar.ma2.Range, with size equal to getRank(). Each Range corresponds to a Dimension, and specifies the section of data to read in that Dimension. A Range object may be null, which means use the entire dimension.
    
    Returns:
    
    a new Variable which is a logical section of this Variable.
    
    Throws:
    
    InvalidRangeException - if shape and range list dont match
  - section
```
public Variable section(Section subsection)
                 throws InvalidRangeException
```
    Create a new Variable that is a logical subsection of this Variable. No data is read until a read method is called on it.
    
    Parameters:
    
    subsection - Section of this variable. Each Range in the section corresponds to a Dimension, and specifies the section of data to read in that Dimension. A Range object may be null, which means use the entire dimension.
    
    Returns:
    
    a new Variable which is a logical section of this Variable.
    
    Throws:
    
    InvalidRangeException - if section not compatible with shape
  - slice
```
public Variable slice(int dim,
                      int value)
               throws InvalidRangeException
```
    Create a new Variable that is a logical slice of this Variable, by fixing the specified dimension at the specified index value. This reduces rank by 1. No data is read until a read method is called on it.
    
    Parameters:
    
    dim - which dimension to fix
    
    value - at what index value
    
    Returns:
    
    a new Variable which is a logical slice of this Variable.
    
    Throws:
    
    InvalidRangeException - if dimension or value is illegal
  - reduce
```
public Variable reduce(List<Dimension> dims)
```
    Create a new Variable that is a logical view of this Variable, by eliminating the specified dimension(s) of length 1. No data is read until a read method is called on it.
    
    Parameters:
    
    dims - list of dimensions of length 1 to reduce
    
    Returns:
    
    a new Variable which is a logical slice of this Variable.
  - readToStream
```
@Deprecated
public long readToStream(Section section,
                                      OutputStream out)
                               throws IOException,
                                      InvalidRangeException
```
    Deprecated. do not use.
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - read
```
@Deprecated
public Array read(int[] origin,
                               int[] shape)
                        throws IOException,
                               InvalidRangeException
```
    Deprecated. use readArray(Section)
    
    Read a section of the data for this Variable and return a memory resident Array. The Array has the same element type as the Variable, and the requested shape. Note that this does not do rank reduction, so the returned Array has the same rank as the Variable. Use Array.reduce() for rank reduction.
    assert(origin[ii] + shape[ii]*stride[ii] <= Variable.shape[ii]);
    
    Parameters:
    
    origin - int array specifying the starting index. If null, assume all zeroes.
    
    shape - int array specifying the extents in each dimension. This becomes the shape of the returned Array.
    
    Returns:
    
    the requested data in a memory-resident Array
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - read
```
@Deprecated
public Array read(String sectionSpec)
                        throws IOException,
                               InvalidRangeException
```
    Deprecated. use readArray(new Section(sectionSpec))
    
    Read data section specified by a "section selector", and return a memory resident Array. Uses Fortran 90 array section syntax.
    
    Parameters:
    
    sectionSpec - specification string, eg "1:2,10,:,1:100:10". May optionally have ().
    
    Returns:
    
    the requested data in a memory-resident Array
    
    Throws:
    
    IOException
    
    InvalidRangeException
    
    See Also:
    
    for sectionSpec syntax
  - read
```
@Deprecated
public Array read(List<Range> ranges)
                        throws IOException,
                               InvalidRangeException
```
    Deprecated. use readArray(new Section(ranges))
    
    Read a section of the data for this Variable from the netcdf file and return a memory resident Array.
    
    Parameters:
    
    ranges - list of Range specifying the section of data to read.
    
    Returns:
    
    the requested data in a memory-resident Array
    
    Throws:
    
    IOException - if error
    
    InvalidRangeException - if ranges is invalid
    
    See Also:
    
    read(Section)
  - read
```
@Deprecated
public Array read(Section section)
                        throws IOException,
                               InvalidRangeException
```
    Deprecated. use readArray(Section)
    
    Read a section of the data for this Variable from the netcdf file and return a memory resident Array. The Array has the same element type as the Variable, and the requested shape. Note that this does not do rank reduction, so the returned Array has the same rank as the Variable. Use Array.reduce() for rank reduction.
    If the Variable is a member of an array of Structures, this returns only the variable's data in the first Structure, so that the Array shape is the same as the Variable. To read the data in all structures, use ncfile.readSectionSpec().
    Note this only allows you to specify a subset of this variable. If the variable is nested in a array of structures and you want to subset that, use NetcdfFile.read(String sectionSpec, boolean flatten);
    
    Parameters:
    
    section - list of Range specifying the section of data to read. Must be null or same rank as variable. If list is null, assume all data. Each Range corresponds to a Dimension. If the Range object is null, it means use the entire dimension.
    
    Returns:
    
    the requested data in a memory-resident Array
    
    Throws:
    
    IOException - if error
    
    InvalidRangeException - if section is invalid
  - read
```
@Deprecated
public Array read()
                        throws IOException
```
    Deprecated. use readArray()
    
    Read all the data for this Variable and return a memory resident Array. The Array has the same element type and shape as the Variable.
    If the Variable is a member of an array of Structures, this returns only the variable's data in the first Structure, so that the Array shape is the same as the Variable. To read the data in all structures, use ncfile.readSection().
    
    Returns:
    
    the requested data in a memory-resident Array.
    
    Throws:
    
    IOException
  - readScalarByte
```
@Deprecated
public byte readScalarByte()
                                 throws IOException
```
    Deprecated. use (byte) readArray().getScalar();
    
    Get the value as a byte for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    RuntimeException - if data type not convertible to byte
  - readScalarShort
```
@Deprecated
public short readScalarShort()
                                   throws IOException
```
    Deprecated. use (short) readArray().getScalar();
    
    Get the value as a short for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    RuntimeException - if data type not convertible to byte
  - readScalarInt
```
@Deprecated
public int readScalarInt()
                               throws IOException
```
    Deprecated. use (int) readArray().getScalar();
    
    Get the value as a int for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    RuntimeException - if data type not convertible to byte
  - readScalarLong
```
@Deprecated
public long readScalarLong()
                                 throws IOException
```
    Deprecated. use (long) readArray().getScalar();
    
    Get the value as a long for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable
    
    RuntimeException - if data type not convertible to byte
  - readScalarFloat
```
@Deprecated
public float readScalarFloat()
                                   throws IOException
```
    Deprecated. use (float) readArray().getScalar();
    
    Get the value as a float for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    RuntimeException - if data type not convertible to byte
  - readScalarDouble
```
@Deprecated
public double readScalarDouble()
                                     throws IOException
```
    Deprecated. use (double) readArray().getScalar();
    
    Get the value as a double for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    RuntimeException - if data type not convertible to byte
  - readScalarString
```
@Deprecated
public String readScalarString()
                                     throws IOException
```
    Deprecated. use (String) readArray().getScalar() or if CHAR, readArray().makeStringFromChar()
    
    Get the value as a String for a scalar Variable. May also be one-dimensional of length 1. May also be one-dimensional of type CHAR, which wil be turned into a scalar String.
    
    Throws:
    
    IOException - if theres an IO Error
    
    UnsupportedOperationException - if not a scalar or one-dimensional.
    
    ClassCastException - if data type not DataType.STRING or DataType.CHAR.
  - _read
```
protected Array _read()
               throws IOException
```
    Throws:
    
    IOException
  - readArray
```
public Array<?> readArray()
                   throws IOException
```
    Read all the data for this Variable and return a memory resident Array. The Array has the same element type and shape as the Variable.
    
    Throws:
    
    IOException
  - _read
```
protected Array _read(Section section)
               throws IOException,
                      InvalidRangeException
```
    Throws:
    
    IOException
    
    InvalidRangeException
  - readArray
```
public Array<?> readArray(@Nullable
                          Section section)
                   throws IOException,
                          InvalidRangeException
```
    Read a section of the data for this Variable from the netcdf file and return a memory resident Array. The Array has the same element type as the Variable, and the requested shape. Note that this does not do rank reduction, so the returned Array has the same rank as the Variable. Use Array.reduce() for rank reduction.
    
    Parameters:
    
    section - The section of data to read. Must be null or same rank as variable. If list is null, assume all data. Each Range corresponds to a Dimension. If the Range object is null, it means use the entire dimension.
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - _readScalarData
```
@Deprecated
protected Array _readScalarData()
                                      throws IOException
```
    Deprecated. do not use
    
    Throws:
    
    IOException
  - reallyRead
```
@Deprecated
public Array reallyRead(Variable client,
                                     CancelTask cancelTask)
                              throws IOException
```
    Deprecated.
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Parameters:
    
    client - the client Variable
    
    cancelTask - user may cancel
    
    Returns:
    
    memory resident Array containing the data. Will have same shape as the Variable.
    
    Throws:
    
    IOException
  - proxyReadArray
```
public Array<?> proxyReadArray(Variable client,
                               CancelTask cancelTask)
                        throws IOException
```
    public by accident, do not call directly.
    
    Specified by:
    
    proxyReadArray in interface ProxyReader
    
    Throws:
    
    IOException
  - reallyRead
```
@Deprecated
public Array reallyRead(Variable client,
                                     Section section,
                                     CancelTask cancelTask)
                              throws IOException,
                                     InvalidRangeException
```
    Deprecated.
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Parameters:
    
    client - the client Variable
    
    section - the section of data to read.
    
    cancelTask - user may cancel
    
    Returns:
    
    memory resident Array containing the data. Will have same shape as the Section.
    
    Throws:
    
    InvalidRangeException - if section has incorrect rank or illegal shape.
    
    IOException
  - proxyReadArray
```
public Array<?> proxyReadArray(Variable client,
                               Section section,
                               CancelTask cancelTask)
                        throws IOException,
                               InvalidRangeException
```
    public by accident, do not call directly.
    
    Specified by:
    
    proxyReadArray in interface ProxyReader
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - getNameAndDimensions
```
public String getNameAndDimensions()
```
    Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
  - getNameAndDimensions
```
public void getNameAndDimensions(Formatter buf,
                                 boolean useFullName,
                                 boolean strict)
```
    Add display name plus the dimensions to the Formatter
    
    Parameters:
    
    buf - add info to this
    
    useFullName - use full name else short name. strict = true implies short name
    
    strict - strictly comply with ncgen syntax, with name escaping. otherwise, get extra info, no escaping
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - writeCDL
```
protected void writeCDL(Formatter buf,
                        Indent indent,
                        boolean useFullName,
                        boolean strict)
```
  - toStringDebug
```
public String toStringDebug()
```
    Debugging info
  - extraInfo
```
protected String extraInfo()
```
  - equals
```
public boolean equals(Object oo)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(VariableSimpleIF o)
```
    Sort by name
    
    Specified by:
    
    compareTo in interface Comparable<VariableSimpleIF>
  - attributes
```
public AttributeContainer attributes()
```
    The attributes contained by this Variable.
    
    Specified by:
    
    attributes in interface VariableSimpleIF
  - findAttribute
```
@Nullable
public Attribute findAttribute(String name)
```
    Find the attribute by name, return null if not exist
  - findAttributeString
```
public String findAttributeString(String attName,
                                  String defaultValue)
```
    Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
    
    Returns:
    
    the attribute value, or defaultValue if not found
  - resetShape
```
@Deprecated
public void resetShape()
```
    Deprecated. Use Variable.builder()
    
    Use when unlimited dimension grows, to recalculate the shape.
  - getSPobject
```
public Object getSPobject()
```
    Get immutable service provider opaque object.
  - getSizeToCache
```
public int getSizeToCache()
```
    If total data size is less than SizeToCache in bytes, then cache.
    
    Returns:
    
    size at which caching happens
  - setCaching
```
public void setCaching(boolean caching)
```
    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. if false, cachedData is cleared.
  - isCaching
```
public boolean isCaching()
```
    Will this Variable be cached when read. Set externally by setCaching, or calculated based on total size < sizeToCache.
    This will always return false if caching isn't permitted.
    
    Returns:
    
    true is caching
  - invalidateCache
```
public void invalidateCache()
```
    Remove any cached values (but not srcData)
  - setCachedData
```
protected void setCachedData(Array<?> cacheData)
```
  - hasCachedData
```
public boolean hasCachedData()
```
    If this has cached data, or source data.
  - toBuilder
```
public Variable.Builder<?> toBuilder()
```
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
  - addLocalFieldsToBuilder
```
protected Variable.Builder<?> addLocalFieldsToBuilder(Variable.Builder<? extends Variable.Builder<?>> builder)
```
  - builder
```
public static Variable.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 Variable

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

permitCaching

hashCode

ncfile

spiObject

dimensions

attributes

proxyReader

shape

isVariableLength

elementSize

dataType

cache

Constructor Detail

Variable

Method Detail

findDimensionIndex

getDatasetLocation

getDataType

getArrayType

getDescription

getDimensions

getDimensionSet

getDimension

getDimensionsString

getElementSize

getEnumTypedef

getFileTypeId

getFullName

getNetcdfFile

getParentGroup

getParentStructure

getRanges

getRank

getShape

getShape

getShapeAsSection

getSection

getShortName

getSize

getUnitsString

isCoordinateVariable

isMemberOfStructure

isMetadata

isScalar

isUnlimited

isVariableLength

lookupEnumString

section

section

slice

reduce

readToStream

read

read

read

read

read

readScalarByte

readScalarShort

readScalarInt

readScalarLong

readScalarFloat

readScalarDouble

readScalarString

_read

readArray

_read

readArray

_readScalarData

reallyRead

proxyReadArray

reallyRead

proxyReadArray