thredds.crawlabledataset

Class PathResolverCrawlableDataset

java.lang.Object

thredds.crawlabledataset.PathResolverCrawlableDataset

All Implemented Interfaces:

CrawlableDataset

Direct Known Subclasses:

ExamplePathResolverCrDs

public abstract class PathResolverCrawlableDataset
extends java.lang.Object
implements CrawlableDataset

An abstract CrawlableDataset implementation built around a path resolver method

   File resolve( String path);
 

The path handed to the resolve() method is the relative path of the CrDs.getDescendant() method.

NOTE: The current implementation does not support crawling a hierarchy. All relative paths must resolve to a dataset file, not a directory. This means that classes derived from this may only be used behind datasetRoot elements.

Since:

4.2.9

Author:

edavis

Constructor Summary

Constructors

Constructor and Description
PathResolverCrawlableDataset(java.lang.String rootDirectoryPath, java.lang.Object configObj) The constructor used by the TDS when creating all CrawlableDatset instances.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists() Return true if the dataset represented by this CrawlableDataset actually exists, null if it does not or an I/O error occurs.
java.lang.Object	getConfigObject() Return the configuration Object (can be null).
CrawlableDataset	getDescendant(java.lang.String relativePath) A factory method for getting a descendant of this datasets.
java.lang.String	getName() Returns the dataset name, i.e., the last part of the dataset path.
CrawlableDataset	getParentDataset() Returns the parent CrawlableDataset or null if this dataset has no parent.
java.lang.String	getPath() Returns the dataset path.
boolean	isCollection() Return true if the dataset is a collection dataset.
java.util.Date	lastModified() Returns the date the dataset was last modified, null if unknown.
long	length() Returns the size in bytes of the dataset, -1 if unknown.
java.util.List<CrawlableDataset>	listDatasets() Returns the list of CrawlableDatasets contained in this collection dataset.
java.util.List<CrawlableDataset>	listDatasets(CrawlableDatasetFilter filter) Returns the list of CrawlableDatasets contained in this collection dataset that satisfy the given filter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PathResolverCrawlableDataset

public PathResolverCrawlableDataset(java.lang.String rootDirectoryPath,
                            java.lang.Object configObj)

The constructor used by the TDS when creating all CrawlableDatset instances. All implementations of CrawlableDataset must support this constructor signature.

NOTE: The configObj parameter is ignored by this implementation because it is not supported by datasetRoot elements in a configuration catalog.

Parameters:

rootDirectoryPath - the absolute path of the directory for a particular dataset root. E.g., the datasetRoot@location value.

configObj - a configuration object that is ignored.

Method Detail

getConfigObject

public java.lang.Object getConfigObject()

Description copied from interface: CrawlableDataset

Return the configuration Object (can be null).

Specified by:

getConfigObject in interface CrawlableDataset

Returns:

the configuration Object (can be null).

getPath

public java.lang.String getPath()

Description copied from interface: CrawlableDataset

Returns the dataset path.

Specified by:

getPath in interface CrawlableDataset

Returns:

the dataset path.

getName

public java.lang.String getName()

Description copied from interface: CrawlableDataset

Returns the dataset name, i.e., the last part of the dataset path.

Specified by:

getName in interface CrawlableDataset

Returns:

the dataset name, i.e., the last part of the dataset path.

getParentDataset

public CrawlableDataset getParentDataset()

Description copied from interface: CrawlableDataset

Returns the parent CrawlableDataset or null if this dataset has no parent.

Specified by:

getParentDataset in interface CrawlableDataset

Returns:

the parent CrawlableDataset or null if this dataset has no parent.

exists

public boolean exists()

Description copied from interface: CrawlableDataset

Return true if the dataset represented by this CrawlableDataset actually exists, null if it does not or an I/O error occurs.

Specified by:

exists in interface CrawlableDataset

Returns:

true if the dataset represented by this CrawlableDataset actually exists.

isCollection

public boolean isCollection()

Description copied from interface: CrawlableDataset

Return true if the dataset is a collection dataset.

Specified by:

isCollection in interface CrawlableDataset

Returns:

true if the dataset is a collection dataset.

getDescendant

public CrawlableDataset getDescendant(java.lang.String relativePath)

Description copied from interface: CrawlableDataset

A factory method for getting a descendant of this datasets.

Specified by:

getDescendant in interface CrawlableDataset

Parameters:

relativePath - the path relative to this dataset of the requested dataset.

Returns:

the requested descendant of this dataset.

listDatasets

public java.util.List<CrawlableDataset> listDatasets()
                                              throws java.io.IOException

Description copied from interface: CrawlableDataset

Returns the list of CrawlableDatasets contained in this collection dataset. The returned list will be empty if this collection dataset does not contain any children datasets. If this dataset is not a collection dataset, this method returns null.

Specified by:

listDatasets in interface CrawlableDataset

Returns:

Returns a list of the CrawlableDatasets contained in this collection dataset. The llist will be empty if no datasets are contained in this collection dataset.

Throws:

java.io.IOException - if an I/O error occurs while accessing the children datasets.

listDatasets

public java.util.List<CrawlableDataset> listDatasets(CrawlableDatasetFilter filter)
                                              throws java.io.IOException

Description copied from interface: CrawlableDataset

Returns the list of CrawlableDatasets contained in this collection dataset that satisfy the given filter. The returned list will be empty if this collection dataset does not contain any children datasets that satisfy the given filter.

Specified by:

listDatasets in interface CrawlableDataset

Parameters:

filter - a CrawlableDataset filter (if null, accept all datasets).

Returns:

Returns a list of the CrawlableDatasets contained in this collection dataset that satisfy the given filter. The list will be empty if no datasets are contained in this collection dataset.

Throws:

java.io.IOException - if an I/O error occurs while accessing the children datasets.

length

public long length()

Description copied from interface: CrawlableDataset

Returns the size in bytes of the dataset, -1 if unknown.

Specified by:

length in interface CrawlableDataset

Returns:

the size in bytes of the dataset, -1 if unknown.

lastModified

public java.util.Date lastModified()

Description copied from interface: CrawlableDataset

Returns the date the dataset was last modified, null if unknown.

Specified by:

lastModified in interface CrawlableDataset

Returns:

the date the dataset was last modified, null if unknown.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object