Package ucar.nc2.ft.point

Class DsgCollectionImpl

java.lang.Object

ucar.nc2.ft.point.DsgCollectionImpl

All Implemented Interfaces:

DsgFeatureCollection

Direct Known Subclasses:

PointCollectionImpl, PointFeatureCCCImpl, PointFeatureCCImpl

public abstract class DsgCollectionImpl
extends Object
implements DsgFeatureCollection

Common methods for DsgFeatureCollection.

Since:

9/25/2015.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	altName
protected String	altUnits
protected List<CoordinateAxis>	coordVars
protected List<Variable>	extras
protected CollectionInfo	info
protected String	name
protected String	timeName
protected CalendarDateUnit	timeUnit

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DsgCollectionImpl(String name, List<CoordinateAxis> coordVars)
protected	DsgCollectionImpl(String name, CalendarDateUnit timeUnit, String altUnits)

Method Summary

Modifier and Type	Method	Description
String	getAltName()	The altitude name string if it exists.
String	getAltUnits()	The altitude unit string if it exists.
LatLonRect	getBoundingBox()	The boundingBox for the FeatureCollection.
CalendarDateRange	getCalendarDateRange()	Calendar date range for the FeatureCollection.
List<CoordinateAxis>	getCoordinateVariables()	The list of coordinate variables in the collection
List<Variable>	getExtraVariables()
CollectionInfo	getInfo()
String	getName()	Get the name of this feature collection.
int	getNobs()
String	getTimeName()	The name of time unit, if there is a time axis.
CalendarDateUnit	getTimeUnit()	The time unit, if there is a time axis.
int	size()	The number of Features in the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.nc2.ft.DsgFeatureCollection

getCollectionFeatureType

Field Detail

name

protected String name

timeName

protected String timeName

timeUnit

protected CalendarDateUnit timeUnit

altName

protected String altName

altUnits

protected String altUnits

info

protected CollectionInfo info

coordVars

protected List<CoordinateAxis> coordVars

extras

protected List<Variable> extras

Constructor Detail

DsgCollectionImpl

protected DsgCollectionImpl(String name,
                            CalendarDateUnit timeUnit,
                            String altUnits)

DsgCollectionImpl

protected DsgCollectionImpl(String name,
                            List<CoordinateAxis> coordVars)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: DsgFeatureCollection

Get the name of this feature collection.

Specified by:

getName in interface DsgFeatureCollection

Returns:

the name of this feature collection

getTimeName

@Nullable
public String getTimeName()

Description copied from interface: DsgFeatureCollection

The name of time unit, if there is a time axis.

Specified by:

getTimeName in interface DsgFeatureCollection

Returns:

name of time unit string, may be null

getTimeUnit

@Nullable
public CalendarDateUnit getTimeUnit()

Description copied from interface: DsgFeatureCollection

The time unit, if there is a time axis.

Specified by:

getTimeUnit in interface DsgFeatureCollection

Returns:

time unit, may be null

getAltName

@Nullable
public String getAltName()

Description copied from interface: DsgFeatureCollection

The altitude name string if it exists.

Specified by:

getAltName in interface DsgFeatureCollection

Returns:

altitude name string, may be null

getAltUnits

@Nullable
public String getAltUnits()

Description copied from interface: DsgFeatureCollection

The altitude unit string if it exists.

Specified by:

getAltUnits in interface DsgFeatureCollection

Returns:

altitude unit string, may be null

getCoordinateVariables

@Nonnull
public List<CoordinateAxis> getCoordinateVariables()

Description copied from interface: DsgFeatureCollection

The list of coordinate variables in the collection

Specified by:

getCoordinateVariables in interface DsgFeatureCollection

Returns:

the list of coordinate variables, may be empty but not null;

getExtraVariables

@Nonnull
public List<Variable> getExtraVariables()

Specified by:

getExtraVariables in interface DsgFeatureCollection

size

public int size()

Description copied from interface: DsgFeatureCollection

The number of Features in the collection. May not be known until after iterating through the collection.

Specified by:

size in interface DsgFeatureCollection

Returns:

number of elements in the collection, or -1 if not known.

getNobs

public int getNobs()

getCalendarDateRange

@Nullable
public CalendarDateRange getCalendarDateRange()

Description copied from interface: DsgFeatureCollection

Calendar date range for the FeatureCollection. May not be known until after iterating through the collection.

Specified by:

getCalendarDateRange in interface DsgFeatureCollection

Returns:

the calendar date range for the entire collection, or null if unknown

getBoundingBox

@Nullable
public LatLonRect getBoundingBox()

Description copied from interface: DsgFeatureCollection

The boundingBox for the FeatureCollection. May not be known until after iterating through the collection.

Specified by:

getBoundingBox in interface DsgFeatureCollection

Returns:

the lat/lon boundingBox for the entire collection, or null if unknown.

getInfo

@Nonnull
public CollectionInfo getInfo()