thredds.catalog

Class InvDatasetFeatureCollection

java.lang.Object

thredds.catalog.InvDataset

thredds.catalog.InvDatasetImpl

thredds.catalog.InvCatalogRef

thredds.catalog.InvDatasetFeatureCollection

All Implemented Interfaces:

CollectionUpdateListener

Direct Known Subclasses:

InvDatasetFcFmrc, InvDatasetFcGrib, InvDatasetFcPoint

@ThreadSafe
public abstract class InvDatasetFeatureCollection
extends InvCatalogRef
implements CollectionUpdateListener

Abstract superclass for Feature Collection InvDatasets. 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

Author:

caron

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 FeatureCollectionConfig	config
protected String	configPath
protected static String	context
protected MFileCollectionManager	datasetCollection
protected static String	Default_Services
protected static String	Download_Services
protected FeatureCollectionType	fcType
protected static String	FILES
protected boolean	first
protected static String	LATEST_DATASET_CATALOG
protected static String	LATEST_SERVICE
protected Object	lock
protected org.slf4j.Logger	logger
protected InvService	orgService
protected InvDatasetFeatureCollection.State	state
protected String	topDirectory
protected static String	VARIABLES
protected static String	Virtual_Services
protected InvService	virtualService

Fields inherited from class thredds.catalog.InvDatasetImpl

log, mark, ncmlElement, tm, tmi

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, FeatureCollectionConfig config)

Method Summary

