thredds.catalog

Class InvDatasetFeatureCollection

java.lang.Object

thredds.catalog.InvDataset

thredds.catalog.InvDatasetImpl

thredds.catalog.InvCatalogRef

thredds.catalog.InvDatasetFeatureCollection

All Implemented Interfaces:

DatasetCollectionManager.TriggerListener

Direct Known Subclasses:

InvDatasetFcFmrc, InvDatasetFcPoint

@ThreadSafe
public abstract class InvDatasetFeatureCollection
extends InvCatalogRef
implements DatasetCollectionManager.TriggerListener

Feature Collection Dataset. 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); Generate anew each call; use object caching if needed to improve efficiency

Since:

Mar 3, 2010

Author:

caron

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvDatasetFeatureCollection.ScanFilter
protected class	InvDatasetFeatureCollection.State

Field Summary

Fields

Modifier and Type	Field and Description
protected InvService	cdmrService
protected FeatureCollectionConfig	config
protected DatasetCollectionManager	dcm
protected FeatureType	featureType
protected static java.lang.String	FILES
protected java.util.regex.Pattern	filter
protected java.lang.Object	lock
protected java.lang.String	path
protected InvDatasetFeatureCollection.State	state
protected java.lang.String	topDirectory
protected static java.lang.String	Virtual_Services

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, variables

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvDatasetFeatureCollection(InvDatasetImpl parent, java.lang.String name, java.lang.String path, FeatureType featureType, FeatureCollectionConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract InvDatasetFeatureCollection.State	checkState()
static InvDatasetFeatureCollection	factory(InvDatasetImpl parent, java.lang.String name, java.lang.String path, FeatureType featureType, FeatureCollectionConfig config)
protected java.lang.String	getCatalogHref(java.lang.String what)
FeatureCollectionConfig	getConfig()
DatasetCollectionManager	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.
NetcdfDataset	getNetcdfDataset(java.lang.String matchPath) Get the dataset named by the path.
java.lang.String	getPath()
InvDatasetScan	getRawFileScan()
java.lang.String	getTopDirectoryLocation()
void	handleCollectionEvent(DatasetCollectionManager.TriggerEvent event)
abstract InvCatalogImpl	makeCatalog(java.lang.String match, java.lang.String orgPath, java.net.URI baseURI) Get one one of the catalogs contained in this dataset, called by DataRootHandler.makeDynamicCatalog()
protected InvCatalogImpl	makeCatalogTop(java.net.URI baseURI, InvDatasetFeatureCollection.State localState) Make the containing catalog for this dataset
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)
boolean	triggerRescan()
abstract void	update()
abstract void	updateProto()

Methods inherited from class thredds.catalog.InvCatalogRef

equals, findDatasetByName, findProperty, findService, finish, getAccess, getAccess, getAlias, getAuthority, getCollectionType, getContributors, getCreators, getDataFormatType, getDataType, getDates, getDocumentation, getDocumentation, getFullName, getGeospatialCoverage, getID, getKeywords, getMark, getMetadata, getMetadata, getName, getParent, getProjects, getProperties, getProxyDataset, getPublishers, getServiceDefault, getTimeCoverage, getUniqueID, getURI, getUrlPath, getUserProperty, 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, setUrlPath, setUserProperty, toString, transferMetadata, writeHtmlDescription, writeHtmlDescription

Methods inherited from class thredds.catalog.InvDataset

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

Methods inherited from class java.lang.Object

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

Field Detail

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

path

protected final java.lang.String path

featureType

protected final FeatureType featureType

config

protected final FeatureCollectionConfig config

cdmrService

protected InvService cdmrService

dcm

protected final DatasetCollectionManager dcm

topDirectory

protected final java.lang.String topDirectory

filter

protected final java.util.regex.Pattern filter

state

protected InvDatasetFeatureCollection.State state

lock

protected final java.lang.Object lock

Constructor Detail

InvDatasetFeatureCollection

protected InvDatasetFeatureCollection(InvDatasetImpl parent,
                           java.lang.String name,
                           java.lang.String path,
                           FeatureType featureType,
                           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,
                                  FeatureType featureType,
                                  FeatureCollectionConfig config)

handleCollectionEvent

public void handleCollectionEvent(DatasetCollectionManager.TriggerEvent event)

Specified by:

handleCollectionEvent in interface DatasetCollectionManager.TriggerListener

triggerRescan

public boolean triggerRescan()

update

public abstract void update()

updateProto

public abstract void updateProto()

checkState

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

Throws:

java.io.IOException

getPath

public java.lang.String getPath()

getTopDirectoryLocation

public java.lang.String getTopDirectoryLocation()

getConfig

public FeatureCollectionConfig getConfig()

getDatasetCollectionManager

public DatasetCollectionManager getDatasetCollectionManager()

getRawFileScan

public InvDatasetScan getRawFileScan()

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

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

Parameters:

match - match.remaining

orgPath - the path for the request.

baseURI - the base URI for the catalog, used to resolve relative URLs.

Returns:

containing catalog

makeCatalogTop

protected InvCatalogImpl makeCatalogTop(java.net.URI baseURI,
                            InvDatasetFeatureCollection.State localState)
                                 throws java.io.IOException,
                                        java.net.URISyntaxException

Make the containing catalog for this dataset

Parameters:

baseURI - 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

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