Variable (NetCDF-Java CDM Public API v5.5.4-SNAPSHOT)

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

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, java.lang.Iterable<Attribute>, AttributeContainer, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

Structure, VariableDS
```
public class Variable
extends ucar.nc2.CDMNode
implements VariableSimpleIF, ProxyReader, AttributeContainer
```
A Variable is a logical container for data. It has a dataType, a set of Dimensions that define its array shape, and optionally 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.
Immutable if setImmutable() was called. TODO Variable will be immutable in 6. TODO Variable will not implement AttributeContainer in 6, use Variable.attributes(). TODO Variable will not extend CDMNode in 6.

See Also:

Array, DataType

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Variable.Builder<T extends Variable.Builder<T>>
A builder for Variables.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Variable.Builder<T extends Variable.Builder<T>>` A builder for Variables.

Field Summary

Fields
Modifier and Type Field and Description

static int defaultCoordsSizeToCache

static int defaultSizeToCache

static boolean permitCaching
Globally permit or prohibit caching.

Fields
Modifier and Type	Field and Description
`static int`	`defaultCoordsSizeToCache`
`static int`	`defaultSizeToCache`
`static boolean`	`permitCaching` Globally permit or prohibit caching.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
`void`	`createNewCache()` Create a new data cache, use this when you dont want to share the cache.
`boolean`	`equals(java.lang.Object oo)` Instances which have same content are equal.
`Attribute`	`findAttribute(java.lang.String name)` Find the attribute by name, return null if not exist
`java.lang.String`	`findAttributeString(java.lang.String attName, java.lang.String defaultValue)` Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
`int`	`findDimensionIndex(java.lang.String name)` Find the index of the named Dimension in this Variable.
`java.lang.String`	`getDatasetLocation()` The location of the dataset this belongs to.
`DataType`	`getDataType()` Get the data type of the Variable.
`java.lang.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.
`java.lang.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()
`java.lang.String`	`getFileTypeId()`
`java.lang.String`	`getFullName()` Get the full name of this Variable.
`java.lang.String`	`getNameAndDimensions()` Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
`java.lang.String`	`getNameAndDimensions(boolean strict)` Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
`void`	`getNameAndDimensions(java.util.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.
`Structure`	`getParentStructure()` Get its parent structure, or null if not in structure Not deprecated.
`com.google.common.collect.ImmutableList<Range>`	`getRanges()` Get shape as a List of Range objects.
`int`	`getRank()` Get the number of dimensions of the Variable, aka the rank.
`int[]`	`getShape()` Get the shape: length of Variable in each dimension.
`int`	`getShape(int index)` Get the size of the ith dimension
`Section`	`getShapeAsSection()` Get shape as a Section object.
`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.
`java.lang.Object`	`getSPobject()` Get immutable service provider opaque object.
`java.lang.String`	`getUnitsString()` Get the Unit String for the Variable.
`boolean`	`hasCachedData()` Has data been read and cached.
`int`	`hashCode()` Override Object.hashCode() to implement equals.
`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()` Test for presence of parent Structure.
`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.
`java.lang.String`	`lookupEnumString(int val)` Lookup the enum string for this value.
`Array`	`read()` Read all the data for this Variable and return a memory resident Array.
`Array`	`read(int[] origin, int[] shape)` Read a section of the data for this Variable and return a memory resident Array.
`Array`	`read(java.util.List<Range> ranges)` Read a section of the data for this Variable from the netcdf file and return a memory resident Array.
`Array`	`read(Section section)` Read a section of the data for this Variable from the netcdf file and return a memory resident Array.
`Array`	`read(java.lang.String sectionSpec)` Read data section specified by a "section selector", and return a memory resident Array.
`byte`	`readScalarByte()` Get the value as a byte for a scalar Variable.
`double`	`readScalarDouble()` Get the value as a double for a scalar Variable.
`float`	`readScalarFloat()` Get the value as a float for a scalar Variable.
`int`	`readScalarInt()` Get the value as a int for a scalar Variable.
`long`	`readScalarLong()` Get the value as a long for a scalar Variable.
`short`	`readScalarShort()` Get the value as a short for a scalar Variable.
`java.lang.String`	`readScalarString()` Get the value as a String for a scalar Variable.
`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.
`Variable`	`reduce(java.util.List<Dimension> dims)` Create a new Variable that is a logical view of this Variable, by eliminating the specified dimension(s) of length 1.
`Variable`	`section(java.util.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.
`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.
`java.lang.String`	`toString()`
`java.lang.String`	`toStringDebug()` String representation of Variable and its attributes.

Methods inherited from class ucar.nc2.CDMNode
getShortName

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

Methods inherited from interface ucar.nc2.VariableSimpleIF
getShortName

Methods inherited from interface ucar.nc2.AttributeContainer
filter, findAttributeDouble, findAttributeIgnoreCase, findAttributeInteger, getName, hasAttribute, hasAttributeIgnoreCase, isEmpty, iterator

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

- Field Detail
  - defaultCoordsSizeToCache
```
public static int defaultCoordsSizeToCache
```
  - defaultSizeToCache
```
public static int defaultSizeToCache
```
  - 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.
- Method Detail
  - attributes
```
public AttributeContainer attributes()
```
    The attributes contained by this Variable.
    
    Specified by:
    
    attributes in interface VariableSimpleIF
  - 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"
  - compareTo
```
public int compareTo(VariableSimpleIF o)
```
    Sort by name
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<VariableSimpleIF>
  - createNewCache
```
public void createNewCache()
```
    Create a new data cache, use this when you dont want to share the cache.
  - equals
```
public boolean equals(java.lang.Object oo)
```
    Instances which have same content are equal.
    
    Overrides:
    
    equals in class java.lang.Object
  - findAttribute
```
@Nullable
public Attribute findAttribute(java.lang.String name)
```
    Find the attribute by name, return null if not exist
    
    Specified by:
    
    findAttribute in interface AttributeContainer
  - findAttributeString
```
public java.lang.String findAttributeString(java.lang.String attName,
                                            java.lang.String defaultValue)
```
    Find a String-valued Attribute by name (ignore case), return the String value of the Attribute.
    
    Specified by:
    
    findAttributeString in interface AttributeContainer
    
    Returns:
    
    the attribute value, or defaultValue if not found
  - findDimensionIndex
```
public int findDimensionIndex(java.lang.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 java.lang.String getDatasetLocation()
```
    The location of the dataset this belongs to. Labeling purposes only.
  - getDataType
```
public DataType getDataType()
```
    Get the data type of the Variable.
    
    Specified by:
    
    getDataType in interface VariableSimpleIF
    
    Returns:
    
    Variable's data type
  - getDescription
```
public java.lang.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.
  - 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.
  - 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
    
    Returns:
    
    List, will be ImmutableList in ver 6.
  - getDimensionsString
```
public java.lang.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 don't 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
```
public EnumTypedef getEnumTypedef()
```
    Get the EnumTypedef, only use if getDataType.isEnum()
    
    Returns:
    
    enumTypedef or null if !getDataType.isEnum()
  - getFileTypeId
```
@Nullable
public java.lang.String getFileTypeId()
```
  - getFullName
```
public java.lang.String getFullName()
```
    Get the full name of this Variable. Certain characters are backslash escaped (see NetcdfFiles.getFullName(Variable)) Not deprecated.
    
    Specified by:
    
    getFullName in interface VariableSimpleIF
    
    Overrides:
    
    getFullName in class ucar.nc2.CDMNode
    
    Returns:
    
    full name with backslash escapes
  - getNameAndDimensions
```
public java.lang.String getNameAndDimensions()
```
    Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
    
    Returns:
    
    display name plus the dimensions
  - getNameAndDimensions
```
public java.lang.String getNameAndDimensions(boolean strict)
```
    Get the display name plus the dimensions, eg 'float name(dim1, dim2)'
    
    Parameters:
    
    strict - strictly comply with ncgen syntax, with name escaping. otherwise, get extra info, no escaping
    
    Returns:
    
    display name plus the dimensions
  - getNameAndDimensions
```
public void getNameAndDimensions(java.util.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
  - getNetcdfFile
```
@Nullable
public NetcdfFile getNetcdfFile()
```
    Get the NetcdfFile that this variable is contained in. May be null.
  - getParentGroup
```
public Group getParentGroup()
```
    Get its containing Group. Not deprecated. LOOK if you relied on Group being set during construction, use getParentGroupOrRoot().
    
    Overrides:
    
    getParentGroup in class ucar.nc2.CDMNode
    
    Returns:
    
    parent Group
  - getParentStructure
```
@Nullable
public Structure getParentStructure()
```
    Get its parent structure, or null if not in structure Not deprecated.
    
    Overrides:
    
    getParentStructure in class ucar.nc2.CDMNode
    
    Returns:
    
    parent structure
  - getRanges
```
public com.google.common.collect.ImmutableList<Range> getRanges()
```
    Get shape as a 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
    
    Returns:
    
    Variable rank
  - 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
    
    Returns:
    
    int array whose length is the rank of this Variable and whose values equal the length of that Dimension.
  - getShape
```
public int getShape(int index)
```
    Get the size of the ith dimension
    
    Parameters:
    
    index - which dimension
    
    Returns:
    
    size of the ith dimension
  - getShapeAsSection
```
public Section getShapeAsSection()
```
    Get shape as a Section object.
    
    Returns:
    
    Section containing List, one for each Dimension.
  - 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.
  - getSizeToCache
```
public int getSizeToCache()
```
    If total data size is less than SizeToCache in bytes, then cache.
    
    Returns:
    
    size at which caching happens
  - getSPobject
```
public java.lang.Object getSPobject()
```
    Get immutable service provider opaque object.
  - getUnitsString
```
public java.lang.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.
  - hasCachedData
```
public boolean hasCachedData()
```
    Has data been read and cached. Use only on a Variable, not a subclass.
    
    Returns:
    
    true if data is read and cached
  - hashCode
```
public int hashCode()
```
    Override Object.hashCode() to implement equals.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - isCaching
```
public boolean isCaching()
```
    Will this Variable be cached when read. Set externally, or calculated based on total size < sizeToCache.
    This will always return false if caching isn't permitted.
    
    Returns:
    
    true is caching
  - 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()
```
    Test for presence of parent Structure. Not deprecated.
    
    Overrides:
    
    isMemberOfStructure in class ucar.nc2.CDMNode
    
    Returns:
    
    true iff struct != null
  - isMetadata
```
public boolean isMetadata()
```
    Is this variable metadata?. True if its values need to be included explicitly in NcML output.
    
    Returns:
    
    true if Variable values need to be included in NcML
  - isScalar
```
public boolean isScalar()
```
    Whether this is a scalar Variable (rank == 0).
    
    Returns:
    
    true if Variable has 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 java.lang.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
  - read
```
public Array read()
           throws java.io.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.
    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:
    
    java.io.IOException
  - read
```
public Array read(int[] origin,
                  int[] shape)
           throws java.io.IOException,
                  InvalidRangeException
```
    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:
    
    java.io.IOException
    
    InvalidRangeException
  - read
```
public Array read(java.util.List<Range> ranges)
           throws java.io.IOException,
                  InvalidRangeException
```
    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:
    
    java.io.IOException - if error
    
    InvalidRangeException - if ranges is invalid
    
    See Also:
    
    read(Section)
  - read
```
public Array read(Section section)
           throws java.io.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.
    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 an 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:
    
    java.io.IOException - if error
    
    InvalidRangeException - if section is invalid
  - read
```
public Array read(java.lang.String sectionSpec)
           throws java.io.IOException,
                  InvalidRangeException
```
    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:
    
    java.io.IOException
    
    InvalidRangeException
    
    See Also:
    
    for sectionSpec syntax
  - readScalarByte
```
public byte readScalarByte()
                    throws java.io.IOException
```
    Get the value as a byte for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    ForbiddenConversionException - if data type not convertible to byte
  - readScalarDouble
```
public double readScalarDouble()
                        throws java.io.IOException
```
    Get the value as a double for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    ForbiddenConversionException - if data type not convertible to double
  - readScalarFloat
```
public float readScalarFloat()
                      throws java.io.IOException
```
    Get the value as a float for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    ForbiddenConversionException - if data type not convertible to float
  - readScalarInt
```
public int readScalarInt()
                  throws java.io.IOException
```
    Get the value as a int for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    ForbiddenConversionException - if data type not convertible to int
  - readScalarLong
```
public long readScalarLong()
                    throws java.io.IOException
```
    Get the value as a long for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable
    
    ForbiddenConversionException - if data type not convertible to long
  - readScalarShort
```
public short readScalarShort()
                      throws java.io.IOException
```
    Get the value as a short for a scalar Variable. May also be one-dimensional of length 1.
    
    Throws:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar Variable or one-dimensional of length 1.
    
    ForbiddenConversionException - if data type not convertible to short
  - readScalarString
```
public java.lang.String readScalarString()
                                  throws java.io.IOException
```
    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:
    
    java.io.IOException - if theres an IO Error
    
    java.lang.UnsupportedOperationException - if not a scalar or one-dimensional.
    
    java.lang.ClassCastException - if data type not DataType.STRING or DataType.CHAR.
  - readToStream
```
public long readToStream(Section section,
                         java.io.OutputStream out)
                  throws java.io.IOException,
                         InvalidRangeException
```
    Read variable data to a stream. Support for NcStreamWriter.
    
    Throws:
    
    java.io.IOException
    
    InvalidRangeException
  - reallyRead
```
public Array reallyRead(Variable client,
                        CancelTask cancelTask)
                 throws java.io.IOException
```
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    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
```
    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:
    
    Array
    
    Throws:
    
    java.io.IOException - on error
    
    InvalidRangeException - if section has incorrect rank or illegal shape.
  - reduce
```
public Variable reduce(java.util.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.
  - section
```
public Variable section(java.util.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 don't 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
  - toBuilder
```
public Variable.Builder<?> toBuilder()
```
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toStringDebug
```
public java.lang.String toStringDebug()
```
    String representation of Variable and its attributes.

Class Variable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class ucar.nc2.CDMNode

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.nc2.VariableSimpleIF

Methods inherited from interface ucar.nc2.AttributeContainer

Methods inherited from interface java.lang.Iterable

Field Detail

defaultCoordsSizeToCache

defaultSizeToCache

permitCaching

Method Detail

attributes

builder

compareTo

createNewCache

equals

findAttribute

findAttributeString

findDimensionIndex

getDatasetLocation

getDataType

getDescription

getDimension

getDimensions

getDimensionsString

getElementSize

getEnumTypedef

getFileTypeId

getFullName

getNameAndDimensions

getNameAndDimensions

getNameAndDimensions

getNetcdfFile

getParentGroup

getParentStructure

getRanges

getRank

getShape

getShape

getShapeAsSection

getSize

getSizeToCache

getSPobject

getUnitsString

hasCachedData

hashCode

isCaching

isCoordinateVariable

isMemberOfStructure

isMetadata

isScalar

isUnlimited

isVariableLength

lookupEnumString

read

read

read

read

read

readScalarByte

readScalarDouble

readScalarFloat

readScalarInt

readScalarLong

readScalarShort

readScalarString

readToStream

reallyRead

reallyRead

reduce

section

section

slice

toBuilder

toString

toStringDebug