ucar.nc2.dataset

Class CoordinateAxis1DTime

java.lang.Object

ucar.nc2.Variable

ucar.nc2.dataset.VariableDS

ucar.nc2.dataset.CoordinateAxis

ucar.nc2.dataset.CoordinateAxis1D

ucar.nc2.dataset.CoordinateAxis1DTime

All Implemented Interfaces:

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

Deprecated.

use GridAxis1DTime

@Deprecated
public class CoordinateAxis1DTime
extends CoordinateAxis1D

A 1-dimensional Coordinate Axis representing Calendar time. Its coordinate values can be represented as Dates.

May use udunit dates, or ISO Strings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinateAxis1DTime.Builder<T extends CoordinateAxis1DTime.Builder<T>> Deprecated.

Nested classes/interfaces inherited from class ucar.nc2.dataset.CoordinateAxis

CoordinateAxis.AxisComparator

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

Variable.Cache

Field Summary

Fields inherited from class ucar.nc2.dataset.CoordinateAxis1D

coords, wasRead

Fields inherited from class ucar.nc2.dataset.CoordinateAxis

axisType, boundaryRef, isContiguous, ncd, 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	CoordinateAxis1DTime(CoordinateAxis1DTime.Builder<?> builder, Group parentGroup) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected CoordinateAxis1DTime.Builder<?>	addLocalFieldsToBuilder(CoordinateAxis1DTime.Builder<? extends CoordinateAxis1DTime.Builder<?>> b) Deprecated.
static CoordinateAxis1DTime.Builder<?>	builder() Deprecated. Get Builder for this class that allows subclassing.
static CoordinateAxis1DTime	factory(NetcdfDataset ncd, VariableDS org, Formatter errMessages) Deprecated.
int	findTimeIndexFromCalendarDate(CalendarDate d) Deprecated. Given a Date, find the corresponding time index on the time coordinate axis.
CalendarDate	getCalendarDate(int idx) Deprecated. Get the the ith CalendarDate.
CalendarDateRange	getCalendarDateRange() Deprecated. Get calendar date range
List<CalendarDate>	getCalendarDates() Deprecated. Get the list of datetimes in this coordinate as CalendarDate objects.
CalendarDate[]	getCoordBoundsDate(int i) Deprecated.
CalendarDate	getCoordBoundsMidpointDate(int i) Deprecated.
Date[]	getTimeDates() Deprecated. use getCalendarDates().
TimeUnit	getTimeResolution() Deprecated. only if isRegular() LOOK REDO
boolean	hasCalendarDate(CalendarDate date) Deprecated. See if the given CalendarDate appears as a coordinate
boolean	isNumeric() Deprecated. Does the axis have numeric values?
protected void	readValues() Deprecated.
CoordinateAxis1DTime	section(Range r) Deprecated. Create a new CoordinateAxis1D as a section of this CoordinateAxis1D.
CoordinateAxis1DTime.Builder<?>	toBuilder() Deprecated. Turn into a mutable Builder.

Methods inherited from class ucar.nc2.dataset.CoordinateAxis1D

addLocalFieldsToBuilder, correctLongitudeWrap, findCoordElement, findCoordElementBounded, getBound1, getBound2, getCoordBounds, getCoordBoundsMidpoint, getCoordEdge, getCoordEdges, getCoordName, getCoordValue, getCoordValues, getIncrement, getMaxEdgeValue, getMaxValue, getMinEdgeValue, getMinValue, getStart, isContiguous, isInterval, isRegular

Methods inherited from class ucar.nc2.dataset.CoordinateAxis

addLocalFieldsToBuilder, equals, fromVariableDS, getAxisType, getBoundaryRef, getCalendarFromAttribute, getCalendarFromAttribute, getInfo, getPositive, getUnitsString, hashCode, isIndependentCoordinate

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

Constructor Detail

CoordinateAxis1DTime

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

Deprecated.

Method Detail

factory

public static CoordinateAxis1DTime factory(@Nullable
                                           NetcdfDataset ncd,
                                           VariableDS org,
                                           Formatter errMessages)
                                    throws IOException

Deprecated.

Throws:

IOException

section

public CoordinateAxis1DTime section(Range r)
                             throws InvalidRangeException

Deprecated.

Description copied from class: CoordinateAxis1D

Create a new CoordinateAxis1D as a section of this CoordinateAxis1D.

Overrides:

section in class CoordinateAxis1D

Parameters:

r - the section range

Returns:

a new CoordinateAxis1D as a section of this CoordinateAxis1D

Throws:

InvalidRangeException - if IllegalRange

getCalendarDate

public CalendarDate getCalendarDate(int idx)

Deprecated.

Get the the ith CalendarDate.

Parameters:

idx - index

Returns:

the ith CalendarDate

getCalendarDateRange

public CalendarDateRange getCalendarDateRange()

Deprecated.

Get calendar date range

Returns:

calendar date range

getTimeResolution

@Nullable
public TimeUnit getTimeResolution()
                                      throws Exception

Deprecated.

only if isRegular() LOOK REDO

Returns:

time unit or null if bad unit string

Throws:

Exception

findTimeIndexFromCalendarDate

public int findTimeIndexFromCalendarDate(CalendarDate d)

Deprecated.

Given a Date, find the corresponding time index on the time coordinate axis. Can only call this is hasDate() is true. This will return

• i, if time(i) <= d < time(i+1).
• 0, if d < time(0)
• n-1, if d > time(n-1), where n is length of time coordinates

Parameters:

d - date to look for

Returns:

corresponding time index on the time coordinate axis

Throws:

UnsupportedOperationException - is no time axis or isDate() false

hasCalendarDate

public boolean hasCalendarDate(CalendarDate date)

Deprecated.

See if the given CalendarDate appears as a coordinate

Parameters:

date - test this

Returns:

true if equals a coordinate

getCalendarDates

public List<CalendarDate> getCalendarDates()

Deprecated.

Get the list of datetimes in this coordinate as CalendarDate objects.

Returns:

list of CalendarDates.

getCoordBoundsDate

public CalendarDate[] getCoordBoundsDate(int i)

Deprecated.

getCoordBoundsMidpointDate

public CalendarDate getCoordBoundsMidpointDate(int i)

Deprecated.

readValues

protected void readValues()

Deprecated.

Overrides:

readValues in class CoordinateAxis1D

isNumeric

public boolean isNumeric()

Deprecated.

Description copied from class: CoordinateAxis

Does the axis have numeric values?

Overrides:

isNumeric in class CoordinateAxis

Returns:

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

getTimeDates

@Deprecated
public Date[] getTimeDates()

Deprecated. use getCalendarDates().

Does not handle non-standard Calendars

toBuilder

public CoordinateAxis1DTime.Builder<?> toBuilder()

Deprecated.

Description copied from class: Variable

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

Overrides:

toBuilder in class CoordinateAxis1D

addLocalFieldsToBuilder

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

Deprecated.

builder

public static CoordinateAxis1DTime.Builder<?> builder()

Deprecated.

Get Builder for this class that allows subclassing.

See Also:

"https://community.oracle.com/blogs/emcmanus/2010/10/24/using-builder-pattern-subclasses"