ucar.nc2

Class VariableSimpleImpl

java.lang.Object

ucar.nc2.VariableSimpleImpl

All Implemented Interfaces:

Comparable<VariableSimpleIF>, VariableSimpleIF

public class VariableSimpleImpl
extends Object
implements VariableSimpleIF

Implementation of VariableSimpleIF

Since:

6/10/14

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
VariableSimpleImpl	add(Attribute att)
static VariableSimpleImpl	changeShape(VariableSimpleIF proxy, List<Dimension> dims)
int	compareTo(VariableSimpleIF o)
Attribute	findAttributeIgnoreCase(String name) 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.
static VariableSimpleImpl	makeScalar(String name, String desc, String units, DataType dt)
static VariableSimpleImpl	makeString(String name, String desc, String units, int str_len)

Methods inherited from class java.lang.Object

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

Method Detail

makeScalar

public static VariableSimpleImpl makeScalar(String name,
                            String desc,
                            String units,
                            DataType dt)

makeString

public static VariableSimpleImpl makeString(String name,
                            String desc,
                            String units,
                            int str_len)

changeShape

public static VariableSimpleImpl changeShape(VariableSimpleIF proxy,
                             List<Dimension> dims)

add

public VariableSimpleImpl add(Attribute att)

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

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

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

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

getDataType

public DataType getDataType()

Description copied from interface: VariableSimpleIF

Variable's data type

Specified by:

getDataType in interface VariableSimpleIF

Returns:

Variable's data type

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 name)

Description copied from interface: VariableSimpleIF

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

Specified by:

findAttributeIgnoreCase in interface VariableSimpleIF

Parameters:

name - attribute name

Returns:

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

compareTo

public int compareTo(VariableSimpleIF o)

Specified by:

compareTo in interface Comparable<VariableSimpleIF>