ucar.nc2.ft.point.remote

Class PointCollectionStreamAbstract

java.lang.Object

ucar.nc2.ft.point.DsgCollectionImpl

ucar.nc2.ft.point.PointCollectionImpl

ucar.nc2.ft.point.remote.PointCollectionStreamAbstract

All Implemented Interfaces:

Iterable<PointFeature>, DsgFeatureCollection, PointFeatureCollection

Direct Known Subclasses:

PointCollectionStreamLocal, PointCollectionStreamRemote

public abstract class PointCollectionStreamAbstract
extends PointCollectionImpl

Abstract superclass for creating a PointFeatureCollection from a point stream. Subclasses must implement getInputStream().

Since:

2014/10/02

Nested Class Summary

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
PointCollectionStreamAbstract(String name) Creates a feature collection with the specified name.
PointCollectionStreamAbstract(String name, CalendarDateUnit timeUnit, String altUnits) Creates a feature collection with the specified name, time unit, and altitude unit.

Method Summary

Modifier and Type	Method and Description
abstract InputStream	getInputStream() Returns the input stream from which to read point data.
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

PointCollectionStreamAbstract

public PointCollectionStreamAbstract(String name)

Creates a feature collection with the specified name. DsgCollectionImpl.getTimeUnit() and DsgCollectionImpl.getAltUnits() will return default values until getPointFeatureIterator() is called for the first time.

Parameters:

name - the name of this feature collection. May be null.

PointCollectionStreamAbstract

public PointCollectionStreamAbstract(String name,
                                     CalendarDateUnit timeUnit,
                                     String altUnits)

Creates a feature collection with the specified name, time unit, and altitude unit.

Parameters:

name - the name of this feature collection. May be null.

timeUnit - the time unit. May not be null.

altUnits - the UDUNITS altitude unit string. May be null.

Method Detail

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

Returns the input stream from which to read point data.

Returns:

the input stream from which to read point data.

Throws:

IOException - if an I/O error occurs.

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