Package ucar.nc2

Interface VariableSimpleIF

All Superinterfaces:
Comparable<VariableSimpleIF>
All Known Subinterfaces:
VariableIF
All Known Implementing Classes:
CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, Sequence, SequenceDS, Structure, StructureDS, StructurePseudo2Dim, StructurePseudoDS, Variable, VariableDS, VariableSimpleAdapter, VariableSimpleImpl
public interface VariableSimpleIF extends Comparable<VariableSimpleIF>
A lightweight abstraction of a Variable.

  • Method Details

    • getName

      @Deprecated String getName()
      Deprecated.
      use getFullName or getShortName
      Name of the data Variable. Not that this is technically ambiguous v-a-v short or full name; however, since this is a Variable interface, one must assume that it is intended to be getFullName().
      Returns:
      name of the data Variable

    • getFullName

      String getFullName()
      full, backslash escaped name of the data Variable
      Returns:
      full, backslash escaped name of the data Variable

    • getShortName

      String getShortName()
      short name of the data Variable
      Returns:
      short name of the data Variable

    • getDescription

      String getDescription()
      description of the Variable
      Returns:
      description of the Variable, or null if none.

    • getUnitsString

      String getUnitsString()
      Units of the Variable. These should be udunits compatible if possible
      Returns:
      Units of the Variable, or null if none.

    • getRank

      int getRank()
      Variable rank
      Returns:
      Variable rank

    • getShape

      int[] getShape()
      Variable shape
      Returns:
      Variable shape

    • getDimensions

      List<Dimension> getDimensions()
      Dimension List. empty for a scalar variable.
      Returns:
      List of ucar.nc2.Dimension, ImmutableList in ver6

    • getDataType

      DataType getDataType()
      Variable's data type
      Returns:
      Variable's data type

    • attributes

      AttributeContainer attributes()
      Attributes for the variable.

    • getAttributes

      @Deprecated List<Attribute> getAttributes()
      Deprecated.
      Use attributes()
      Attributes for the variable.
      Returns:
      List of type ucar.nc2.Attribute

    • findAttributeIgnoreCase

      @Deprecated Attribute findAttributeIgnoreCase(String name)
      Deprecated.
      Use attributes()
      find the attribute for the variable with the given name, ignoring case.
      Parameters:
      name - attribute name
      Returns:
      the attribute for the variable with the given name, or null if not found.