ucar.nc2.ft.point

Class FlattenedDatasetPointCollection

java.lang.Object

ucar.nc2.ft.point.DsgCollectionImpl

ucar.nc2.ft.point.PointCollectionImpl

ucar.nc2.ft.point.FlattenedDatasetPointCollection

All Implemented Interfaces:

Iterable<PointFeature>, DsgFeatureCollection, PointFeatureCollection

public class FlattenedDatasetPointCollection
extends PointCollectionImpl

An aggregate collection of all the PointFeatures in a dataset formed by flattening the nested structures within. This class's iterator returns features in default order, with maximum read efficiency as the goal.

Since:

2014/10/08

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FlattenedDatasetPointCollection.FlattenedDatasetPointIterator

Nested classes/interfaces inherited from class ucar.nc2.ft.point.PointCollectionImpl

PointCollectionImpl.PointCollectionSubset

Field Summary

Fields inherited from class ucar.nc2.ft.point.PointCollectionImpl

localIterator

Fields inherited from class ucar.nc2.ft.point.DsgCollectionImpl

altUnits, extras, info, name, timeUnit

Constructor Summary

Constructors

Constructor and Description
FlattenedDatasetPointCollection(FeatureDatasetPoint fdPoint) Constructs a FlattenedDatasetPointCollection.

Method Summary

Modifier and Type	Method and Description
PointFeatureIterator	getPointFeatureIterator() Get an iterator over the PointFeatures of this collection.

Methods inherited from class ucar.nc2.ft.point.PointCollectionImpl

finish, getCollectionFeatureType, hasNext, iterator, next, resetIteration, subset

Methods inherited from class ucar.nc2.ft.point.DsgCollectionImpl

getAltUnits, getBoundingBox, getCalendarDateRange, getExtraVariables, getInfo, getName, getNobs, getTimeUnit, size

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

getAltUnits, getBoundingBox, getCalendarDateRange, getExtraVariables, getName, getTimeUnit, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FlattenedDatasetPointCollection

public FlattenedDatasetPointCollection(FeatureDatasetPoint fdPoint)
                                throws IllegalArgumentException

Constructs a FlattenedDatasetPointCollection.

Parameters:

fdPoint - a point dataset.

Throws:

IllegalArgumentException - if any of the feature collections in the dataset are not of type PointFeatureCollection or NestedPointFeatureCollection.

Method Detail

getPointFeatureIterator

public PointFeatureIterator getPointFeatureIterator()
                                             throws IOException

Description copied from interface: PointFeatureCollection

Get an iterator over the PointFeatures of this collection. call PointFeatureIterator.finish() when done

Returns:

iterator over the PointFeatures of this collection

Throws:

IOException - on read error