Modifier and Type	Method and Description
protected void	_showStatus(Formatter f, boolean summaryOnly, String type)
protected static String	buildCatalogServiceHref(String path)
protected InvDatasetFeatureCollection.State	checkState() A request has come in, check that the state has been initialized.
static InvDatasetFeatureCollection	factory(InvDatasetImpl parent, FeatureCollectionConfig config)
protected void	finishConstruction()
protected void	firstInit()
protected String	getCatalogHref(String what)
String	getCollectionName()
FeatureCollectionConfig	getConfig()
MCollection	getDatasetCollectionManager()
List<InvDataset>	getDatasets() Get a list of all the nested datasets.
abstract FeatureDataset	getFeatureDataset()
File	getFile(String remaining)
GridDataset	getGridDataset(String matchPath) Get the associated Grid Dataset, if any.
String	getLatestFileName()
org.slf4j.Logger	getLogger()
NetcdfDataset	getNetcdfDataset(String matchPath) Get the dataset named by the path.
String	getPath()
String	getTopDirectoryLocation()
abstract InvCatalogImpl	makeCatalog(String match, String orgPath, URI catURI) Get one of the catalogs contained in this collection, called by DataRootHandler.makeDynamicCatalog()
protected InvCatalogImpl	makeCatalogFiles(URI catURI, InvDatasetFeatureCollection.State localState, List<String> filenames, boolean addLatest)
protected InvCatalogImpl	makeCatalogTop(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 void	makeDatasetTop(InvDatasetFeatureCollection.State localState)
protected InvService	makeDefaultService()
protected InvService	makeDownloadService()
InvCatalogImpl	makeLatest(String matchPath, String reqPath, URI catURI)
protected String	makeMetadataLink(String datasetName, String metadata)
protected InvService	makeServiceVirtual(InvService org)
void	sendEvent(CollectionUpdateType type)
static void	setCatalogServletName(String catServletName)
static void	setCdmrFeatureServiceUrlPath(String urlPath)
static void	setContext(String c)
static void	setLoggerFactory(LoggerFactory fac)
void	showStatus(Formatter f)
String	showStatusShort(String type)
protected void	update(CollectionUpdateType force) Collection was changed, update internal objects.
protected abstract void	updateCollection(InvDatasetFeatureCollection.State localState, CollectionUpdateType force)

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

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, 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 String LATEST_DATASET_CATALOG

See Also:

Constant Field Values

LATEST_SERVICE

protected static final String LATEST_SERVICE

See Also:

Constant Field Values

VARIABLES

protected static final String VARIABLES

See Also:

Constant Field Values

FILES

protected static final String FILES

See Also:

Constant Field Values

Virtual_Services

protected static final String Virtual_Services

See Also:

Constant Field Values

Default_Services

protected static final String Default_Services

See Also:

Constant Field Values

Download_Services

protected static final String Download_Services

context

protected static String context

orgService

protected InvService orgService

virtualService

protected InvService virtualService

cdmrService

protected InvService cdmrService

logger

protected org.slf4j.Logger logger

configPath

protected final String configPath

fcType

protected final FeatureCollectionType fcType

config

protected final FeatureCollectionConfig config

topDirectory

protected String topDirectory

datasetCollection

protected MFileCollectionManager datasetCollection

state

protected InvDatasetFeatureCollection.State state

first

protected boolean first

lock

protected final Object lock

Constructor Detail

InvDatasetFeatureCollection

protected InvDatasetFeatureCollection(InvDatasetImpl parent,
                                      FeatureCollectionConfig config)

Method Detail

setContext

public static void setContext(String c)

setCatalogServletName

public static void setCatalogServletName(String catServletName)

buildCatalogServiceHref

protected static String buildCatalogServiceHref(String path)

setCdmrFeatureServiceUrlPath

public static void setCdmrFeatureServiceUrlPath(String urlPath)

setLoggerFactory

public static void setLoggerFactory(LoggerFactory fac)

factory

public static InvDatasetFeatureCollection factory(InvDatasetImpl parent,
                                                  FeatureCollectionConfig config)

makeCollection

protected void makeCollection()

finishConstruction

protected void finishConstruction()

getCollectionName

public String getCollectionName()

Specified by:

getCollectionName in interface CollectionUpdateListener

sendEvent

public void sendEvent(CollectionUpdateType type)

Specified by:

sendEvent in interface CollectionUpdateListener

showStatus

public void showStatus(Formatter f)

showStatusShort

public String showStatusShort(String type)

_showStatus

protected void _showStatus(Formatter f,
                           boolean summaryOnly,
                           String type)
                    throws IOException

Throws:

IOException

updateCollection

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

makeDatasetTop

protected abstract void makeDatasetTop(InvDatasetFeatureCollection.State localState)
                                throws IOException

Throws:

IOException

getCatalogHref

protected String getCatalogHref(String what)

firstInit

protected void firstInit()

checkState

protected InvDatasetFeatureCollection.State checkState()
                                                throws 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:

IOException

update

protected void update(CollectionUpdateType force)
               throws IOException

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

Parameters:

force - update type

Throws:

IOException

getPath

public String getPath()

getLatestFileName

public String getLatestFileName()

getTopDirectoryLocation

public String getTopDirectoryLocation()

getConfig

public FeatureCollectionConfig getConfig()

getDatasetCollectionManager

public MCollection getDatasetCollectionManager()

getLogger

public org.slf4j.Logger getLogger()

getDatasets

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

makeDefaultService

protected InvService makeDefaultService()

makeDownloadService

protected InvService makeDownloadService()

makeServiceVirtual

protected InvService makeServiceVirtual(InvService org)

makeCatalog

public abstract InvCatalogImpl makeCatalog(String match,
                                           String orgPath,
                                           URI catURI)
                                    throws 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:

IOException

makeCatalogTop

protected InvCatalogImpl makeCatalogTop(URI catURI,
                                        InvDatasetFeatureCollection.State localState)
                                 throws IOException,
                                        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:

IOException - on I/O error

URISyntaxException - if path is misformed

makeCatalogFiles

protected InvCatalogImpl makeCatalogFiles(URI catURI,
                                          InvDatasetFeatureCollection.State localState,
                                          List<String> filenames,
                                          boolean addLatest)
                                   throws IOException

Throws:

IOException

makeMetadataLink

protected String makeMetadataLink(String datasetName,
                                  String metadata)

makeLatest

public InvCatalogImpl makeLatest(String matchPath,
                                 String reqPath,
                                 URI catURI)
                          throws IOException

Throws:

IOException

getGridDataset

public GridDataset getGridDataset(String matchPath)
                           throws 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:

IOException - on error

getFeatureDataset

public abstract FeatureDataset getFeatureDataset()

getNetcdfDataset

public NetcdfDataset getNetcdfDataset(String matchPath)
                               throws IOException

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

Parameters:

matchPath - remaining path from match

Returns:

requested dataset

Throws:

IOException - if read error

getFile

public File getFile(String remaining)