ucar.nc2.ft2.coverage

Class Coverage

java.lang.Object

ucar.nc2.ft2.coverage.Coverage

All Implemented Interfaces:

Comparable<VariableSimpleIF>, IsMissingEvaluator, VariableSimpleIF

public class Coverage
extends Object
implements VariableSimpleIF, IsMissingEvaluator

Coverage - aka Grid or GeoGrid. Immutable after setCoordSys() is called.

Since:

7/11/2015

Field Summary

Fields

Modifier and Type	Field and Description
protected CoverageReader	reader
protected Object	user

Constructor Summary

Constructors

Constructor and Description
Coverage(Coverage from, CoverageCoordSys coordSysSubset)
Coverage(String name, DataType dataType, Iterable<Attribute> atts, String coordSysName, String units, String description, CoverageReader reader, Object user)

Method Summary

Modifier and Type	Method and Description
AttributeContainer	attributes() Attributes for the variable.
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.
CoverageCoordSys	getCoordSys()
String	getCoordSysName()
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	getIndependentAxisNamesOrdered()
String	getName() Name of the data Variable.
int	getRank() Variable rank
int[]	getShape() Variable shape
String	getShortName() short name of the data Variable
long	getSizeInBytes()
String	getUnitsString() Units of the Variable.
Object	getUserObject()
boolean	hasMissing() true if there may be missing data
boolean	isMissing(double val) if val is a missing data value
GeoReferencedArray	readData(SubsetParams subset)
String	toString()
void	toString(Formatter f, Indent indent)

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected final CoverageReader reader

user

protected final Object user

Constructor Detail

Coverage

public Coverage(String name,
                DataType dataType,
                Iterable<Attribute> atts,
                String coordSysName,
                String units,
                String description,
                CoverageReader reader,
                Object user)

Coverage

public Coverage(Coverage from,
                CoverageCoordSys coordSysSubset)

Method Detail

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

getDataType

public DataType getDataType()

Description copied from interface: VariableSimpleIF

Variable's data type

Specified by:

getDataType in interface VariableSimpleIF

Returns:

Variable's data type

attributes

public AttributeContainer attributes()

Description copied from interface: VariableSimpleIF

Attributes for the variable.

Specified by:

attributes in interface VariableSimpleIF

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.

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.

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.

getCoordSysName

public String getCoordSysName()

getUserObject

public Object getUserObject()

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(Formatter f,
                     Indent indent)

getCoordSys

@Nonnull
public CoverageCoordSys getCoordSys()

getSizeInBytes

public long getSizeInBytes()

getIndependentAxisNamesOrdered

public String getIndependentAxisNamesOrdered()

hasMissing

public boolean hasMissing()

Description copied from interface: IsMissingEvaluator

true if there may be missing data

Specified by:

hasMissing in interface IsMissingEvaluator

Returns:

true if there may be missing data

isMissing

public boolean isMissing(double val)

Description copied from interface: IsMissingEvaluator

if val is a missing data value

Specified by:

isMissing in interface IsMissingEvaluator

Parameters:

val - test this value

Returns:

true if val is missing data

readData

public GeoReferencedArray readData(SubsetParams subset)
                            throws IOException,
                                   InvalidRangeException

Throws:

IOException

InvalidRangeException

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

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, ImmutableList in ver6

compareTo

public int compareTo(@Nonnull
                     VariableSimpleIF o)

Specified by:

compareTo in interface Comparable<VariableSimpleIF>