thredds.crawlabledataset
Interface CrawlableDatasetFilter

All Known Implementing Classes:
InvDatasetFeatureCollection.ScanFilter, LastModifiedLimitFilter, MultiSelectorFilter, RegExpMatchOnNameFilter, RegExpMatchOnPathFilter, WildcardMatchOnNameFilter, WildcardMatchOnPathFilter

public interface CrawlableDatasetFilter

A filter for CrawlableDatasets.

Instances of this interface may be passed to the CrawlableDataset.listDatasets(CrawlableDatasetFilter) method of the CrawlableDataset class.

Implementation note: The TDS framework (InvDatasetScan, etc) uses a public constructor with a single configuration Object argument to instantiate instances of a CrawlableDatasetFilter. If your implementation will not be used in the TDS framework, other constructors can be used.

Since:
Jun 22, 2005 9:30:43 AM
Author:
edavis
See Also:
CrawlableDataset.listDatasets(CrawlableDatasetFilter)

Method Summary
 boolean accept(CrawlableDataset dataset)
          Test whether the specified CrawlableDataset should be included in a list of CrawlableDatasets.
 Object getConfigObject()
          Return the configuration object.
 

Method Detail

accept

boolean accept(CrawlableDataset dataset)
Test whether the specified CrawlableDataset should be included in a list of CrawlableDatasets.

Parameters:
dataset - the CrawlableDataset to test for inclusion.
Returns:
true if the given CrawlableDataset should be included, false otherwise.

getConfigObject

Object getConfigObject()
Return the configuration object.

Returns:
the configuration Object (may be null).


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.