ucar.nc2.ft.cover.impl

Class CoverageImpl

java.lang.Object

ucar.nc2.ft.cover.impl.CoverageImpl

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, IsMissingEvaluator, Coverage, NamedObject, VariableSimpleIF

public class CoverageImpl
extends java.lang.Object
implements Coverage

Coverage Implementation

Since:

12/25/12

Method Summary

Modifier and Type	Method and Description
int	compareTo(VariableSimpleIF o)
Attribute	findAttributeIgnoreCase(java.lang.String name) find the attribute for the variable with the given name, ignoring case.
java.lang.String	findAttValueIgnoreCase(java.lang.String attName, java.lang.String defaultValue) Convenience function; lookup Attribute value by name.
java.util.List<Attribute>	getAttributes() Attributes for the variable.
CoverageCS	getCoordinateSystem() get the Coverage's Coordinate System.
DataType	getDataType() Variable's data type
java.lang.String	getDescription() description of the Variable
java.util.List<Dimension>	getDimensions() Returns a List of Dimension containing the dimensions used by this Coverage.
java.lang.String	getFullName() full, backslash escaped name of the data Variable
java.lang.String	getInfo() human readable information about this Coverage.
java.lang.String	getName() 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.
boolean	hasMissing() true if there may be missing data
boolean	isMissing(double val) if val is missing data
Array	readData(CoverageCS.Subset subset) This reads an arbitrary data slice, returning the data in canonical order (rt-e-t-z-y-x).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

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

Specified by:

getName in interface VariableSimpleIF

Returns:

name of the data Variable

getFullName

public java.lang.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 java.lang.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 java.lang.String getDescription()

Description copied from interface: VariableSimpleIF

description of the Variable

Specified by:

getDescription in interface NamedObject

Specified by:

getDescription in interface VariableSimpleIF

Returns:

description of the Variable, or null if none.

getUnitsString

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

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

findAttValueIgnoreCase

public java.lang.String findAttValueIgnoreCase(java.lang.String attName,
                                               java.lang.String defaultValue)

Description copied from interface: Coverage

Convenience function; lookup Attribute value by name. Must be String valued

Specified by:

findAttValueIgnoreCase in interface Coverage

Parameters:

attName - name of the attribute

defaultValue - if not found, use this as the default

Returns:

Attribute string value, or default if not found.

getDimensions

public java.util.List<Dimension> getDimensions()

Description copied from interface: Coverage

Returns a List of Dimension containing the dimensions used by this Coverage. The dimension are put into canonical order: (rt, e, t, z, y, x). Only the x and y are required. If the Horizontal axes are 2D, the x and y dimensions are arbitrarily chosen to be gcs.getXHorizAxis().getDimension(1), gcs.getXHorizAxis().getDimension(0), respectively.

Specified by:

getDimensions in interface Coverage

Specified by:

getDimensions in interface VariableSimpleIF

Returns:

List with objects of type Dimension, in canonical order.

getCoordinateSystem

public CoverageCS getCoordinateSystem()

Description copied from interface: Coverage

get the Coverage's Coordinate System.

Specified by:

getCoordinateSystem in interface Coverage

Returns:

the Coverage's Coordinate System.

hasMissing

public boolean hasMissing()

Description copied from interface: Coverage

true if there may be missing data

Specified by:

hasMissing in interface IsMissingEvaluator

Specified by:

hasMissing in interface Coverage

Returns:

true if there may be missing data

isMissing

public boolean isMissing(double val)

Description copied from interface: Coverage

if val is missing data

Specified by:

isMissing in interface IsMissingEvaluator

Specified by:

isMissing in interface Coverage

Parameters:

val - test this value

Returns:

true if val is missing data

getInfo

public java.lang.String getInfo()

Description copied from interface: Coverage

human readable information about this Coverage.

Specified by:

getInfo in interface Coverage

Returns:

human readable information about this Coverage.

compareTo

public int compareTo(VariableSimpleIF o)

Specified by:

compareTo in interface java.lang.Comparable<VariableSimpleIF>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

readData

public Array readData(CoverageCS.Subset subset)
               throws java.io.IOException,
                      InvalidRangeException

Description copied from interface: Coverage

This reads an arbitrary data slice, returning the data in canonical order (rt-e-t-z-y-x). If any dimension does not exist, ignore it.

Specified by:

readData in interface Coverage

Parameters:

subset - subset that you want. Must be created through this.getCoordinateSystem().makeSubset()

Returns:

data[rt,e,t,z,y,x], eliminating missing or fixed dimension.

Throws:

java.io.IOException - on io error

InvalidRangeException