|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectthredds.catalog.InvDataset
thredds.catalog.InvDatasetImpl
thredds.catalog.InvCatalogRef
thredds.catalog.InvDatasetScan
public class InvDatasetScan
Represents server-side information on how to scan a collection of datasets for catalog generation.
Used by the THREDDS Data Server (TDS) to automatically generate catalogs.
Typically built from the information given by a datasetScan element in a TDS config catalog.
Usage notes:
Should be thread safe except that the above two usage notes are not enforced.
Field Summary |
---|
Fields inherited from class thredds.catalog.InvDatasetImpl |
---|
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 | |
---|---|
InvDatasetScan(InvCatalogImpl catalog,
InvDatasetImpl parent,
String name,
String path,
String scanLocation,
CrawlableDatasetFilter filter,
boolean addDatasetSize,
String addLatest,
boolean sortOrderIncreasing,
String datasetNameMatchPattern,
String startTimeSubstitutionPattern,
String duration)
Constructor. |
|
InvDatasetScan(InvCatalogImpl catalog,
InvDatasetImpl parent,
String name,
String path,
String scanLocation,
String filter,
boolean addDatasetSize,
String addLatest,
boolean sortOrderIncreasing,
String datasetNameMatchPattern,
String startTimeSubstitutionPattern,
String duration)
Constructor. |
|
InvDatasetScan(InvDatasetImpl parent,
String name,
String path,
String scanLocation,
String id,
InvDatasetScan from)
|
|
InvDatasetScan(InvDatasetImpl parent,
String name,
String path,
String scanLocation,
String configClassName,
Object configObj,
CrawlableDatasetFilter filter,
CrawlableDatasetLabeler identifier,
CrawlableDatasetLabeler namer,
boolean addDatasetSize,
CrawlableDatasetSorter sorter,
Map proxyDatasetHandlers,
List childEnhancerList,
CatalogRefExpander catalogRefExpander)
|
Method Summary | |
---|---|
boolean |
getAddDatasetSize()
|
CatalogRefExpander |
getCatalogRefExpander()
|
List |
getChildEnhancerList()
|
String |
getCrDsClassName()
|
Object |
getCrDsConfigObj()
|
CrawlableDatasetFilter |
getFilter()
|
CrawlableDatasetLabeler |
getIdentifier()
|
String |
getInvalidMessage()
|
CrawlableDatasetLabeler |
getNamer()
|
String |
getPath()
|
Map |
getProxyDatasetHandlers()
|
String |
getScanLocation()
|
CrawlableDatasetSorter |
getSorter()
|
boolean |
isRead()
|
boolean |
isValid()
|
InvCatalogImpl |
makeCatalogForDirectory(String orgPath,
URI baseURI)
Try to build a catalog for the given path by scanning the location associated with this InvDatasetScan. |
InvCatalog |
makeLatestCatalogForDirectory(String orgPath,
URI baseURI)
Deprecated. Instead use makeProxyDsResolver() which provides more general proxy dataset handling. |
InvCatalogImpl |
makeProxyDsResolverCatalog(String path,
URI baseURI)
Try to build a catalog for the given resolver path by scanning the location associated with this InvDatasetScan. |
CrawlableDataset |
requestCrawlableDataset(String path)
Return the CrawlableDataset for the given path, null if this InvDatasetScan does not allow (filters out) the requested CrawlableDataset. |
static void |
setCatalogServletName(String catServletName)
|
static void |
setContext(String c)
|
void |
setScanLocation(String scanLocation)
Resets the location being scanned (DO NOT USE THIS METHOD, "public by accident"). |
String |
translatePathToLocation(String dsPath)
Return the CrawlableDataset path/location that corresponds to the given dataset path. |
Methods inherited from class thredds.catalog.InvCatalogRef |
---|
equals, findDatasetByName, findProperty, findService, finish, getAccess, getAccess, getAlias, getAuthority, getCollectionType, getContributors, getCreators, getDataFormatType, getDatasets, 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, readAsynch, release, setXlinkHref |
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 |
Constructor Detail |
---|
public InvDatasetScan(InvDatasetImpl parent, String name, String path, String scanLocation, String id, InvDatasetScan from)
public InvDatasetScan(InvCatalogImpl catalog, InvDatasetImpl parent, String name, String path, String scanLocation, String filter, boolean addDatasetSize, String addLatest, boolean sortOrderIncreasing, String datasetNameMatchPattern, String startTimeSubstitutionPattern, String duration)
catalog
- parent catalogparent
- parent datasetname
- dataset namepath
- url pathscanLocation
- scan this directoryfilter
- RegExp match on nameaddDatasetSize
- add a size elementaddLatest
- add a latest elementsortOrderIncreasing
- sortdatasetNameMatchPattern
- dataset namingstartTimeSubstitutionPattern
- time range using the file nameduration
- time range using the file namepublic InvDatasetScan(InvCatalogImpl catalog, InvDatasetImpl parent, String name, String path, String scanLocation, CrawlableDatasetFilter filter, boolean addDatasetSize, String addLatest, boolean sortOrderIncreasing, String datasetNameMatchPattern, String startTimeSubstitutionPattern, String duration)
catalog
- parent catalogparent
- parent datasetname
- dataset namepath
- url pathscanLocation
- scan this directoryfilter
- CrawlableDatasetFilter, may be nulladdDatasetSize
- add a size elementaddLatest
- add a latest elementsortOrderIncreasing
- sortdatasetNameMatchPattern
- dataset namingstartTimeSubstitutionPattern
- time range using the file nameduration
- time range using the file namepublic InvDatasetScan(InvDatasetImpl parent, String name, String path, String scanLocation, String configClassName, Object configObj, CrawlableDatasetFilter filter, CrawlableDatasetLabeler identifier, CrawlableDatasetLabeler namer, boolean addDatasetSize, CrawlableDatasetSorter sorter, Map proxyDatasetHandlers, List childEnhancerList, CatalogRefExpander catalogRefExpander)
Method Detail |
---|
public static void setContext(String c)
public static void setCatalogServletName(String catServletName)
public String getPath()
public String getScanLocation()
public void setScanLocation(String scanLocation)
Used by DataRootHandler to allow scanning an aliased directory ("content").
scanLocation
- the scan location.public String getCrDsClassName()
public Object getCrDsConfigObj()
public CrawlableDatasetFilter getFilter()
public CrawlableDatasetLabeler getIdentifier()
public CrawlableDatasetLabeler getNamer()
public CrawlableDatasetSorter getSorter()
public Map getProxyDatasetHandlers()
public boolean getAddDatasetSize()
public List getChildEnhancerList()
public CatalogRefExpander getCatalogRefExpander()
public boolean isValid()
public String getInvalidMessage()
public String translatePathToLocation(String dsPath)
dsPath
- a datasetScan dsPath that
public CrawlableDataset requestCrawlableDataset(String path) throws IOException
This method can handle requests for regular datasets and proxy datasets.
path
- the path of the requested CrawlableDataset
IOException
- if an I/O error occurs while locating the children datasets.
IllegalArgumentException
- if the given path is not a descendant of (or the same as) this InvDatasetScan collection level.public InvCatalogImpl makeCatalogForDirectory(String orgPath, URI baseURI)
orgPath
- the part of the baseURI that is the pathbaseURI
- the base URL for the catalog, used to resolve relative URLs.
public InvCatalogImpl makeProxyDsResolverCatalog(String path, URI baseURI)
path
- the part of the baseURI that is the pathbaseURI
- the base URL for the catalog, used to resolve relative URLs.
public InvCatalog makeLatestCatalogForDirectory(String orgPath, URI baseURI)
makeProxyDsResolver()
which provides more general proxy dataset handling.
orgPath
- the part of the baseURI that is the pathbaseURI
- the base URL for the catalog, used to resolve relative URLs.
public boolean isRead()
isRead
in class InvCatalogRef
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |