ucar.nc2.dataset

Interface Enhancements

All Known Subinterfaces:

VariableEnhanced

All Known Implementing Classes:

CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, SequenceDS, StructureDS, StructurePseudo2Dim, StructurePseudoDS, VariableDS

public interface Enhancements

A Variable decorator that handles Coordinates Systems and "standard attributes" and adds them to the object model. Specifically, this:

• adds a list of CoordinateSystem.
• adds unitString from the standard attribute units
• adds description from the standard attributes long_name, description or title

if those "standard attributes" are present.

Method Summary

Modifier and Type	Method and Description
void	addCoordinateSystem(CoordinateSystem cs) Add a CoordinateSystem to the dataset.
java.util.List<CoordinateSystem>	getCoordinateSystems() Get the list of Coordinate Systems for this Variable.
java.lang.String	getDescription() Get the description of the Variable, or null if none.
java.lang.String	getUnitsString() Get the Unit String for the Variable, or null if none.
void	removeCoordinateSystem(CoordinateSystem cs) Remove a CoordinateSystem from the dataset.

Method Detail

getDescription

java.lang.String getDescription()

Get the description of the Variable, or null if none.

Returns:

description of the Variable, or null

getUnitsString

java.lang.String getUnitsString()

Get the Unit String for the Variable, or null if none.

Returns:

Unit String for the Variable, or null

getCoordinateSystems

java.util.List<CoordinateSystem> getCoordinateSystems()

Get the list of Coordinate Systems for this Variable.

Returns:

list of type CoordinateSystem; may be empty but not null.

addCoordinateSystem

void addCoordinateSystem(CoordinateSystem cs)

Add a CoordinateSystem to the dataset.

Parameters:

cs - add this Coordinate System

removeCoordinateSystem

void removeCoordinateSystem(CoordinateSystem cs)

Remove a CoordinateSystem from the dataset.

Parameters:

cs - remove this coordinate system