Package thredds.server.catalog

Class DatasetScan

  • All Implemented Interfaces:
    thredds.client.catalog.ThreddsMetadataContainer
    @Immutable
public class DatasetScan
extends thredds.client.catalog.CatalogRef
    DatasetScan Look: how to check if this directory should not be shown, eg not in a catalog?
    Since:
    1/12/2015

    • Field Summary

      • Fields inherited from class thredds.client.catalog.Dataset

        Access, Alias, Authority, CollectionType, Contributors, Creators, DataFormatType, Datasets, DataSize, Dates, Documentation, FeatureType, GeospatialCoverage, Harvest, Id, Keywords, listFlds, MetadataOther, Ncml, NotAThreddsDataset, Projects, Properties, Publishers, RestrictAccess, ServiceName, ThreddsMetadataInheritable, TimeCoverage, UrlPath, UseRemoteCatalogService, VariableGroups, VariableMapLinkURI

      • Fields inherited from class thredds.client.catalog.DatasetNode

        flds, name, parent

    • Constructor Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getPath()  
      String getScanLocation()  
      thredds.client.catalog.builder.CatalogBuilder makeCatalogForDirectory​(String orgPath, URI baseURI)
      Called from DataRootManager.makeDynamicCatalog(), called from LocalCatalogServiceController ...
      thredds.client.catalog.builder.CatalogBuilder makeCatalogForLatest​(String orgPath, URI baseURI)
      Build a catalog for the given resolver path by scanning the location associated with this InvDatasetScan.
      static void setAllowedServices​(AllowedServicesIF _allowedServices)  
      static void setSpecialServices​(thredds.client.catalog.Service _latestService, thredds.client.catalog.Service _fileService)  

      • Methods inherited from class thredds.client.catalog.CatalogRef

        getDatasets, getDatasetsLogical, getURI, getXlinkHref, hasNestedDatasets, isRead, readCatref, setRead, translatePathToReletiveLocation, 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, getIdOrPath, getKeywords, getLastModifiedDate, getLocalField, getMetadata, getMetadataOther, getNcmlElement, getProcessing, getProjects, getProperties, getPublishers, getRestrictAccess, getRights, getServiceDefault, getServiceNameDefault, getSummary, getTimeCoverage, getUrlPath, getVariableMapLink, getVariables, hasAccess, hasDataSize, hasProperty, hasProperty, isDatasetScan, isHarvest, makeStandalone

      • Methods inherited from class thredds.client.catalog.DatasetNode

        findDatasetByName, get, getDatasetsLocal, getFldIterator, getLocalFieldAsList, getName, getParent, getParentCatalog, getParentDataset

      • Methods inherited from interface thredds.client.catalog.ThreddsMetadataContainer

        getLocalFieldAsList

    • Constructor Detail

      • DatasetScan

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

    • Method Detail

      • setSpecialServices

        public static void setSpecialServices​(thredds.client.catalog.Service _latestService,
                                      thredds.client.catalog.Service _fileService)

      • setAllowedServices

        public static void setAllowedServices​(AllowedServicesIF _allowedServices)

      • getPath

        public String getPath()

      • getScanLocation

        public String getScanLocation()

      • makeCatalogForDirectory

        public thredds.client.catalog.builder.CatalogBuilder makeCatalogForDirectory​(String orgPath,
                                                                             URI baseURI)
                                                                      throws IOException
        Called from DataRootManager.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
        baseURI - the base URL for the catalog, used to resolve relative URLs.
        Returns:
        the catalog for this path or null if build unsuccessful.
        Throws:
        IOException

      • makeCatalogForLatest

        public thredds.client.catalog.builder.CatalogBuilder makeCatalogForLatest​(String orgPath,
                                                                          URI baseURI)
                                                                   throws 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:
        IOException