ucar.nc2.ft.swath

Class SwathDatasetFactory

java.lang.Object

ucar.nc2.ft.swath.SwathDatasetFactory

All Implemented Interfaces:

FeatureDatasetFactory

public class SwathDatasetFactory
extends java.lang.Object
implements FeatureDatasetFactory

Swath dataset.

Since:

2/11/12

See Also:

"https://www.unidata.ucar.edu/jira/browse/CDM-42"

Constructor Summary

Constructors

Constructor and Description
SwathDatasetFactory()

Method Summary

Modifier and Type	Method and Description
FeatureType[]	getFeatureType() This Factory can open these types of Feature datasets.
java.lang.Object	isMine(FeatureType wantFeatureType, NetcdfDataset ncd, java.util.Formatter errlog) Determine if the factory can open this dataset as an instance of the given feature type
FeatureDataset	open(FeatureType ftype, NetcdfDataset ncd, java.lang.Object analysis, CancelTask task, java.util.Formatter errlog) Open a NetcdfDataset as a FeatureDataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwathDatasetFactory

public SwathDatasetFactory()

Method Detail

isMine

public java.lang.Object isMine(FeatureType wantFeatureType,
                               NetcdfDataset ncd,
                               java.util.Formatter errlog)
                        throws java.io.IOException

Description copied from interface: FeatureDatasetFactory

Determine if the factory can open this dataset as an instance of the given feature type

Specified by:

isMine in interface FeatureDatasetFactory

Parameters:

wantFeatureType - can factory open as this feature type? If null, can factory open as any feature type?

ncd - examine this NetcdfDataset.

errlog - place errors here

Returns:

"analysis object" - null if cannot open, else an Object that is passed back into FeatureDatasetFactory.open(). This allows expensive analysis results to be reused

Throws:

java.io.IOException - on read error

open

public FeatureDataset open(FeatureType ftype,
                           NetcdfDataset ncd,
                           java.lang.Object analysis,
                           CancelTask task,
                           java.util.Formatter errlog)
                    throws java.io.IOException

Description copied from interface: FeatureDatasetFactory

Open a NetcdfDataset as a FeatureDataset. Should only be called if isMine() returns non-null.

Specified by:

open in interface FeatureDatasetFactory

Parameters:

ftype - open as this feature type. If null, open as any feature type.

ncd - an already opened NetcdfDataset.

analysis - the object returned from isMine(). Likely given to a different instance of FeatureDatasetFactory

task - user may cancel, may be null

errlog - write error messages here, may be null

Returns:

a subclass of FeatureDataset

Throws:

java.io.IOException - on error

getFeatureType

public FeatureType[] getFeatureType()

Description copied from interface: FeatureDatasetFactory

This Factory can open these types of Feature datasets.

Specified by:

getFeatureType in interface FeatureDatasetFactory

Returns:

array of FeatureType