ucar.nc2.ft

Interface DsgFeatureCollection

All Known Subinterfaces:

PointFeatureCC, PointFeatureCCC, PointFeatureCollection, ProfileFeature, ProfileFeatureCollection, StationProfileFeature, StationProfileFeatureCollection, StationTimeSeriesFeature, StationTimeSeriesFeatureCollection, TrajectoryFeature, TrajectoryFeatureCollection, TrajectoryProfileFeature, TrajectoryProfileFeatureCollection

All Known Implementing Classes:

CompositePointCollection, CompositeStationCollection, CompositeStationCollectionFlattened, DsgCollectionImpl, FlattenedDatasetPointCollection, PointCollectionImpl, PointCollectionImpl.PointCollectionSubset, PointCollectionStreamAbstract, PointCollectionStreamLocal, PointCollectionStreamRemote, PointFeatureCCCImpl, PointFeatureCCImpl, ProfileFeatureImpl, SectionCollectionImpl, SectionFeatureImpl, StandardPointCollectionImpl, StandardProfileCollectionImpl, StandardSectionCollectionImpl, StandardStationCollectionImpl, StandardStationProfileCollectionImpl, StandardTrajectoryCollectionImpl, StationCollectionStream, StationProfileCollectionImpl, StationProfileFeatureImpl, StationProfileFeatureImpl.StationProfileFeatureSubset, StationTimeSeriesCollectionFlattened, StationTimeSeriesCollectionImpl, StationTimeSeriesFeatureImpl, StationTimeSeriesFeatureImpl.StationFeatureSubset, TrajectoryFeatureImpl

public interface DsgFeatureCollection

A collection of FeatureTypes. Will either be a PointFeatureCollection, PointFeatureCC, or PointFeatureCCC

Since:

Mar 20, 2008

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAltName() The altitude name string if it exists.
java.lang.String	getAltUnits() The altitude unit string if it exists.
LatLonRect	getBoundingBox() The boundingBox for the FeatureCollection.
CalendarDateRange	getCalendarDateRange() Calendar date range for the FeatureCollection.
FeatureType	getCollectionFeatureType() All features in this collection have this feature type
java.util.List<CoordinateAxis>	getCoordinateVariables() The list of coordinate variables in the collection
java.util.List<Variable>	getExtraVariables() Other variables needed for completeness, eg joined coordinate variables
java.lang.String	getName() Get the name of this feature collection.
java.lang.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.

Method Detail

getName

@Nonnull
java.lang.String getName()

Get the name of this feature collection.

Returns:

the name of this feature collection

getCollectionFeatureType

@Nonnull
FeatureType getCollectionFeatureType()

All features in this collection have this feature type

Returns:

the feature type

getTimeName

@Nullable
java.lang.String getTimeName()

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

Returns:

name of time unit string, may be null

getTimeUnit

@Nullable
CalendarDateUnit getTimeUnit()

The time unit, if there is a time axis.

Returns:

time unit, may be null

getAltName

@Nullable
java.lang.String getAltName()

The altitude name string if it exists.

Returns:

altitude name string, may be null

getAltUnits

@Nullable
java.lang.String getAltUnits()

The altitude unit string if it exists.

Returns:

altitude unit string, may be null

getCoordinateVariables

@Nonnull
java.util.List<CoordinateAxis> getCoordinateVariables()

The list of coordinate variables in the collection

Returns:

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

getExtraVariables

@Nonnull
java.util.List<Variable> getExtraVariables()

Other variables needed for completeness, eg joined coordinate variables

Returns:

list of extra variables, may be empty not null

getCalendarDateRange

@Nullable
CalendarDateRange getCalendarDateRange()

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

Returns:

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

getBoundingBox

@Nullable
LatLonRect getBoundingBox()

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

Returns:

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

size

int size()

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

Returns:

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