ucar.nc2.ft2.coverage

Class CoverageCoordAxis

java.lang.Object

ucar.nc2.ft2.coverage.CoverageCoordAxis

All Implemented Interfaces:

java.lang.Comparable<CoverageCoordAxis>

Direct Known Subclasses:

CoverageCoordAxis1D, LatLonAxis2D, TimeAxis2DFmrc, TimeAxis2DSwath

public abstract class CoverageCoordAxis
extends java.lang.Object
implements java.lang.Comparable<CoverageCoordAxis>

Coverage CoordAxis abstract superclass Immutable with (possible) lazy eval of values

Since:

7/11/2015

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoverageCoordAxis.DependenceType
static class	CoverageCoordAxis.Spacing

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeContainer	attributes
protected AxisType	axisType
protected DataType	dataType
protected CoverageCoordAxis.DependenceType	dependenceType
protected java.util.List<java.lang.String>	dependsOn
protected java.lang.String	description
protected double	endValue
protected boolean	isSubset
protected java.lang.String	name
protected int	ncoords
protected CoordAxisReader	reader
protected double	resolution
protected CoverageCoordAxis.Spacing	spacing
protected double	startValue
protected TimeHelper	timeHelper
protected java.lang.String	units
protected double[]	values

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoverageCoordAxis(CoverageCoordAxisBuilder builder)

Method Summary

Modifier and Type	Method and Description
AttributeContainer	attributes() Get the axis' attributes.
int	compareTo(CoverageCoordAxis o)
double	convert(CalendarDate date)
abstract CoverageCoordAxis	copy()
Attribute	findAttribute(java.lang.String attName) Deprecated. use attributes()
AttributeContainer	getAttributeContainer() Deprecated. use attributes()
java.util.List<Attribute>	getAttributes() Deprecated. use attributes()
AxisType	getAxisType()
Calendar	getCalendar()
CalendarDateUnit	getCalendarDateUnit()
abstract Array	getCoordBoundsAsArray()
abstract Array	getCoordsAsArray()
DataType	getDataType()
CalendarDateRange	getDateRange()
CoverageCoordAxis.DependenceType	getDependenceType()
java.lang.String	getDependsOn()
java.util.List<java.lang.String>	getDependsOnList()
java.lang.String	getDescription()
double	getEndValue()
boolean	getHasData()
java.lang.String	getName()
int	getNcoords()
double	getOffsetInTimeUnits(CalendarDate start, CalendarDate end)
Range	getRange()
RangeIterator	getRangeIterator()
CalendarDate	getRefDate()
double	getResolution()
int[]	getShape()
CoverageCoordAxis.Spacing	getSpacing()
double	getStartValue()
java.lang.String	getSummary()
java.lang.String	getUnits()
double[]	getValues()
boolean	isInterval()
boolean	isRegular()
boolean	isScalar()
boolean	isSubset()
protected void	loadValuesIfNeeded()
CalendarDate	makeDate(double value)
CalendarDate	makeDateInTimeUnits(CalendarDate start, double addTo)
protected void	setDataset(CoordSysContainer dataset)
abstract Optional<CoverageCoordAxis>	subset(double minValue, double maxValue, int stride)
abstract Optional<CoverageCoordAxis>	subset(SubsetParams params)
abstract Optional<CoverageCoordAxis>	subsetDependent(CoverageCoordAxis1D dependsOn)
java.lang.String	toString()
void	toString(java.util.Formatter f, Indent indent)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

description

protected final java.lang.String description

dataType

protected final DataType dataType

axisType

protected final AxisType axisType

attributes

protected final AttributeContainer attributes

dependenceType

protected final CoverageCoordAxis.DependenceType dependenceType

dependsOn

protected final java.util.List<java.lang.String> dependsOn

ncoords

protected final int ncoords

spacing

protected final CoverageCoordAxis.Spacing spacing

startValue

protected final double startValue

endValue

protected final double endValue

resolution

protected final double resolution

reader

protected final CoordAxisReader reader

isSubset

protected final boolean isSubset

timeHelper

protected final TimeHelper timeHelper

units

protected final java.lang.String units

values

protected double[] values

Constructor Detail

CoverageCoordAxis

protected CoverageCoordAxis(CoverageCoordAxisBuilder builder)

Method Detail

setDataset

protected void setDataset(CoordSysContainer dataset)

compareTo

public int compareTo(CoverageCoordAxis o)

Specified by:

compareTo in interface java.lang.Comparable<CoverageCoordAxis>

copy

public abstract CoverageCoordAxis copy()

subset

public abstract Optional<CoverageCoordAxis> subset(SubsetParams params)

subset

public abstract Optional<CoverageCoordAxis> subset(double minValue,
                                                   double maxValue,
                                                   int stride)

subsetDependent

public abstract Optional<CoverageCoordAxis> subsetDependent(CoverageCoordAxis1D dependsOn)

getCoordsAsArray

public abstract Array getCoordsAsArray()

getCoordBoundsAsArray

public abstract Array getCoordBoundsAsArray()

getName

public java.lang.String getName()

getDataType

public DataType getDataType()

getAxisType

public AxisType getAxisType()

attributes

public AttributeContainer attributes()

Get the axis' attributes.

getAttributes

@Deprecated
public java.util.List<Attribute> getAttributes()

Deprecated. use attributes()

findAttribute

@Deprecated
public Attribute findAttribute(java.lang.String attName)

Deprecated. use attributes()

getAttributeContainer

@Deprecated
public AttributeContainer getAttributeContainer()

Deprecated. use attributes()

getNcoords

public int getNcoords()

getSpacing

public CoverageCoordAxis.Spacing getSpacing()

isRegular

public boolean isRegular()

getResolution

public double getResolution()

getStartValue

public double getStartValue()

getEndValue

public double getEndValue()

getUnits

public java.lang.String getUnits()

getDescription

public java.lang.String getDescription()

getDependenceType

public CoverageCoordAxis.DependenceType getDependenceType()

isScalar

public boolean isScalar()

getDependsOn

public java.lang.String getDependsOn()

getDependsOnList

public java.util.List<java.lang.String> getDependsOnList()

getHasData

public boolean getHasData()

isSubset

public boolean isSubset()

isInterval

public boolean isInterval()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getShape

public int[] getShape()

getRange

public Range getRange()

getRangeIterator

public RangeIterator getRangeIterator()

toString

public void toString(java.util.Formatter f,
                     Indent indent)

getSummary

public java.lang.String getSummary()

convert

public double convert(CalendarDate date)

makeDate

public CalendarDate makeDate(double value)

getDateRange

public CalendarDateRange getDateRange()

getOffsetInTimeUnits

public double getOffsetInTimeUnits(CalendarDate start,
                                   CalendarDate end)

makeDateInTimeUnits

public CalendarDate makeDateInTimeUnits(CalendarDate start,
                                        double addTo)

getRefDate

public CalendarDate getRefDate()

getCalendar

public Calendar getCalendar()

getCalendarDateUnit

public CalendarDateUnit getCalendarDateUnit()

loadValuesIfNeeded

protected void loadValuesIfNeeded()

getValues

public double[] getValues()