thredds.server.catalog

Class DatasetScan

java.lang.Object

thredds.client.catalog.DatasetNode

thredds.client.catalog.Dataset

thredds.client.catalog.CatalogRef

thredds.server.catalog.DatasetScan

All Implemented Interfaces:

thredds.client.catalog.ThreddsMetadataContainer

@Immutable
public class DatasetScan
extends thredds.client.catalog.CatalogRef

DatasetScan

Since:

1/12/2015

Field Summary

Fields inherited from class thredds.client.catalog.Dataset

Access, Alias, Authority, CollectionType, Contributors, Creators, DataFormatType, DatasetHash, DatasetRoots, Datasets, DataSize, Dates, Documentation, Expires, FeatureType, GeospatialCoverage, Harvest, Id, Keywords, MetadataOther, Ncml, Projects, Properties, Publishers, RestrictAccess, ServiceName, Services, ThreddsMetadataInheritable, TimeCoverage, UrlPath, UseRemoteCatalogService, VariableGroups, VariableMapLink, Version

Fields inherited from class thredds.client.catalog.DatasetNode

flds, name, parent

Constructor Summary

Constructors

Constructor and Description
DatasetScan(thredds.client.catalog.DatasetNode parent, java.lang.String name, java.lang.String xlink, java.util.Map<java.lang.String,java.lang.Object> flds, java.util.List<thredds.client.catalog.builder.AccessBuilder> accessBuilders, java.util.List<thredds.client.catalog.builder.DatasetBuilder> datasetBuilders, DatasetScanConfig config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath()
java.lang.String	getScanLocation()
thredds.client.catalog.Catalog	makeCatalogForDirectory(java.lang.String orgPath, java.net.URI catURI) Called from DataRootHandler.makeDynamicCatalog(), called from LocalCatalogServiceController ...
thredds.client.catalog.Catalog	makeLatestResolvedCatalog(java.lang.String orgPath, java.net.URI baseURI) Build a catalog for the given resolver path by scanning the location associated with this InvDatasetScan.

Methods inherited from class thredds.client.catalog.CatalogRef

getURI, getXlinkHref, isRead, setRead, useRemoteCatalogService

Methods inherited from class thredds.client.catalog.Dataset

findAccess, findProperty, getAccess, getAccess, getAuthority, getCatalogUrl, getCollectionType, getContributors, getCreators, getDataFormatName, getDataFormatType, getDataSize, getDates, getDocumentation, getDocumentation, getFeatureType, getFeatureTypeName, getGeospatialCoverage, getHistory, getId, getID, getKeywords, getLastModifiedDate, getLocalField, getLocalFieldAsList, getMetadata, getMetadataOther, getNcmlElement, getProcessing, getProjects, getProperties, getPublishers, getRestrictAccess, getRights, getServiceDefault, getServiceNameDefault, getSummary, getTimeCoverage, getUrlPath, getVariableMapLink, getVariables, hasAccess, hasDataSize, isDatasetScan, isHarvest

Methods inherited from class thredds.client.catalog.DatasetNode

findDatasetByName, getDatasets, getFlds, getName, getParent, getParentCatalog, getParentDataset, hasNestedDatasets

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetScan

public DatasetScan(thredds.client.catalog.DatasetNode parent,
                   java.lang.String name,
                   java.lang.String xlink,
                   java.util.Map<java.lang.String,java.lang.Object> flds,
                   java.util.List<thredds.client.catalog.builder.AccessBuilder> accessBuilders,
                   java.util.List<thredds.client.catalog.builder.DatasetBuilder> datasetBuilders,
                   DatasetScanConfig config)

Method Detail

getPath

public java.lang.String getPath()

getScanLocation

public java.lang.String getScanLocation()

makeCatalogForDirectory

public thredds.client.catalog.Catalog makeCatalogForDirectory(java.lang.String orgPath,
                                                              java.net.URI catURI)
                                                       throws java.io.IOException

Called from DataRootHandler.makeDynamicCatalog(), called from LocalCatalogServiceController ...

Build a catalog for the given path by scanning the location associated with this DatasetScan. The given path must start with the path of this DatasetScan.

Parameters:

orgPath - the part of the baseURI that is the path

catURI - the base URL for the catalog, used to resolve relative URLs.

Returns:

the catalog for this path or null if build unsuccessful.

Throws:

java.io.IOException

makeLatestResolvedCatalog

public thredds.client.catalog.Catalog makeLatestResolvedCatalog(java.lang.String orgPath,
                                                                java.net.URI baseURI)
                                                         throws java.io.IOException

Build a catalog for the given resolver path by scanning the location associated with this InvDatasetScan. The given path must start with the path of this DatasetScan and refer to a resolver ProxyDatasetHandler that is part of this InvDatasetScan.

Parameters:

orgPath - the part of the baseURI that is the path

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

Returns:

the resolver catalog for this path (uses version 1.1) or null if build unsuccessful.

Throws:

java.io.IOException