ucar.nc2.dataset

Class CoordinateAxis

java.lang.Object

ucar.nc2.Variable

ucar.nc2.dataset.VariableDS

ucar.nc2.dataset.CoordinateAxis

All Implemented Interfaces:

Comparable<VariableSimpleIF>, IsMissingEvaluator, EnhanceScaleMissingUnsigned, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

CoordinateAxis1D, CoordinateAxis2D

public class CoordinateAxis
extends VariableDS

A Variable that specifies one of the coordinates of a CoordinateSystem.

 Mathematically it is a scalar function F from index space to S:
  F:D -> S
  where D is a product set of dimensions (aka index space), and S is the set of reals (R) or Strings.
 

If its element type is CHAR, it is considered a string-valued Coordinate Axis and rank is reduced by one, since the outermost dimension is considered the string length: v(i, j, .., strlen). If its element type is String, it is a string-valued Coordinate Axis. Otherwise it is numeric-valued, and isNumeric() is true.

A CoordinateAxis is optionally marked as georeferencing with an AxisType. It should have a units string and optionally a description string.

A Structure cannot be a CoordinateAxis, although members of Structures can. TODO make Immutable in ver7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinateAxis.AxisComparator
static class	CoordinateAxis.Builder<T extends CoordinateAxis.Builder<T>>

Nested classes/interfaces inherited from class ucar.nc2.Variable

Variable.Cache

Field Summary

Fields

Modifier and Type	Field and Description
protected AxisType	axisType
protected String	boundaryRef
protected boolean	isContiguous
protected NetcdfDataset	ncd
protected String	positive

Fields inherited from class ucar.nc2.dataset.VariableDS

orgDataType, orgName, orgVar

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, dimensions, elementSize, hashCode, isVariableLength, ncfile, permitCaching, proxyReader, shape, spiObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoordinateAxis(CoordinateAxis.Builder<?> builder, Group parentGroup)

Method Summary

Modifier and Type	Method and Description
protected CoordinateAxis.Builder<?>	addLocalFieldsToBuilder(CoordinateAxis.Builder<? extends CoordinateAxis.Builder<?>> b)
static CoordinateAxis.Builder<?>	builder() Get a Builder of CoordinateAxis
boolean	equals(Object oo) Instances which have same content are equal.
static CoordinateAxis.Builder<?>	fromVariableDS(VariableDS.Builder<?> vdsBuilder) Create a coordinate axis from an existing VariableDS.Builder.
AxisType	getAxisType() Get type of axis
String	getBoundaryRef() Deprecated. do not use.
Calendar	getCalendarFromAttribute() Figure out what calendar to use from the axis' attributes.
static Calendar	getCalendarFromAttribute(NetcdfDataset ncd, AttributeContainer attributes) Figure out what calendar to use from the given attributes.
void	getInfo(Formatter buf) Get a string representation
double	getMaxValue() Deprecated. use GridAxis1D.getMaxValue()
double	getMinValue() Deprecated. use GridAxis1D.getMinValue()
String	getPositive() Deprecated. use GridCoordSys.getPositive()
String	getUnitsString() Get the Unit String for the Variable.
int	hashCode() Override Object.hashCode() to implement equals.
boolean	isContiguous() Deprecated. use GridAxis1D.isContiguous()
boolean	isIndependentCoordinate() Deprecated. use NetcdfDataset.isIndependentCoordinate(CoordinateAxis)
boolean	isInterval() Deprecated. use GridAxis1D.isInterval()
boolean	isNumeric() Does the axis have numeric values?
CoordinateAxis.Builder<?>	toBuilder() Turn into a mutable Builder.

Methods inherited from class ucar.nc2.dataset.VariableDS

_read, _read, addLocalFieldsToBuilder, applyScaleOffset, applyScaleOffset, convert, convertArray, convertMissing, convertMissing, convertNeeded, convertUnsigned, convertUnsigned, fromVar, getCoordinateSystems, getDatasetLocation, getDescription, getEnhanceMode, getFillValue, getMissingDataArray, getMissingValues, getNetcdfFile, getOffset, getOriginalArrayType, getOriginalDataType, getOriginalName, getOriginalVariable, getScaledOffsetType, getScaleFactor, getSignedness, getUnsignedConversionType, getValidMax, getValidMin, hasFillValue, hasMissing, hasMissingValue, hasScaleOffset, hasValidData, isFillValue, isInvalidData, isMissing, isMissingValue, lookupEnumString, proxyReadArray, proxyReadArray, readArray, readArray, readToStream, reallyRead, reallyRead, setCaching, showScaleMissingProxy, toString, toStringDebug

Methods inherited from class ucar.nc2.Variable

