thredds.catalog

Class InvDatasetFeatureCollection

java.lang.Object

thredds.catalog.InvDataset

thredds.catalog.InvDatasetImpl

thredds.catalog.InvCatalogRef

thredds.catalog.InvDatasetFeatureCollection

All Implemented Interfaces:

thredds.inventory.CollectionManager.TriggerListener

Direct Known Subclasses:

InvDatasetFcFmrc, InvDatasetFcPoint

@ThreadSafe
public abstract class InvDatasetFeatureCollection
extends InvCatalogRef
implements thredds.inventory.CollectionManager.TriggerListener

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 InvDatasetFeatureCollection object is created once and held in the DataRootHandler's collection of DataRoots.

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 InvService	cdmrService
protected thredds.featurecollection.FeatureCollectionConfig	config
protected static java.lang.String	context
protected thredds.inventory.CollectionManager	dcm
protected thredds.featurecollection.FeatureCollectionType	fcType
protected static java.lang.String	FILES
protected static java.lang.String	LATEST_DATASET_CATALOG
protected static java.lang.String	LATEST_SERVICE
protected java.lang.String	latestFileName
protected java.lang.Object	lock
protected InvService	orgService
protected java.lang.String	path
protected InvDatasetFeatureCollection.State	state
protected java.lang.String	topDirectory
protected static java.lang.String	VARIABLES
protected static java.lang.String	Virtual_Services
protected InvService	virtualService

Fields inherited from class thredds.catalog.InvDatasetImpl

log, mark, ncmlElement, tm, tmi, tmi6

Fields inherited from class thredds.catalog.InvDataset

