ucar.nc2

Class VariableSimpleAdapter

java.lang.Object

ucar.nc2.VariableSimpleAdapter

All Implemented Interfaces:

Comparable<VariableSimpleIF>, VariableSimpleIF

public class VariableSimpleAdapter
extends Object
implements VariableSimpleIF

Adapt a StructureMembers.Member into a VariableSimpleIF.

Since:

Apr 20, 2008

Author:

caron

Constructor Summary

Constructors

Constructor and Description
VariableSimpleAdapter(StructureMembers.Member m) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(VariableSimpleIF o) Sort by name
static List<VariableSimpleIF>	convert(StructureMembers sm)
Attribute	findAttributeIgnoreCase(String attName) find the attribute for the variable with the given name, ignoring case.
List<Attribute>	getAttributes() Attributes for the variable.
DataType	getDataType() Variable's data type
String	getDescription() description of the Variable
List<Dimension>	getDimensions() Dimension List.
String	getFullName() full, backslash escaped name of the data Variable
String	getName() Name of the data Variable.
int	getRank() Variable rank
int[]	getShape() Variable shape
String	getShortName() short name of the data Variable
String	getUnitsString() Units of the Variable.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableSimpleAdapter

public VariableSimpleAdapter(StructureMembers.Member m)

Constructor

Parameters:

m - adapt this Member

Method Detail

convert

public static List<VariableSimpleIF> convert(StructureMembers sm)

getFullName

public String getFullName()

Description copied from interface: VariableSimpleIF

full, backslash escaped name of the data Variable

Specified by:

getFullName in interface VariableSimpleIF

Returns:

full, backslash escaped name of the data Variable

getName

public String getName()

Description copied from interface: VariableSimpleIF

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().

Specified by:

getName in interface VariableSimpleIF

Returns:

name of the data Variable

getShortName

public String getShortName()

Description copied from interface: VariableSimpleIF

short name of the data Variable

Specified by:

getShortName in interface VariableSimpleIF

Returns:

short name of the data Variable

getDataType

public DataType getDataType()

Description copied from interface: VariableSimpleIF

Variable's data type

Specified by:

getDataType in interface VariableSimpleIF

Returns:

Variable's data type

getDescription

public String getDescription()

Description copied from interface: VariableSimpleIF

description of the Variable

Specified by:

getDescription in interface VariableSimpleIF

Returns:

description of the Variable, or null if none.

getUnitsString

public String getUnitsString()

Description copied from interface: VariableSimpleIF

Units of the Variable. These should be udunits compatible if possible

Specified by:

getUnitsString in interface VariableSimpleIF

Returns:

Units of the Variable, or null if none.

getRank

public int getRank()

Description copied from interface: VariableSimpleIF

Variable rank

Specified by:

getRank in interface VariableSimpleIF

Returns:

Variable rank

getShape

public int[] getShape()

Description copied from interface: VariableSimpleIF

Variable shape

Specified by:

getShape in interface VariableSimpleIF

Returns:

Variable shape

getDimensions

public List<Dimension> getDimensions()

Description copied from interface: VariableSimpleIF

Dimension List. empty for a scalar variable.

Specified by:

getDimensions in interface VariableSimpleIF

Returns:

List of ucar.nc2.Dimension

getAttributes

public List<Attribute> getAttributes()

Description copied from interface: VariableSimpleIF

Attributes for the variable.

Specified by:

getAttributes in interface VariableSimpleIF

Returns:

List of type ucar.nc2.Attribute

findAttributeIgnoreCase

public Attribute findAttributeIgnoreCase(String attName)

Description copied from interface: VariableSimpleIF

find the attribute for the variable with the given name, ignoring case.

Specified by:

findAttributeIgnoreCase in interface VariableSimpleIF

Parameters:

attName - attribute name

Returns:

the attribute for the variable with the given name, or null if not found.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(VariableSimpleIF o)

Sort by name

Specified by:

compareTo in interface Comparable<VariableSimpleIF>