thredds.inventory

Class CollectionManagerCatalog

java.lang.Object

thredds.inventory.CollectionAbstract

thredds.inventory.CollectionManagerAbstract

thredds.inventory.CollectionManagerCatalog

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, CatalogCrawler.Listener, CollectionManager, CollectionUpdateListener, MCollection

@ThreadSafe
public class CollectionManagerCatalog
extends CollectionManagerAbstract
implements CatalogCrawler.Listener

CollectionManager of datasets from a catalog.

Since:

Jan 14, 2010

Nested Class Summary

Nested classes/interfaces inherited from class thredds.inventory.CollectionAbstract

CollectionAbstract.DateSorter, CollectionAbstract.MyStreamFilter

Nested classes/interfaces inherited from interface thredds.inventory.CollectionManager

CollectionManager.ChangeChecker, CollectionManager.TriggerEvent, CollectionManager.TriggerListener

Field Summary

Fields inherited from class thredds.inventory.CollectionManagerAbstract

recheck

Fields inherited from class thredds.inventory.CollectionAbstract

auxInfo, CATALOG, collectionName, dateExtractor, DIR, FILE, GLOB, lastModified, LIST, logger, NCX_SUFFIX, protoChoice, root, sfilter, startCollection

Constructor Summary

Constructors

Constructor and Description
CollectionManagerCatalog(java.lang.String collectionName, java.lang.String collectionSpec, java.lang.String olderThan, java.util.Formatter errlog)

Method Summary

Modifier and Type	Method and Description
boolean	getCatalogRef(CatalogRef dd, java.lang.Object context) Gets called for each catalogRef found
void	getDataset(Dataset ds, java.lang.Object context) Gets called for each dataset found.
java.lang.Iterable<MFile>	getFilesSorted() Get the current collection of MFile.
long	getLastChanged() Get the last time the collection changed
long	getLastScanned() Get the last time scanned
java.lang.String	getRoot() Get common root directory of all MFiles in the collection - may be null
boolean	isScanNeeded() Compute whether rescan is needed, based on getRecheck(), and the LastScanned value.
boolean	scan(boolean sendEvent) Scan the collection.

Methods inherited from class thredds.inventory.CollectionManagerAbstract

addEventListener, close, createListenerManager, getFileIterator, getMetadata, getRecheck, isStatic, open, putMetadata, removeEventListener, scanIfNeeded, sendEvent, setMetadataStore, setStatic

Methods inherited from class thredds.inventory.CollectionAbstract

cleanName, extractDate, getAuxInfo, getCollectionName, getFilenames, getIndexFilename, getLastModified, getLatestFile, getPartitionDate, getProtoIndex, hasDateExtractor, makeFileListSorted, parseOlderThanString, putAuxInfo, setDateExtractor, setRoot, setStreamFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface thredds.inventory.MCollection

extractDate, getAuxInfo, getCollectionName, getFilenames, getIndexFilename, getLastModified, getLatestFile, getPartitionDate, getProtoIndex, hasDateExtractor, putAuxInfo

Methods inherited from interface thredds.inventory.CollectionUpdateListener

getCollectionName

Constructor Detail

CollectionManagerCatalog

public CollectionManagerCatalog(java.lang.String collectionName,
                                java.lang.String collectionSpec,
                                java.lang.String olderThan,
                                java.util.Formatter errlog)

Method Detail

getRoot

public java.lang.String getRoot()

Description copied from interface: MCollection

Get common root directory of all MFiles in the collection - may be null

Specified by:

getRoot in interface MCollection

Overrides:

getRoot in class CollectionAbstract

Returns:

root directory name, or null.

getLastScanned

public long getLastScanned()

Description copied from interface: CollectionManager

Get the last time scanned

Specified by:

getLastScanned in interface CollectionManager

Returns:

msecs since 1970

getLastChanged

public long getLastChanged()

Description copied from interface: CollectionManager

Get the last time the collection changed

Specified by:

getLastChanged in interface CollectionManager

Returns:

msecs since 1970

isScanNeeded

public boolean isScanNeeded()

Description copied from interface: CollectionManager

Compute whether rescan is needed, based on getRecheck(), and the LastScanned value.

Specified by:

isScanNeeded in interface CollectionManager

Returns:

true if rescan is needed.

scan

public boolean scan(boolean sendEvent)
             throws java.io.IOException

Description copied from interface: CollectionManager

Scan the collection. Files may have been deleted or added since last time. If the MFile already exists in the current list, leave it in the list. If anything changes, send TriggerEvent(TriggerType.update) and return true Get the results from getFiles()

Specified by:

scan in interface CollectionManager

Returns:

true if anything actually changed.

Throws:

java.io.IOException - on I/O error

getFilesSorted

public java.lang.Iterable<MFile> getFilesSorted()

Description copied from interface: MCollection

Get the current collection of MFile. if hasDateExtractor() == true, these will be sorted by Date, otherwise by path.

Specified by:

getFilesSorted in interface MCollection

Returns:

current collection of MFile as an Iterable.

getDataset

public void getDataset(Dataset ds,
                       java.lang.Object context)

Description copied from interface: CatalogCrawler.Listener

Gets called for each dataset found.

Specified by:

getDataset in interface CatalogCrawler.Listener

Parameters:

ds - the dataset

context - caller can pass this object in (used for thread safety)

getCatalogRef

public boolean getCatalogRef(CatalogRef dd,
                             java.lang.Object context)

Description copied from interface: CatalogCrawler.Listener

Gets called for each catalogRef found

Specified by:

getCatalogRef in interface CatalogCrawler.Listener

Parameters:

dd - the dataset

context - caller can pass this object in (used for thread safety)

Returns:

true to process, false to skip