thredds.featurecollection

Class InvDatasetFeatureCollection

java.lang.Object

thredds.featurecollection.InvDatasetFeatureCollection

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

InvDatasetFcFmrc, InvDatasetFcGrib, InvDatasetFcPoint

@ThreadSafe
public abstract class InvDatasetFeatureCollection
extends java.lang.Object
implements java.io.Closeable

Abstract superclass for Feature Collection Datasets. This is a InvCatalogRef subclass. So the reference is placed in the parent, but the catalog itself isnt constructed until the following call from DataRootHandler.makeDynamicCatalog(): match.dataRoot.featCollection.makeCatalog(match.remaining, path, baseURI);

The DatasetFeatureCollection object is held in the DataRootManager's FeatureCollectionCache; it may get closed and recreated.

Since:

Mar 3, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	InvDatasetFeatureCollection.State

Field Summary

Fields

Modifier and Type	Field and Description
protected static AllowedServices	allowedServices
protected thredds.featurecollection.FeatureCollectionConfig	config
protected java.lang.String	configPath
protected static java.lang.String	contextName
protected thredds.inventory.MFileCollectionManager	datasetCollection
protected thredds.client.catalog.Service	downloadService
protected thredds.featurecollection.FeatureCollectionType	fcType
protected static java.lang.String	FILES
protected boolean	first
protected static java.lang.String	LATEST_DATASET_CATALOG
protected thredds.client.catalog.Service	latestService
protected java.lang.Object	lock
protected java.lang.String	name
protected thredds.client.catalog.Service	orgService
protected thredds.server.catalog.FeatureCollectionRef	parent
protected InvDatasetFeatureCollection.State	state
protected java.lang.String	topDirectory
protected static java.lang.String	VARIABLES
protected thredds.client.catalog.Service	virtualService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvDatasetFeatureCollection(thredds.server.catalog.FeatureCollectionRef parent, thredds.featurecollection.FeatureCollectionConfig config)

Method Summary

Modifier and Type	Method and Description
protected void	_showStatus(java.util.Formatter f, boolean summaryOnly, java.lang.String type)
protected static java.lang.String	buildCatalogServiceHref(java.lang.String path)
protected InvDatasetFeatureCollection.State	checkState() A request has come in, check that the state has been initialized.
void	close()
static InvDatasetFeatureCollection	factory(thredds.server.catalog.FeatureCollectionRef parent, thredds.featurecollection.FeatureCollectionConfig config)
protected void	firstInit()
protected java.lang.String	getCatalogHref(java.lang.String what)
thredds.featurecollection.FeatureCollectionConfig	getConfig()
java.lang.String	getConfigPath()
thredds.inventory.MCollection	getDatasetCollectionManager()
java.io.File	getFile(java.lang.String remaining)
ucar.nc2.ft2.coverage.CoverageCollection	getGridCoverage(java.lang.String matchPath)
ucar.nc2.dt.grid.GridDataset	getGridDataset(java.lang.String matchPath) Get the associated Grid Dataset, if any.
java.lang.String	getLatestFileName()
org.slf4j.Logger	getLogger()
java.lang.String	getName()
ucar.nc2.dataset.NetcdfDataset	getNetcdfDataset(java.lang.String matchPath) Get the dataset named by the path.
protected java.lang.String	getPath()
ucar.nc2.ft.FeatureDatasetPoint	getPointDataset(java.lang.String matchPath) Get the associated Point Dataset, if any.
java.lang.String	getTopDirectoryLocation()
abstract thredds.client.catalog.builder.CatalogBuilder	makeCatalog(java.lang.String match, java.lang.String orgPath, java.net.URI catURI) Get one of the catalogs contained in this collection, called by DataRootHandler.makeDynamicCatalog()
protected thredds.client.catalog.builder.CatalogBuilder	makeCatalogFiles(java.net.URI catURI, InvDatasetFeatureCollection.State localState, java.util.List<java.lang.String> filenames, boolean addLatest)
protected thredds.client.catalog.builder.CatalogBuilder	makeCatalogTop(java.net.URI catURI, InvDatasetFeatureCollection.State localState) Make the containing catalog of this feature collection "http://server:port/thredds/catalog/path/catalog.xml"
protected void	makeCollection()
protected abstract thredds.client.catalog.builder.DatasetBuilder	makeDatasetTop(java.net.URI catURI, InvDatasetFeatureCollection.State localState)
protected void	makeDefaultServices()
protected java.lang.String	makeFullName(thredds.client.catalog.DatasetNode ds)
thredds.client.catalog.builder.CatalogBuilder	makeLatest(java.lang.String matchPath, java.lang.String reqPath, java.net.URI catURI)
protected java.lang.String	makeMetadataLink(java.lang.String datasetName, java.lang.String metadata)
protected thredds.client.catalog.ThreddsMetadata.UriResolved	makeUriResolved(java.net.URI baseURI, java.lang.String href)
void	processEvent(thredds.inventory.CollectionUpdateEvent event)
static void	setAllowedServices(AllowedServices _allowedServices)
static void	setContextName(java.lang.String c)
void	showStatus(java.util.Formatter f)
java.lang.String	showStatusShort(java.lang.String type)
protected void	update(thredds.inventory.CollectionUpdateType force) Collection was changed, update internal objects.
protected abstract void	updateCollection(InvDatasetFeatureCollection.State localState, thredds.inventory.CollectionUpdateType force)

