CoverageCoordAxis (NetCDF-Java CDM API v5.0.0)

java.lang.Object
- ucar.nc2.ft2.coverage.CoverageCoordAxis

All Implemented Interfaces:

Comparable<CoverageCoordAxis>

Direct Known Subclasses:

CoverageCoordAxis1D, LatLonAxis2D, TimeAxis2DFmrc, TimeAxis2DSwath
```
public abstract class CoverageCoordAxis
extends Object
implements 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

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 List<String>`	`dependsOn`
`protected String`	`description`
`protected double`	`endValue`
`protected boolean`	`isSubset`
`protected String`	`name`
`protected int`	`ncoords`
`protected CoordAxisReader`	`reader`
`protected double`	`resolution`
`protected CoverageCoordAxis.Spacing`	`spacing`
`protected double`	`startValue`
`protected TimeHelper`	`timeHelper`
`protected String`	`units`
`protected double[]`	`values`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CoverageCoordAxis(CoverageCoordAxisBuilder builder)

Constructors
Modifier	Constructor and Description
`protected`	`CoverageCoordAxis(CoverageCoordAxisBuilder builder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(CoverageCoordAxis o)`
`double`	`convert(CalendarDate date)`
`abstract CoverageCoordAxis`	`copy()`
`Attribute`	`findAttribute(String attName)`
`AttributeContainer`	`getAttributeContainer()`
`List<Attribute>`	`getAttributes()`
`AxisType`	`getAxisType()`
`Calendar`	`getCalendar()`
`CalendarDateUnit`	`getCalendarDateUnit()`
`abstract Array`	`getCoordBoundsAsArray()`
`abstract Array`	`getCoordsAsArray()`
`DataType`	`getDataType()`
`CalendarDateRange`	`getDateRange()`
`CoverageCoordAxis.DependenceType`	`getDependenceType()`
`String`	`getDependsOn()`
`List<String>`	`getDependsOnList()`
`String`	`getDescription()`
`double`	`getEndValue()`
`boolean`	`getHasData()`
`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()`
`String`	`getSummary()`
`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)`
`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

name
```
protected final String name
```

description
```
protected final 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 List<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 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 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)
                                            throws InvalidRangeException

Throws:: InvalidRangeException

subsetDependent

public abstract Optional<CoverageCoordAxis> subsetDependent(CoverageCoordAxis1D dependsOn)

getCoordsAsArray

public abstract Array getCoordsAsArray()

getCoordBoundsAsArray

public abstract Array getCoordBoundsAsArray()

getName
```
public String getName()
```

getDataType
```
public DataType getDataType()
```

getAxisType
```
public AxisType getAxisType()
```

getAttributes

public List<Attribute> getAttributes()

findAttribute

public Attribute findAttribute(String attName)

getAttributeContainer

public AttributeContainer getAttributeContainer()

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 String getUnits()
```

getDescription
```
public String getDescription()
```

getDependenceType

public CoverageCoordAxis.DependenceType getDependenceType()

isScalar
```
public boolean isScalar()
```

getDependsOn
```
public String getDependsOn()
```

getDependsOnList

public List<String> getDependsOnList()

getHasData
```
public boolean getHasData()
```

isSubset
```
public boolean isSubset()
```

isInterval
```
public boolean isInterval()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

getShape
```
public int[] getShape()
```

getRange
```
public Range getRange()
```

getRangeIterator

public RangeIterator getRangeIterator()

toString

public void toString(Formatter f,
                     Indent indent)

getSummary
```
public 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()
```

Class CoverageCoordAxis

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

description

dataType

axisType

attributes

dependenceType

dependsOn

ncoords

spacing

startValue

endValue

resolution

reader

isSubset

timeHelper

units

values

Constructor Detail

CoverageCoordAxis

Method Detail

setDataset

compareTo

copy

subset

subset

subsetDependent

getCoordsAsArray

getCoordBoundsAsArray

getName

getDataType

getAxisType

getAttributes

findAttribute

getAttributeContainer

getNcoords

getSpacing

isRegular

getResolution

getStartValue

getEndValue

getUnits

getDescription

getDependenceType

isScalar

getDependsOn

getDependsOnList

getHasData

isSubset

isInterval

toString

getShape

getRange

getRangeIterator

toString

getSummary

convert

makeDate

getDateRange

getOffsetInTimeUnits

makeDateInTimeUnits

getRefDate

getCalendar

getCalendarDateUnit

loadValuesIfNeeded

getValues