ucar.nc2.ft

Class FeatureDatasetFactoryManager

java.lang.Object

ucar.nc2.ft.FeatureDatasetFactoryManager

public class FeatureDatasetFactoryManager
extends java.lang.Object

Manager of factories for FeatureDatasets opened as NetcdfDatasets.

Grids, FMRC, Swaths are using GridDatasetStandardFactory

Radial data uses RadialDatasetStandardFactory

All point datasets are going through PointDatasetStandardFactory, which uses TableAnalyzer to deal with specific dataset conventions.

Since:

Mar 19, 2008

See Also:

FeatureDatasetFactory

Constructor Summary

Constructors

Constructor and Description
FeatureDatasetFactoryManager()

Method Summary

Modifier and Type	Method and Description
static boolean	featureTypeOk(FeatureType want, FeatureType facType) Determine if factory type matches wanted feature type.
static FeatureType	findFeatureType(NetcdfFile ncd) Try to determine the feature type of the dataset, by examining its metadata.
static FeatureDataset	open(FeatureType wantFeatureType, java.lang.String location, CancelTask task) Deprecated. use open(FeatureType wantFeatureType, String location, ucar.nc2.util.CancelTask task, Formatter errlog)
static FeatureDataset	open(FeatureType wantFeatureType, java.lang.String location, CancelTask task, java.util.Formatter errlog) Open a dataset as a FeatureDataset.
static FeatureDataset	open(java.lang.String location)
static void	registerFactory(java.lang.Class c) Register a class that implements a FeatureDatasetFactory.
static void	registerFactory(FeatureType datatype, java.lang.Class c) Register a class that implements a FeatureDatasetFactory.
static boolean	registerFactory(FeatureType datatype, java.lang.String className) Register a class that implements a FeatureDatasetFactory.
static void	registerFactory(java.lang.String className) Register a class that implements a FeatureDatasetFactory.
static FeatureDataset	wrap(FeatureType wantFeatureType, NetcdfDataset ncd, CancelTask task, java.util.Formatter errlog) Wrap 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

FeatureDatasetFactoryManager

public FeatureDatasetFactoryManager()

Method Detail

registerFactory

public static boolean registerFactory(FeatureType datatype,
                                      java.lang.String className)

Register a class that implements a FeatureDatasetFactory.

Parameters:

datatype - scientific data type

className - name of class that implements FeatureDatasetFactory.

Returns:

true if successfully loaded

registerFactory

public static void registerFactory(FeatureType datatype,
                                   java.lang.Class c)

Register a class that implements a FeatureDatasetFactory.

Parameters:

datatype - scientific data type

c - class that implements FeatureDatasetFactory.

registerFactory

public static void registerFactory(java.lang.String className)
                            throws java.lang.ClassNotFoundException

Register a class that implements a FeatureDatasetFactory.

Parameters:

className - name of class that implements FeatureDatasetFactory.

Throws:

java.lang.ClassNotFoundException - if loading error

registerFactory

public static void registerFactory(java.lang.Class c)

Register a class that implements a FeatureDatasetFactory. Find out which type by calling getFeatureType().

Parameters:

c - class that implements FeatureDatasetFactory.

open

public static FeatureDataset open(java.lang.String location)
                           throws java.io.IOException

Throws:

java.io.IOException

open

public static FeatureDataset open(FeatureType wantFeatureType,
                                  java.lang.String location,
                                  CancelTask task)
                           throws java.io.IOException,
                                  NoFactoryFoundException

Deprecated. use open(FeatureType wantFeatureType, String location, ucar.nc2.util.CancelTask task, Formatter errlog)

Throws:

java.io.IOException

NoFactoryFoundException

open

public static FeatureDataset open(FeatureType wantFeatureType,
                                  java.lang.String location,
                                  CancelTask task,
                                  java.util.Formatter errlog)
                           throws java.io.IOException

Open a dataset as a FeatureDataset.

Parameters:

wantFeatureType - open this kind of FeatureDataset; may be null, which means search all factories. If datatype is not null, only return correct FeatureDataset (eg PointFeatureDataset for DataType.POINT).

location - URL or file location of the dataset. This may be a

1. thredds catalog#dataset (with a thredds: prefix)
2. cdmrFeature dataset (with a cdmrFeature: prefix)
3. cdmremote dataset (with a cdmremote: prefix)
4. collection dataset (with a collection: prefix)
5. file location for a CDM dataset opened with NetcdfDataset.acquireDataset()

task - user may cancel

errlog - place errors here, may not be null

Returns:

a subclass of FeatureDataset, or null if no suitable factory was found, message in errlog

Throws:

java.io.IOException - on io error

wrap

public static FeatureDataset wrap(FeatureType wantFeatureType,
                                  NetcdfDataset ncd,
                                  CancelTask task,
                                  java.util.Formatter errlog)
                           throws java.io.IOException

Wrap a NetcdfDataset as a FeatureDataset.

Parameters:

wantFeatureType - open this kind of FeatureDataset; may be null, which means search all factories. If datatype is not null, only return FeatureDataset with objects of that type

ncd - the NetcdfDataset to wrap as a FeatureDataset

task - user may cancel

errlog - place errors here, may not be null

Returns:

a subclass of FeatureDataset, or null if no suitable factory was found

Throws:

java.io.IOException - on io error

featureTypeOk

public static boolean featureTypeOk(FeatureType want,
                                    FeatureType facType)

Determine if factory type matches wanted feature type.

Parameters:

want - want this FeatureType

facType - factory is of this type

Returns:

true if match

findFeatureType

public static FeatureType findFeatureType(NetcdfFile ncd)

Try to determine the feature type of the dataset, by examining its metadata.

Parameters:

ncd - the dataset

Returns:

FeatureType if found, else null