ucar.nc2
Interface VariableSimpleIF

All Superinterfaces:

java.lang.Comparable<VariableSimpleIF>

All Known Subinterfaces:

RadialDatasetSweep.RadialVariable, VariableEnhanced, VariableIF

All Known Implementing Classes:

CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, Sequence, SequenceDS, Structure, StructureDS, StructurePseudo, StructurePseudo2Dim, StructurePseudoDS, Variable, VariableDS, VariableSimpleAdapter, VariableSimpleSubclass

public interface VariableSimpleIF
extends java.lang.Comparable<VariableSimpleIF>

A lightweight abstractions of a Variable.

Author:

caron

See Also:

FeatureDataset

Method Summary

Attribute	findAttributeIgnoreCase(java.lang.String name) find the attribute for the variable with the given name, ignoring case.
java.util.List<Attribute>	getAttributes() Attributes for the variable.
DataType	getDataType() Variable's data type
java.lang.String	getDescription() description of the Variable
java.util.List<Dimension>	getDimensions() Dimension List.
java.lang.String	getName() full name of the data Variable
int	getRank() Variable rank
int[]	getShape() Variable shape
java.lang.String	getShortName() short name of the data Variable
java.lang.String	getUnitsString() Units of the Variable.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

full name of the data Variable

Returns:

full name of the data Variable

getShortName

java.lang.String getShortName()

short name of the data Variable

Returns:

short name of the data Variable

getDescription

java.lang.String getDescription()

description of the Variable

Returns:

description of the Variable, or null if none.

getUnitsString

java.lang.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

java.util.List<Dimension> getDimensions()

Dimension List. empty for a scalar variable.

Returns:

List of ucar.nc2.Dimension

getDataType

DataType getDataType()

Variable's data type

Returns:

Variable's data type

getAttributes

java.util.List<Attribute> getAttributes()

Attributes for the variable.

Returns:

List of type ucar.nc2.Attribute

findAttributeIgnoreCase

Attribute findAttributeIgnoreCase(java.lang.String name)

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.