thredds.crawlabledataset

Interface CrawlableDatasetLabeler

All Known Implementing Classes:

MultiLabeler, RegExpAndReplaceOnNameLabeler, RegExpAndReplaceOnPathLabeler

public interface CrawlableDatasetLabeler

An interface for determining a String label for a CrawlableDataset.

Since:

Nov 14, 2005 10:49:12 AM

Author:

edavis

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getConfigObject() Return the configuration object.
java.lang.String	getLabel(CrawlableDataset dataset) Return a label for the given dataset or null if this CrawlableDatasetLabeler does not know how to label the given dataset.

Method Detail

getLabel

java.lang.String getLabel(CrawlableDataset dataset)

Return a label for the given dataset or null if this CrawlableDatasetLabeler does not know how to label the given dataset.

Parameters:

dataset - the CrawlableDataset to be labeled.

Returns:

the label for the given dataset or null.

Throws:

java.lang.NullPointerException - if the given dataset is null.

getConfigObject

java.lang.Object getConfigObject()

Return the configuration object.

Returns:

the configuration Object (may be null).