Methods inherited from class java.lang.Object

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

Field Detail

LATEST_DATASET_CATALOG

protected static final java.lang.String LATEST_DATASET_CATALOG

See Also:

Constant Field Values

VARIABLES

protected static final java.lang.String VARIABLES

See Also:

Constant Field Values

FILES

protected static final java.lang.String FILES

See Also:

Constant Field Values

allowedServices

protected static AllowedServices allowedServices

contextName

protected static java.lang.String contextName

parent

protected thredds.server.catalog.FeatureCollectionRef parent

orgService

protected thredds.client.catalog.Service orgService

virtualService

protected thredds.client.catalog.Service virtualService

latestService

protected thredds.client.catalog.Service latestService

downloadService

protected thredds.client.catalog.Service downloadService

name

protected final java.lang.String name

configPath

protected final java.lang.String configPath

fcType

protected final thredds.featurecollection.FeatureCollectionType fcType

config

protected final thredds.featurecollection.FeatureCollectionConfig config

topDirectory

protected java.lang.String topDirectory

datasetCollection

protected thredds.inventory.MFileCollectionManager datasetCollection

state

protected InvDatasetFeatureCollection.State state

first

protected boolean first

lock

protected final java.lang.Object lock

Constructor Detail

InvDatasetFeatureCollection

protected InvDatasetFeatureCollection(thredds.server.catalog.FeatureCollectionRef parent,
                                      thredds.featurecollection.FeatureCollectionConfig config)

Method Detail

setContextName

public static void setContextName(java.lang.String c)

setAllowedServices

public static void setAllowedServices(AllowedServices _allowedServices)

buildCatalogServiceHref

protected static java.lang.String buildCatalogServiceHref(java.lang.String path)

factory

public static InvDatasetFeatureCollection factory(thredds.server.catalog.FeatureCollectionRef parent,
                                                  thredds.featurecollection.FeatureCollectionConfig config)

makeDefaultServices

protected void makeDefaultServices()

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

makeCollection

protected void makeCollection()

processEvent

public void processEvent(thredds.inventory.CollectionUpdateEvent event)

showStatus

public void showStatus(java.util.Formatter f)

showStatusShort

public java.lang.String showStatusShort(java.lang.String type)

_showStatus

protected void _showStatus(java.util.Formatter f,
                           boolean summaryOnly,
                           java.lang.String type)
                    throws java.io.IOException

Throws:

java.io.IOException

getPath

protected java.lang.String getPath()

updateCollection

protected abstract void updateCollection(InvDatasetFeatureCollection.State localState,
                                         thredds.inventory.CollectionUpdateType force)

getCatalogHref

protected java.lang.String getCatalogHref(java.lang.String what)

firstInit

protected void firstInit()

checkState

protected InvDatasetFeatureCollection.State checkState()
                                                throws java.io.IOException

A request has come in, check that the state has been initialized. this is called from the request thread.

Returns:

a copy of the State

Throws:

java.io.IOException

update

protected void update(thredds.inventory.CollectionUpdateType force)
               throws java.io.IOException

Collection was changed, update internal objects. called by CollectionUpdater, trigger via handleCollectionEvent, so in a quartz scheduler thread

