ucar.nc2.ft
Interface FeatureDatasetFactory

public interface FeatureDatasetFactory

Interface for factories that wrap a NetcdfDataset with a FeatureDataset. Class must have a no-arg Constructor. Implementations must be thread-safe

Since:

Mar 19, 2008

Author:

caron

Method Summary

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.

Method Detail

isMine

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

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

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

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

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

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

FeatureType[] getFeatureType()

This Factory can open these types of Feature datasets.

Returns:

array of FeatureType