ucar.nc2.thredds
Class ThreddsDataFactory

java.lang.Object
  ucar.nc2.thredds.ThreddsDataFactory

public class ThreddsDataFactory
extends java.lang.Object

This tries to translate a THREDDS InvDataset into a data object that can be used, either a NetcdfDataset or a TypedDataset like PointObsDataset, etc.

As input, it can take

1. An InvAccess object.
2. An InvDataset object. If the InvDataset has more that one InvAccess, it has to try to choose which to use, based on what Service type we know how to work with.
3. A url of the form [thredds:]catalog.xml#datasetId. In this case it opens the catalog, and looks for the InvDataset with the given datasetId.
4. A url of the form thredds:resolve:resolveURL. In this case it expects that the URL will return a catalog with a single top level dataset, which is the "resolved" dataset.

It annotates the NetcdfDataset with info from the InvDataset.

You can reuse a ThreddsDataFactory, but do not share across threads.

Version:

$Revision:63 $ $Date:2006-07-12 21:50:51Z $

Author:

caron

Nested Class Summary

static class

ThreddsDataFactory.Result The result of trying to open a THREDDS dataset.

Constructor Summary

ThreddsDataFactory()

Method Summary

static void	annotate(InvDataset ds, NetcdfDataset ncDataset) Add information from the InvDataset to the NetcdfDataset.
InvAccess	chooseDatasetAccess(java.util.List accessList) Find the "best" access in case theres more than one, based on what the CDM knows how to open and use.
NetcdfDataset	openDataset(InvAccess access, boolean acquire, CancelTask task, java.lang.StringBuffer log) Try to open invAccess as a NetcdfDataset.
NetcdfDataset	openDataset(InvDataset invDataset, boolean acquire, CancelTask task, java.lang.StringBuffer log) Try to open as a NetcdfDataset.
NetcdfDataset	openDataset(java.lang.String location, boolean acquire, CancelTask task, java.lang.StringBuffer log) Open a NetcdfDataset from a URL location string.
ThreddsDataFactory.Result	openDatatype(InvAccess access, CancelTask task) Open a TypedDataset from an InvAccess object.
ThreddsDataFactory.Result	openDatatype(InvDataset invDataset, CancelTask task) Open a TypedDataset from an InvDataset object, deciding on which InvAccess to use.
ThreddsDataFactory.Result	openDatatype(java.lang.String location, CancelTask task) Open a TypedDataset from a URL location string.
static void	setDebugFlags(DebugFlags debugFlag)

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreddsDataFactory

public ThreddsDataFactory()

Method Detail

setDebugFlags

public static void setDebugFlags(DebugFlags debugFlag)

openDatatype

public ThreddsDataFactory.Result openDatatype(java.lang.String location,
                                              CancelTask task)
                                       throws java.io.IOException

Open a TypedDataset from a URL location string. Example URLS:

• http://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds:http://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds:file:c:/test/data/catalog/addeStationDataset.xml#AddeSurfaceData (absolute file)
• thredds:resolve:resolveURL

Parameters:

location - [thredds:]catalog.xml#datasetId

task - may be null

Returns:

ThreddsDataFactory.Result check fatalError for validity

Throws:

java.io.IOException

openDatatype

public ThreddsDataFactory.Result openDatatype(InvDataset invDataset,
                                              CancelTask task)
                                       throws java.io.IOException

Open a TypedDataset from an InvDataset object, deciding on which InvAccess to use.

Parameters:

invDataset -

task - may be null

Returns:

ThreddsDataFactory.Result check fatalError for validity

Throws:

java.io.IOException

openDatatype

public ThreddsDataFactory.Result openDatatype(InvAccess access,
                                              CancelTask task)
                                       throws java.io.IOException

Open a TypedDataset from an InvAccess object.

Parameters:

access - use this InvAccess.

task - may be null

Returns:

ThreddsDataFactory.Result check fatalError for validity

Throws:

java.io.IOException

openDataset

public NetcdfDataset openDataset(java.lang.String location,
                                 boolean acquire,
                                 CancelTask task,
                                 java.lang.StringBuffer log)
                          throws java.io.IOException

Open a NetcdfDataset from a URL location string. Example URLS:

• http://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds:http://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds://localhost:8080/test/addeStationDataset.xml#surfaceHourly
• thredds:file:c:/dev/netcdf-java-2.2/test/data/catalog/addeStationDataset.xml#AddeSurfaceData (absolute file)
• thredds:resolve:resolveURL

Parameters:

location - catalog.xml#datasetId, may optionally start with "thredds:"

task - may be null

log - error messages gp here, may be null

Returns:

NetcdfDataset

Throws:

java.io.IOException

openDataset

public NetcdfDataset openDataset(InvDataset invDataset,
                                 boolean acquire,
                                 CancelTask task,
                                 java.lang.StringBuffer log)
                          throws java.io.IOException

Try to open as a NetcdfDataset.

Parameters:

invDataset - open this

task - may be null

log - error message, may be null

Returns:

NetcdfDataset or null if failure

Throws:

java.io.IOException

openDataset

public NetcdfDataset openDataset(InvAccess access,
                                 boolean acquire,
                                 CancelTask task,
                                 java.lang.StringBuffer log)
                          throws java.io.IOException

Try to open invAccess as a NetcdfDataset.

Parameters:

access - open this InvAccess

task - may be null

log - error message, may be null

Returns:

NetcdfDataset or null if failure

Throws:

java.io.IOException

chooseDatasetAccess

public InvAccess chooseDatasetAccess(java.util.List accessList)

Find the "best" access in case theres more than one, based on what the CDM knows how to open and use.

Parameters:

accessList - choose from this list.

Returns:

best access method.

annotate

public static void annotate(InvDataset ds,
                            NetcdfDataset ncDataset)

Add information from the InvDataset to the NetcdfDataset.

Parameters:

ds - get info from here

ncDataset - add to here