access, authorityName, catalog, collectionType, contributors, creators, dataFormatType, datasets, dataType, dates, defaultService, docs, gc, harvest, id, keywords, metadata, name, parent, projects, properties, publishers, restrictAccess, services, tc, variableMapLink, variables

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvDatasetFeatureCollection(InvDatasetImpl parent, java.lang.String name, java.lang.String path, thredds.featurecollection.FeatureCollectionType fcType, thredds.featurecollection.FeatureCollectionConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract InvDatasetFeatureCollection.State	checkState() a request has come in, check that the state is up-to-date
static InvDatasetFeatureCollection	factory(InvDatasetImpl parent, java.lang.String name, java.lang.String path, thredds.featurecollection.FeatureCollectionType fcType, thredds.featurecollection.FeatureCollectionConfig config)
protected void	finishConstruction()
protected void	firstInit()
protected java.lang.String	getCatalogHref(java.lang.String what)
thredds.featurecollection.FeatureCollectionConfig	getConfig()
thredds.inventory.CollectionManager	getDatasetCollectionManager()
java.util.List<InvDataset>	getDatasets() Get a list of all the nested datasets.
FeatureDatasetPoint	getFeatureDatasetPoint()
java.io.File	getFile(java.lang.String remaining)
GridDataset	getGridDataset(java.lang.String matchPath) Get the associated Grid Dataset, if any.
java.lang.String	getLatestFileName()
NetcdfDataset	getNetcdfDataset(java.lang.String matchPath) Get the dataset named by the path.
java.lang.String	getPath()
java.lang.String	getTopDirectoryLocation()
void	handleCollectionEvent(thredds.inventory.CollectionManager.TriggerEvent event)
abstract InvCatalogImpl	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 InvCatalogImpl	makeCatalogFiles(java.net.URI catURI, InvDatasetFeatureCollection.State localState, java.util.List<java.lang.String> filenames, boolean addLatest)
protected InvCatalogImpl	makeCatalogTop(java.net.URI catURI, InvDatasetFeatureCollection.State localState) Make the containing catalog of this feature collection "http://server:port/thredds/catalog/path/catalog.xml"
InvCatalogImpl	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 InvService	makeVirtualService(InvService org)
static void	setCatalogServletName(java.lang.String catServletName)
static void	setCdmrFeatureServiceUrlPath(java.lang.String urlPath)
static void	setContext(java.lang.String c)
abstract void	update(thredds.inventory.CollectionManager.Force force) Collection was changed, update internal objects.
abstract void	updateProto() update the proto dataset being used.

Methods inherited from class thredds.catalog.InvCatalogRef

equals, findDatasetByName, findProperty, findService, finish, getAccess, getAccess, getAlias, getAuthority, getCalendarDateCoverage, getCollectionType, getContributors, getCreators, getDataFormatType, getDataType, getDates, getDocumentation, getDocumentation, getFullName, getGeospatialCoverage, getID, getKeywords, getMark, getMetadata, getMetadata, getName, getParent, getProjects, getProperties, getProxyDataset, getPublishers, getServiceDefault, getUniqueID, getURI, getUrlPath, getUserProperty, getVariableMapLink, getVariables, getXlinkHref, hasAccess, hashCode, hasNestedDatasets, isHarvest, isRead, readAsynch, release, setXlinkHref

Methods inherited from class thredds.catalog.InvDatasetImpl

addAccess, addAccess, addDataset, addDataset, addDocumentation, addProperty, addService, canonicalize, dump, getAccessLocal, getDataSize, getLastModifiedDate, getLocalMetadata, getLocalMetadataInheritable, getNcmlElement, getParentReal, getServiceName, getServicesLocal, main, removeDataset, removeLocalMetadata, removeService, replaceDataset, resolve, setAlias, setAuthority, setCatalog, setCollectionType, setContributors, setDataFormatType, setDataSize, setDataType, setGeospatialCoverage, setHarvest, setID, setKeywords, setLastModifiedDate, setLastModifiedDate, setLocalMetadata, setMark, setName, setNcmlElement, setParent, setProjects, setPublishers, setResourceControl, setServiceName, setServicesLocal, setTimeCoverage, setTimeCoverage, setUrlPath, setUserProperty, toString, transferMetadata, writeHtmlDescription, writeHtmlDescription

Methods inherited from class thredds.catalog.InvDataset

findAccess, getCatalogUrl, getHistory, getParentCatalog, getProcessing, getRestrictAccess, getRights, getSubsetUrl, getSummary, getTimeCoverage, getVariables

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LATEST_DATASET_CATALOG

protected static final java.lang.String LATEST_DATASET_CATALOG

See Also:

Constant Field Values

LATEST_SERVICE

protected static final java.lang.String LATEST_SERVICE

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

Virtual_Services

protected static final java.lang.String Virtual_Services

See Also:

Constant Field Values

context

protected static java.lang.String context

orgService

protected InvService orgService

virtualService

protected InvService virtualService

cdmrService

protected InvService cdmrService

path

protected final java.lang.String path

fcType

protected final thredds.featurecollection.FeatureCollectionType fcType

config

protected final thredds.featurecollection.FeatureCollectionConfig config

topDirectory

protected final java.lang.String topDirectory

dcm

protected thredds.inventory.CollectionManager dcm

state

protected InvDatasetFeatureCollection.State state

lock

protected final java.lang.Object lock

latestFileName

protected java.lang.String latestFileName

Constructor Detail

InvDatasetFeatureCollection

protected InvDatasetFeatureCollection(InvDatasetImpl parent,
                           java.lang.String name,
                           java.lang.String path,
                           thredds.featurecollection.FeatureCollectionType fcType,
                           thredds.featurecollection.FeatureCollectionConfig config)

Method Detail

setContext

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

setCatalogServletName

public static void setCatalogServletName(java.lang.String catServletName)

setCdmrFeatureServiceUrlPath

public static void setCdmrFeatureServiceUrlPath(java.lang.String urlPath)

getCatalogHref

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

factory

public static InvDatasetFeatureCollection factory(InvDatasetImpl parent,
                                  java.lang.String name,
                                  java.lang.String path,
                                  thredds.featurecollection.FeatureCollectionType fcType,
                                  thredds.featurecollection.FeatureCollectionConfig config)

finishConstruction

protected void finishConstruction()

firstInit

protected void firstInit()

handleCollectionEvent

public void handleCollectionEvent(thredds.inventory.CollectionManager.TriggerEvent event)

Specified by:

handleCollectionEvent in interface thredds.inventory.CollectionManager.TriggerListener

update

public abstract void update(thredds.inventory.CollectionManager.Force force)

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

Parameters:

force - test : update index if anything changed or nocheck - use index if it exists

updateProto

public abstract void updateProto()

update the proto dataset being used. called by CollectionUpdater via handleCollectionEvent, so in a quartz scheduler thread

checkState

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

a request has come in, check that the state is up-to-date

Returns:

the State, updated if needed

Throws:

java.io.IOException - on read error

getPath

public java.lang.String getPath()

getLatestFileName

public java.lang.String getLatestFileName()

getTopDirectoryLocation

public java.lang.String getTopDirectoryLocation()

getConfig

public thredds.featurecollection.FeatureCollectionConfig getConfig()

getDatasetCollectionManager

public thredds.inventory.CollectionManager getDatasetCollectionManager()

getDatasets

public java.util.List<InvDataset> getDatasets()

Description copied from class: InvCatalogRef

Get a list of all the nested datasets.

Overrides:

getDatasets in class InvCatalogRef

Returns:

Datasets. This triggers a read of the referenced catalog the first time its called.

makeVirtualService

protected InvService makeVirtualService(InvService org)

makeCatalog

public abstract InvCatalogImpl 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()

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

makeCatalogTop

protected InvCatalogImpl 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 InvCatalogImpl 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)

makeLatest

public InvCatalogImpl makeLatest(java.lang.String matchPath,
                        java.lang.String reqPath,
                        java.net.URI catURI)

getGridDataset

public 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

getFeatureDatasetPoint

public FeatureDatasetPoint getFeatureDatasetPoint()

getNetcdfDataset

public 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)