_readScalarData, addLocalFieldsToBuilder, attributes, compareTo, extraInfo, findAttribute, findAttributeString, findDimensionIndex, getArrayType, getDataType, getDimension, getDimensions, getDimensionSet, getDimensionsString, getElementSize, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getParentGroup, getParentStructure, getRanges, getRank, getSection, getShape, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, invalidateCache, isCaching, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, reduce, resetShape, section, section, setCachedData, slice, writeCDL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

getFullName, getParentGroup, getShortName

Field Detail

ncd

protected final NetcdfDataset ncd

axisType

protected final AxisType axisType

positive

protected final String positive

boundaryRef

protected final String boundaryRef

isContiguous

protected boolean isContiguous

Constructor Detail

CoordinateAxis

protected CoordinateAxis(CoordinateAxis.Builder<?> builder,
                         Group parentGroup)

Method Detail

fromVariableDS

public static CoordinateAxis.Builder<?> fromVariableDS(VariableDS.Builder<?> vdsBuilder)

Create a coordinate axis from an existing VariableDS.Builder.

Parameters:

vdsBuilder - an existing Variable in dataset.

Returns:

CoordinateAxis or one of its subclasses (CoordinateAxis1D, CoordinateAxis2D, or CoordinateAxis1DTime).

getAxisType

@Nullable
public AxisType getAxisType()

Get type of axis

getUnitsString

public String getUnitsString()

Description copied from class: Variable

Get the Unit String for the Variable. Looks for the CDM.UNITS attribute value

Specified by:

getUnitsString in interface VariableEnhanced

Specified by:

getUnitsString in interface VariableSimpleIF

Overrides:

getUnitsString in class VariableDS

Returns:

unit string, or null if not found.

isNumeric

public boolean isNumeric()

Does the axis have numeric values?

Returns:

true if the CoordAxis is numeric, false if its string valued ("nominal").

isContiguous

@Deprecated
public boolean isContiguous()

Deprecated. use GridAxis1D.isContiguous()

If the edges are contiguous or disjoint Caution: many datasets do not explicitly specify this info, this is often a guess; default is true.

Returns:

true if the edges are contiguous or false if disjoint. Assumed true unless set otherwise.

isInterval

@Deprecated
public boolean isInterval()

Deprecated. use GridAxis1D.isInterval()

An interval coordinate consists of two numbers, bound1 and bound2. The coordinate value must lie between them, but otherwise is somewhat arbitrary. If not interval, then it has one number, the coordinate value.

Returns:

true if its an interval coordinate.

isIndependentCoordinate

@Deprecated
public boolean isIndependentCoordinate()

Deprecated. use NetcdfDataset.isIndependentCoordinate(CoordinateAxis)

getPositive

@Deprecated
public String getPositive()

Deprecated. use GridCoordSys.getPositive()

Get the direction of increasing values, used only for vertical Axes.

Returns:

POSITIVE_UP, POSITIVE_DOWN, or null if unknown.

getBoundaryRef

@Deprecated
public String getBoundaryRef()

Deprecated. do not use.

The name of this coordinate axis' boundary variable

Returns:

the name of this coordinate axis' boundary variable, or null if none.

getMinValue

@Deprecated
public double getMinValue()

Deprecated. use GridAxis1D.getMinValue()

The smallest coordinate value. Only call if isNumeric.

Returns:

the minimum coordinate value

getMaxValue

@Deprecated
public double getMaxValue()

Deprecated. use GridAxis1D.getMaxValue()

The largest coordinate value. Only call if isNumeric.

Returns:

the maximum coordinate value

getInfo

public void getInfo(Formatter buf)

Get a string representation

Parameters:

buf - place info here

equals

public boolean equals(Object oo)

Instances which have same content are equal.

Overrides:

equals in class Variable

hashCode

public int hashCode()

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class Variable

getCalendarFromAttribute

public Calendar getCalendarFromAttribute()

Figure out what calendar to use from the axis' attributes.

getCalendarFromAttribute

public static Calendar getCalendarFromAttribute(@Nullable
                                                NetcdfDataset ncd,
                                                AttributeContainer attributes)

Figure out what calendar to use from the given attributes.

toBuilder

public CoordinateAxis.Builder<?> toBuilder()

Description copied from class: Variable

Turn into a mutable Builder. Can use toBuilder().build() to copy.

Overrides:

toBuilder in class VariableDS

addLocalFieldsToBuilder

protected CoordinateAxis.Builder<?> addLocalFieldsToBuilder(CoordinateAxis.Builder<? extends CoordinateAxis.Builder<?>> b)

builder

public static CoordinateAxis.Builder<?> builder()

Get a Builder of CoordinateAxis