ucar.nc2.ft.grid
Class GridDatasetStandardFactory

java.lang.Object
  extended by ucar.nc2.ft.grid.GridDatasetStandardFactory
All Implemented Interfaces:
FeatureDatasetFactory

public class GridDatasetStandardFactory
extends Object
implements FeatureDatasetFactory

FeatureDatasetFactory for Grids, using standard coord sys analysis

Since:
Dec 30, 2008
Author:
caron

Constructor Summary
GridDatasetStandardFactory()
           
 
Method Summary
 FeatureType[] getFeatureType()
          This Factory can open these types of Feature datasets.
 Object isMine(FeatureType wantFeatureType, NetcdfDataset ncd, Formatter errlog)
          Determine if the factory can open this dataset as an instance of the given feature type
 FeatureDataset open(FeatureType ftype, NetcdfDataset ncd, Object analysis, CancelTask task, 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

GridDatasetStandardFactory

public GridDatasetStandardFactory()
Method Detail

isMine

public Object isMine(FeatureType wantFeatureType,
                     NetcdfDataset ncd,
                     Formatter errlog)
              throws 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:
IOException - on read error

open

public FeatureDataset open(FeatureType ftype,
                           NetcdfDataset ncd,
                           Object analysis,
                           CancelTask task,
                           Formatter errlog)
                    throws 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:
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


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.