Parameters:

force - update type

Throws:

java.io.IOException

getName

public java.lang.String getName()

getConfigPath

public java.lang.String getConfigPath()

getLatestFileName

public java.lang.String getLatestFileName()

getTopDirectoryLocation

public java.lang.String getTopDirectoryLocation()

getConfig

public thredds.featurecollection.FeatureCollectionConfig getConfig()

getDatasetCollectionManager

public thredds.inventory.MCollection getDatasetCollectionManager()

getLogger

public org.slf4j.Logger getLogger()

makeFullName

protected java.lang.String makeFullName(thredds.client.catalog.DatasetNode ds)

makeCatalog

public abstract thredds.client.catalog.builder.CatalogBuilder makeCatalog(java.lang.String match,
                                                                          java.lang.String orgPath,
                                                                          java.net.URI catURI)
                                                                   throws java.io.IOException

Get one of the catalogs contained in this collection, called by DataRootHandler.makeDynamicCatalog()

Parameters:

match - match.remaining

orgPath - the path for the request.

catURI - the base URI for the catalog to be made, used to resolve relative URLs.

Returns:

containing catalog

Throws:

java.io.IOException

makeDatasetTop

protected abstract thredds.client.catalog.builder.DatasetBuilder makeDatasetTop(java.net.URI catURI,
                                                                                InvDatasetFeatureCollection.State localState)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

makeCatalogTop

protected thredds.client.catalog.builder.CatalogBuilder makeCatalogTop(java.net.URI catURI,
                                                                       InvDatasetFeatureCollection.State localState)
                                                                throws java.io.IOException,
                                                                       java.net.URISyntaxException

Make the containing catalog of this feature collection "http://server:port/thredds/catalog/path/catalog.xml"

Parameters:

catURI - base URI of the request

localState - current state to use

Returns:

the top FMRC catalog

Throws:

java.io.IOException - on I/O error

java.net.URISyntaxException - if path is misformed

makeCatalogFiles

protected thredds.client.catalog.builder.CatalogBuilder makeCatalogFiles(java.net.URI catURI,
                                                                         InvDatasetFeatureCollection.State localState,
                                                                         java.util.List<java.lang.String> filenames,
                                                                         boolean addLatest)
                                                                  throws java.io.IOException

Throws:

java.io.IOException

makeMetadataLink

protected java.lang.String makeMetadataLink(java.lang.String datasetName,
                                            java.lang.String metadata)

makeUriResolved

protected thredds.client.catalog.ThreddsMetadata.UriResolved makeUriResolved(java.net.URI baseURI,
                                                                             java.lang.String href)

makeLatest

public thredds.client.catalog.builder.CatalogBuilder makeLatest(java.lang.String matchPath,
                                                                java.lang.String reqPath,
                                                                java.net.URI catURI)
                                                         throws java.io.IOException

Throws:

java.io.IOException

getPointDataset

public ucar.nc2.ft.FeatureDatasetPoint getPointDataset(java.lang.String matchPath)
                                                throws java.io.IOException

Get the associated Point Dataset, if any. called by DatasetHandler.openPointDataset()

Parameters:

matchPath - match.remaining

Returns:

Grid Dataset, or null if n/a

Throws:

java.io.IOException - on error

getGridDataset

public ucar.nc2.dt.grid.GridDataset getGridDataset(java.lang.String matchPath)
                                            throws java.io.IOException

Get the associated Grid Dataset, if any. called by DatasetHandler.openGridDataset()

Parameters:

matchPath - match.remaining

Returns:

Grid Dataset, or null if n/a

Throws:

java.io.IOException - on error

getGridCoverage

public ucar.nc2.ft2.coverage.CoverageCollection getGridCoverage(java.lang.String matchPath)
                                                         throws java.io.IOException

Throws:

java.io.IOException

getNetcdfDataset

public ucar.nc2.dataset.NetcdfDataset getNetcdfDataset(java.lang.String matchPath)
                                                throws java.io.IOException

Get the dataset named by the path. called by DatasetHandler.getNetcdfFile()

Parameters:

matchPath - remaining path from match

Returns:

requested dataset

Throws:

java.io.IOException - if read error

getFile

public java.io.File getFile(java.lang.String remaining)