thredds.crawlabledataset
Interface CrawlableDatasetSorter

All Known Implementing Classes:

LexigraphicByNameSorter

public interface CrawlableDatasetSorter

The CrawlableDatasetSorter interface provides for sorting a list of CrawlableDatasets. An instance of the CrawlableDatasetSorter interface defines an ordering for a list of CrawlableDatasets. The CrawlableDatasetSorter interface is used by the CollectionLevelScanner class to sort the datasets it is cataloging.

Since:

Nov 18, 2005 4:12:50 PM

Author:

edavis

Method Summary

java.lang.Object	getConfigObject() Return the configuration object.
void	sort(java.util.List datasetList) Sort the given CrawlableDataset list into the order defined by this sorter.

Method Detail

sort

void sort(java.util.List datasetList)

Sort the given CrawlableDataset list into the order defined by this sorter.

Parameters:

datasetList - the CrawlableDataset list to be sorted.

Throws:

java.lang.ClassCastException - if the list contains elements that are not CrawlableDatasets.

java.lang.UnsupportedOperationException - if the given list does not allow the necessary list manipulation.

getConfigObject

java.lang.Object getConfigObject()

Return the configuration object.

Returns:

the configuration Object (may be null).